Skip to content

Commit a94ebf8

Browse files
committed
docs: update OAuth adapter package names for consistency across documentation
1 parent 56bb005 commit a94ebf8

4 files changed

Lines changed: 30 additions & 30 deletions

File tree

adminforth/documentation/docs/tutorial/05-Adapters/02-oauth2-adapters.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,47 +11,47 @@ Used to authenticate users via OAuth 2.0 providers.
1111
## Google OAuth Adapter
1212

1313
```bash
14-
pnpm i @adminforth/google-oauth-adapter
14+
pnpm i @adminforth/oauth-adapter-google
1515
```
1616

1717
Supports Google sign-in to allow users to authenticate using their Google or Google Workspaces accounts.
1818

1919
## GitHub OAuth Adapter
2020

2121
```bash
22-
pnpm i @adminforth/github-oauth-adapter
22+
pnpm i @adminforth/oauth-adapter-github
2323
```
2424

2525
Enables authentication via GitHub accounts, useful for developer tools and open-source apps.
2626

2727
## Facebook OAuth Adapter
2828

2929
```bash
30-
pnpm i @adminforth/facebook-oauth-adapter
30+
pnpm i @adminforth/oauth-adapter-facebook
3131
```
3232

3333
Allows users to log in with Facebook credentials. Facebook OAuth is commonly used for social media integrations.
3434

3535
## Keycloak OAuth Adapter
3636

3737
```bash
38-
pnpm i @adminforth/keycloak-oauth-adapter
38+
pnpm i @adminforth/oauth-adapter-keycloak
3939
```
4040

