|
1 | 1 | # AdminForth Adapters
|
2 | 2 |
|
3 |
| -> Overview of all available adapters in the AdminForth ecosystem. Adapters enable integration with external services for features like authentication, email delivery, AI completion, image generation, and file storage. |
| 3 | +This page has a list of all available adapters in the AdminForth ecosystem. |
| 4 | +Adapters are used by AdminForth plugins to implement connections to various 3rd-party services and APIs. |
| 5 | +Every adapter could be easily forked and customized for any new service or API. |
4 | 6 |
|
5 | 7 | ---
|
6 | 8 |
|
7 |
| -## [📧 Email Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/EmailAdapter.ts#L17) |
| 9 | +## 📧 Email Adapters |
8 | 10 |
|
9 |
| ->Is used to send emails |
| 11 | +Used to send emails |
10 | 12 |
|
11 |
| -### `adminforth-email-adapter-aws-ses` |
| 13 | +[🔗Email adapter base class](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/EmailAdapter.ts#L17) |
| 14 | + |
| 15 | +### AWS SES Email Adapter |
| 16 | + |
| 17 | +``` |
| 18 | +npm i adminforth-email-adapter-aws-ses |
| 19 | +``` |
12 | 20 |
|
13 | 21 | Enables email delivery via [Amazon Simple Email Service (SES)](https://aws.amazon.com/ses/), suitable for high-volume, programmatic email sending.
|
14 | 22 |
|
15 |
| -### `adminforth-email-adapter-mailgun` |
| 23 | +### Mailgun Email Adapter |
| 24 | + |
| 25 | +``` |
| 26 | +npm i adminforth-email-adapter-mailgun |
| 27 | +``` |
16 | 28 |
|
17 | 29 | Allows sending transactional or marketing emails using [Mailgun](https://www.mailgun.com/), a developer-friendly email service.
|
18 | 30 |
|
19 | 31 | ---
|
20 | 32 |
|
21 |
| -## [🔐 OAuth Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/OAuth2Adapter.ts#L9) |
| 33 | +## 🔐 OAuth2 Adapters |
| 34 | + |
| 35 | +Used to authenticate users via OAuth 2.0 providers |
| 36 | + |
| 37 | +[🔗OAuth2Adapter source class](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/OAuth2Adapter.ts#L9) |
| 38 | + |
| 39 | + |
| 40 | +### Google OAuth Adapter |
22 | 41 |
|
23 |
| ->Is used for integrating third-party login providers using the OAuth 2.0 protocol. |
| 42 | +``` |
| 43 | +npm i adminforth-google-oauth-adapter |
| 44 | +``` |
24 | 45 |
|
25 |
| -### `adminforth-google-oauth-adapter` |
| 46 | +Supports Google sign-in to allow users to authenticate using their Google or Google Workspaces accounts. |
26 | 47 |
|
27 |
| -Supports Google sign-in to allow users to authenticate using their Google accounts. |
| 48 | +### GitHub OAuth Adapter |
28 | 49 |
|
29 |
| -### `adminforth-github-oauth-adapter` |
| 50 | +``` |
| 51 | +npm i adminforth-github-oauth-adapter |
| 52 | +``` |
30 | 53 |
|
31 | 54 | Enables authentication via GitHub accounts, useful for developer tools and open-source apps.
|
32 | 55 |
|
33 |
| -### `adminforth-facebook-oauth-adapter` |
| 56 | +### Facebook OAuth Adapter |
34 | 57 |
|
35 |
| -Allows users to log in with Facebook credentials. |
| 58 | +``` |
| 59 | +npm i adminforth-facebook-oauth-adapter |
| 60 | +``` |
36 | 61 |
|
37 |
| -### `adminforth-keycloak-oauth-adapter` |
| 62 | +Allows users to log in with Facebook credentials. Facebook OAuth is commonly used for social media integrations. |
38 | 63 |
|
39 |
| -Connects AdminForth to a [Keycloak](https://www.keycloak.org/) identity provider for enterprise-grade SSO (Single Sign-On). |
| 64 | +### Keycloak OAuth Adapter |
40 | 65 |
|
41 |
| -### `adminforth-microsoft-oauth-adapter` |
| 66 | +``` |
| 67 | +npm i adminforth-keycloak-oauth-adapter |
| 68 | +``` |
| 69 | + |
| 70 | +Connects AdminForth to an Open-Source [Keycloak](https://www.keycloak.org/) - generally self-hosted - identity provider for enterprise-grade SSO (Single Sign-On). |
| 71 | + |
| 72 | +### Microsoft OAuth Adapter |
| 73 | + |
| 74 | +``` |
| 75 | +npm i adminforth-microsoft-oauth-adapter |
| 76 | +``` |
42 | 77 |
|
43 | 78 | Supports login through Microsoft accounts including Azure AD, Office365, and Outlook.com.
|
44 | 79 |
|
45 |
| -### `adminforth-twitch-oauth-adapter` |
| 80 | +### Twitch OAuth Adapter |
| 81 | + |
| 82 | +``` |
| 83 | +npm i adminforth-twitch-oauth-adapter |
| 84 | +``` |
46 | 85 |
|
47 | 86 | Adds support for Twitch authentication, useful for streaming or creator-oriented platforms.
|
48 | 87 |
|
49 | 88 | ---
|
50 | 89 |
|
51 |
| -## [🎨 Image Generation Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/ImageGenerationAdapter.ts#L32) |
52 |
| ->Is used for image generating |
| 90 | +## 🎨 Image Generation Adapters |
| 91 | + |
| 92 | +Is used for image generating AI tools. |
| 93 | + |
| 94 | +[🔗ImageGenerationAdapter source class](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/ImageGenerationAdapter.ts#L32) |
| 95 | + |
53 | 96 |
|
54 |
| -### `adminforth-image-generation-adapter-openai` |
| 97 | +### OpenAI Image Generation Adapter |
55 | 98 |
|
56 |
| -Uses OpenAI’s image models (like DALL·E) to generate images from text prompts. |
| 99 | +``` |
| 100 | +npm i adminforth-image-generation-adapter-openai |
| 101 | +``` |
| 102 | + |
| 103 | +Uses OpenAI’s image generation models (like DALL·E and gpt-image-1) to generate images from text prompts. |
| 104 | + |
| 105 | +Up to the summer 2025 OpenAI models are one of the most powerful image generation models available (Especially GPT-Image-1), that is why we started with them. |
57 | 106 |
|
58 | 107 | ---
|
59 | 108 |
|
60 |
| -## [💾 Storage Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/StorageAdapter.ts#L8) |
61 |
| ->Is used for storing files |
62 |
| -### `adminforth-storage-adapter-amazon-s3` |
| 109 | +## 💾 Storage Adapters |
| 110 | + |
| 111 | + |
| 112 | +[🔗StorageAdapter source class](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/StorageAdapter.ts#L8) |
| 113 | + |
| 114 | +Is used for storing files |
| 115 | + |
| 116 | +### Amazon S3 Storage Adapter |
| 117 | + |
| 118 | +``` |
| 119 | +npm i adminforth-storage-adapter-amazon-s3 |
| 120 | +``` |
63 | 121 |
|
64 | 122 | Stores uploaded files in [Amazon S3](https://aws.amazon.com/s3/), providing scalable cloud storage.
|
| 123 | +Can be easily forked and customized to work with any S3-compatible storage service like MinIO or Wasabi or 3rd-party S3-capable services. |
65 | 124 |
|
66 |
| -### `adminforth-storage-adapter-local` |
| 125 | + |
| 126 | +### Local Storage Adapter |
| 127 | + |
| 128 | +``` |
| 129 | +npm i adminforth-storage-adapter-local |
| 130 | +``` |
67 | 131 |
|
68 | 132 | Stores files locally on the server’s filesystem. Suitable for development or small-scale self-hosted setups.
|
| 133 | +Not really recommended for production use, cause cloud storage is more reliable and scalable. |
69 | 134 |
|
70 | 135 | ---
|
71 | 136 |
|
72 |
| -## [🧠 AI Completion Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/CompletionAdapter.ts#L16) |
73 |
| ->Is used for AI-powered sentence completion |
74 |
| -### `adminforth-completion-adapter-open-ai-chat-gpt` |
| 137 | +## 🧠 AI Completion Adapters |
| 138 | + |
| 139 | +[🔗CompletionAdapter source class](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/CompletionAdapter.ts#L16) |
| 140 | + |
| 141 | + |
| 142 | +Is used for AI-powered text completion. |
| 143 | +Feel free to fork and implement other models including models from Anthropic, Google Gemini, or any other AI model that supports text completion. |
| 144 | + |
| 145 | +### OpenAI Completion Adapter |
| 146 | + |
| 147 | +``` |
| 148 | +npm i adminforth-completion-adapter-open-ai-chat-gpt |
| 149 | +``` |
75 | 150 |
|
76 | 151 | Integrates AdminForth with OpenAI’s ChatGPT models to provide AI-powered completion and conversational features.
|
77 | 152 |
|
|
0 commit comments