4141
Connects AdminForth to an open-source [Keycloak](https://www.keycloak.org/) identity provider for enterprise-grade SSO (Single Sign-On).
4242

4343
## Microsoft OAuth Adapter
4444

4545
```bash
46-
pnpm i @adminforth/microsoft-oauth-adapter
46+
pnpm i @adminforth/oauth-adapter-microsoft
4747
```
4848

4949
Supports login through Microsoft accounts including Azure AD, Office365, and Outlook.com.
5050

5151
## Twitch OAuth Adapter
5252

5353
```bash
54-
pnpm i @adminforth/twitch-oauth-adapter
54+
pnpm i @adminforth/oauth-adapter-twitch
5555
```
5656

5757
Adds support for Twitch authentication, useful for streaming or creator-oriented platforms.

adminforth/documentation/docs/tutorial/05-Adapters/09-chat-surface-adapters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ For Telegram you need both adapters:
1313

1414
```bash
1515
pnpm i @adminforth/chat-surface-adapter-telegram
16-
pnpm i @adminforth/telegram-oauth-adapter
16+
pnpm i @adminforth/oauth-adapter-telegram
1717
```
1818

1919
Create a Telegram bot with BotFather and add the token to `.env`:
@@ -59,7 +59,7 @@ Configure the OAuth plugin with Telegram OAuth:
5959

6060
```ts title="./resources/adminuser.ts"
6161
import OAuthPlugin from '@adminforth/oauth';
62-
import TelegramOauthAdapter from '@adminforth/telegram-oauth-adapter';
62+
import TelegramOauthAdapter from '@adminforth/oauth-adapter-telegram';
6363

6464
new OAuthPlugin({
6565
emailField: 'email',

adminforth/documentation/docs/tutorial/08-Plugins/01-agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ If you want to talk to the same agent from external chat products (Telegram, Sla
292292
- a **chat surface adapter** that receives messages from the external chat product
293293
- an **OAuth adapter** for the same provider so users can connect that external account in **Connected Accounts**
294294

295-
For example, Telegram Agent access needs both `@adminforth/chat-surface-adapter-telegram` and `@adminforth/telegram-oauth-adapter`.
295+
For example, Telegram Agent access needs both `@adminforth/chat-surface-adapter-telegram` and `@adminforth/oauth-adapter-telegram`.
296296

297297
Register adapters through `chatSurfaceAdapters`:
298298

adminforth/documentation/docs/tutorial/08-Plugins/11-oauth.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ Install the plugin and at least one OAuth adapter:
2020

2121
```bash
2222
pnpm install @adminforth/oauth --save
23-
pnpm install @adminforth/google-oauth-adapter --save
23+
pnpm install @adminforth/oauth-adapter-google --save
2424
```
2525

2626
If you want Agent chat surfaces, install the OAuth adapter for the same provider as the chat surface. For example, Telegram chat surface support requires both:
2727

2828
```bash
2929
pnpm install @adminforth/chat-surface-adapter-telegram --save
30-
pnpm install @adminforth/telegram-oauth-adapter --save
30+
pnpm install @adminforth/oauth-adapter-telegram --save
3131
```
3232

3333
## External Identities Resource
@@ -100,7 +100,7 @@ This example configures Google OAuth. See [OAuth2 Providers](#oauth2-providers)
100100

101101
```typescript title="./resources/adminuser.ts"
102102
import OAuthPlugin from '@adminforth/oauth';
103-
import AdminForthAdapterGoogleOauth2 from '@adminforth/google-oauth-adapter';
103+
import AdminForthAdapterGoogleOauth2 from '@adminforth/oauth-adapter-google';
104104

105105
plugins: [
106106
new OAuthPlugin({
@@ -216,7 +216,7 @@ new OAuthPlugin({
216216
Install Adapter:
217217

218218
```
219-
pnpm install @adminforth/facebook-oauth-adapter --save
219+
pnpm install @adminforth/oauth-adapter-facebook --save
220220
```
221221

222222

@@ -236,7 +236,7 @@ FACEBOOK_CLIENT_SECRET=your_facebook_client_secret
236236
Add the adapter to your plugin configuration:
237237

238238
```typescript title="./resources/adminuser.ts"
239-
import AdminForthAdapterFacebookOauth2 from '@adminforth/facebook-oauth-adapter';
239+
import AdminForthAdapterFacebookOauth2 from '@adminforth/oauth-adapter-facebook';
240240

241241
// ... existing resource configuration ...
242242
plugins: [
@@ -257,7 +257,7 @@ plugins: [
257257
Install Adapter:
258258

259259
```
260-
pnpm install @adminforth/github-oauth-adapter --save
260+
pnpm install @adminforth/oauth-adapter-github --save
261261
```
262262

263263

@@ -275,7 +275,7 @@ GITHUB_CLIENT_SECRET=your_github_client_secret
275275
Add the adapter to your plugin configuration:
276276

277277
```typescript title="./resources/adminuser.ts"
278-
import AdminForthAdapterGithubOauth2 from '@adminforth/github-oauth-adapter';
278+
import AdminForthAdapterGithubOauth2 from '@adminforth/oauth-adapter-github';
279279

280280
// ... existing resource configuration ...
281281
plugins: [
@@ -296,7 +296,7 @@ plugins: [
296296
Install Adapter:
297297

298298
```
299-
pnpm install @adminforth/telegram-oauth-adapter --save
299+
pnpm install @adminforth/oauth-adapter-telegram --save
300300
```
301301

302302
Add the credentials to your `.env` file:
@@ -310,7 +310,7 @@ Add the adapter to your plugin configuration:
310310

311311
```ts
312312
import OAuthPlugin from '@adminforth/oauth';
313-
import TelegramOauthAdapter from '@adminforth/telegram-oauth-adapter';
313+
import TelegramOauthAdapter from '@adminforth/oauth-adapter-telegram';
314314

315315
new OAuthPlugin({
316316
emailField: 'email',
@@ -341,7 +341,7 @@ If you use `@adminforth/chat-surface-adapter-telegram`, users must connect Teleg
341341
Install Adapter:
342342

343343
```
344-
pnpm install @adminforth/keycloak-oauth-adapter --save
344+
pnpm install @adminforth/oauth-adapter-keycloak --save
345345
```
346346

347347
If you need a basic Keycloak setup which tested with AdminForth, you can follow [this minimal KeyClock setup example](/blog/keycloak-setup-example).
@@ -358,7 +358,7 @@ KEYCLOAK_REALM=your_keycloak_realm
358358
2. Add the adapter to your plugin configuration:
359359

360360
```typescript title="./resources/adminuser.ts"
361-
import AdminForthAdapterKeycloakOauth2 from '@adminforth/keycloak-oauth-adapter';
361+
import AdminForthAdapterKeycloakOauth2 from '@adminforth/oauth-adapter-keycloak';
362362

363363
// ... existing resource configuration ...
364364
plugins: [
@@ -383,7 +383,7 @@ plugins: [
383383
Install Adapter:
384384

385385
```
386-
pnpm install @adminforth/microsoft-oauth-adapter --save
386+
pnpm install @adminforth/oauth-adapter-microsoft --save
387387
```
388388

389389

@@ -404,7 +404,7 @@ MICROSOFT_CLIENT_SECRET=your_microsoft_client_secret
404404
Add the adapter to your plugin configuration:
405405

406406
```typescript title="./resources/adminuser.ts"
407-
import AdminForthAdapterMicrosoftOauth2 from '@adminforth/microsoft-oauth-adapter';
407+
import AdminForthAdapterMicrosoftOauth2 from '@adminforth/oauth-adapter-microsoft';
408408

409409
// ... existing resource configuration ...
410410
plugins: [
@@ -426,7 +426,7 @@ plugins: [
426426
Install Adapter:
427427

428428
```
429-
pnpm install @adminforth/twitch-oauth-adapter --save
429+
pnpm install @adminforth/oauth-adapter-twitch --save
430430
```
431431

432432
1. Go to the [Twitch dashboard](https://dev.twitch.tv/console/)
@@ -443,7 +443,7 @@ TWITCH_CLIENT_SECRET=your_twitch_client_secret
443443
Add the adapter to your plugin configuration:
444444

445445
```typescript title="./resources/adminuser.ts"
446-
import AdminForthAdapterTwitchOauth2 from '@adminforth/twitch-oauth-adapter';
446+
import AdminForthAdapterTwitchOauth2 from '@adminforth/oauth-adapter-twitch';
447447

448448
// ... existing resource configuration ...
449449
plugins: [
@@ -461,18 +461,18 @@ plugins: [
461461

462462
### Need custom provider?
463463

464-
Just fork any existing adapter e.g. [Google](https://github.com/devforth/adminforth-google-oauth-adapter) and adjust it to your needs.
464+
Just fork any existing adapter e.g. [Google](https://github.com/devforth/adminforth-oauth-adapter-google) and adjust it to your needs.
465465

466-
This is really easy, you have to change less then 10 lines of code in this [file](https://github.com/devforth/adminforth-google-oauth-adapter/blob/main/index.ts)
466+
This is really easy, you have to change less then 10 lines of code in this [file](https://github.com/devforth/adminforth-oauth-adapter-google/blob/main/index.ts)
467467

468468
Then just publish it to npm and install it in your project.
469469

470470

471471
Links to adapters:
472-
[Google](https://github.com/devforth/adminforth-google-oauth-adapter)
473-
[GitHub](https://github.com/devforth/adminforth-github-oauth-adapter)
474-
[Facebook](https://github.com/devforth/adminforth-facebook-oauth-adapter)
475-
[Keycloak](https://github.com/devforth/adminforth-keycloak-oauth-adapter)
472+
[Google](https://github.com/devforth/adminforth-oauth-adapter-google)
473+
[GitHub](https://github.com/devforth/adminforth-oauth-adapter-github)
474+
[Facebook](https://github.com/devforth/adminforth-oauth-adapter-facebook)
475+
[Keycloak](https://github.com/devforth/adminforth-oauth-adapter-keycloak)
476476

477477

478478
## Fill user full name

0 commit comments

Comments
 (0)