docs: 📝 Improve configuration doc
This commit is contained in:
Baptiste Arnaud
@ -10,36 +10,45 @@ The easiest way to get started with Typebot is with [the official managed servic
|
||||
That's also the best way to support my work, open-source software, and you'll get great service!
|
||||
:::
|
||||
|
||||
When running a Typebot on your machine, the following configuration parameters can be supplied as environment variables.
|
||||
When running Typebot on your machine, the following configuration parameters can be supplied as environment variables.
|
||||
|
||||
## Builder & Viewer
|
||||
Typebot is composed of 2 main applications:
|
||||
|
||||
The following variables are shared between builder and viewer. If you host them in a different environment then it needs to be set in both environments.
|
||||
- The builder, where you build your typebots
|
||||
- The viewer, where your user answer the typebot
|
||||
|
||||
### Global
|
||||
Both apps have their own environment config files. Here is an exhaustive list of all the parameters you can set:
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| ---------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| DATABASE_URL | -- | The database URL, i.e. for external db server `postgres://user:password@ip.or.domain.to.server/database_name` |
|
||||
| ENCRYPTION_SECRET | SgVkYp2s5v8y/B?E(H+MbQeThWmZq4t6 | A 256-bit key used to encrypt sensitive data. It is strongly recommended to [generate](https://www.allkeysgenerator.com/Random/Security-Encryption-Key-Generator.aspx) a new one. |
|
||||
| ADMIN_EMAIL | -- | The email that will get a "Pro" plan on user creation |
|
||||
| NEXTAUTH_URL | http://localhost:3000 | The builder base URL. Should be the publicly accessible URL (i.e. `https://app.typebot.io`) |
|
||||
| NEXTAUTH_URL_INTERNAL | -- | The internal builder base URL. You have to set it only when `NEXTAUTH_URL` isn't publicly accessible |
|
||||
| NEXT_PUBLIC_VIEWER_URL | http://localhost:3001 | The viewer base URL. Should be the publicly accessible URL (i.e. `https://typebot.io`) |
|
||||
## Builder
|
||||
|
||||
### SMTP (optional)
|
||||
| Parameter | Default | Description |
|
||||
| ---------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| DATABASE_URL | postgresql://postgres:typebot@db:5432/typebot | The database URL |
|
||||
| ENCRYPTION_SECRET | SgVkYp2s5v8y/B?E(H+MbQeThWmZq4t6 | A 256-bit key used to encrypt sensitive data. It is strongly recommended to [generate](https://www.allkeysgenerator.com/Random/Security-Encryption-Key-Generator.aspx) a new one. The secret should be the same between builder and viewer. |
|
||||
| ADMIN_EMAIL | -- | The email that will get a "Pro" plan on user creation |
|
||||
| NEXTAUTH_URL | http://localhost:3000 | The builder base URL. Should be the publicly accessible URL (i.e. `https://app.typebot.io`) |
|
||||
| NEXT_PUBLIC_VIEWER_URL | http://localhost:3001 | The viewer base URL. Should be the publicly accessible URL (i.e. `https://typebot.io`) |
|
||||
| NEXTAUTH_URL_INTERNAL | -- | The internal builder base URL. You have to set it only when `NEXTAUTH_URL` isn't publicly accessible |
|
||||
|
||||
<details><summary><h3>Email (Auth, notifications)</h3></summary>
|
||||
<p>
|
||||
|
||||
Used for sending email notifications and authentication
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| --------------------- | ------- | ------------------------------------------------------------------------------- |
|
||||
| SMTP_USERNAME | -- | SMTP username |
|
||||
| SMTP_PASSWORD | -- | SMTP password |
|
||||
| SMTP_HOST | -- | SMTP host. (i.e. `smtp.host.com`) |
|
||||
| SMTP_PORT | 25 | SMTP port |
|
||||
| NEXT_PUBLIC_SMTP_FROM | - | From name and email (i.e. `"Typebot Notifications" <notifications@typebot.io>`) |
|
||||
| Parameter | Default | Description |
|
||||
| ------------------------------ | ------- | ------------------------------------------------------------------------------------------ |
|
||||
| SMTP_USERNAME | -- | SMTP username |
|
||||
| SMTP_PASSWORD | -- | SMTP password |
|
||||
| SMTP_HOST | -- | SMTP host. (i.e. `smtp.host.com`) |
|
||||
| SMTP_PORT | 25 | SMTP port |
|
||||
| NEXT_PUBLIC_SMTP_FROM | - | From name and email (i.e. `"Typebot Notifications" <notifications@typebot.io>`) |
|
||||
| NEXT_PUBLIC_SMTP_FROM | - | From name and email (i.e. `"Typebot Notifications" <notifications@typebot.io>`) |
|
||||
| NEXT_PUBLIC_SMTP_AUTH_DISABLED | false | To disable the authentication by email but still use the provided config for notifications |
|
||||
|
||||
### Google (optional)
|
||||
</p></details>
|
||||
|
||||
<details><summary><h3>Google (Auth, Sheets, Fonts)</h3></summary>
|
||||
<p>
|
||||
|
||||
Used authentication in the builder and for the Google Sheets integration step. Make sure to set the required scopes (`userinfo.email`, `spreadsheets`, `drive.readonly`) in your console
|
||||
|
||||
@ -54,28 +63,24 @@ Used for Google Fonts:
|
||||
| -------------------------- | ------- | --------------------------------------- |
|
||||
| NEXT_PUBLIC_GOOGLE_API_KEY | -- | The API Key from the Google API Console |
|
||||
|
||||
## Builder
|
||||
</p></details>
|
||||
|
||||
The following variables are only used for the builder.
|
||||
|
||||
### Email
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| ------------------------------ | ------- | -------------------------------------- |
|
||||
| NEXT_PUBLIC_SMTP_AUTH_DISABLED | false | To disable the authentication by email |
|
||||
|
||||
### GitHub (optional)
|
||||
<details><summary><h3>GitHub (Auth)</h3></summary>
|
||||
<p>
|
||||
|
||||
Used for authenticating with GitHub. By default, it uses the credentials of a Typebot-dev app.
|
||||
|
||||
You can create your own GitHub OAuth app [here](https://github.com/settings/developers).
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| ---------------------------- | ---------------------------------------- | --------------------------------------------------------------------------- |
|
||||
| NEXT_PUBLIC_GITHUB_CLIENT_ID | 534b549dd17709a743a2 | Application client ID. Also used to check if it is enabled in the front-end |
|
||||
| GITHUB_CLIENT_SECRET | 7adb03507504fb1a54422f6c3c697277cfd000a9 | Application secret |
|
||||
| Parameter | Default | Description |
|
||||
| ---------------------------- | ------- | --------------------------------------------------------------------------- |
|
||||
| NEXT_PUBLIC_GITHUB_CLIENT_ID | -- | Application client ID. Also used to check if it is enabled in the front-end |
|
||||
| GITHUB_CLIENT_SECRET | -- | Application secret |
|
||||
|
||||
### Facebook (optional)
|
||||
</p></details>
|
||||
|
||||
<details><summary><h3>Facebook (Auth)</h3></summary>
|
||||
<p>
|
||||
|
||||
You can create your own Facebook OAuth app [here](https://developers.facebook.com/apps/create/).
|
||||
|
||||
@ -84,7 +89,10 @@ You can create your own Facebook OAuth app [here](https://developers.facebook.co
|
||||
| NEXT_PUBLIC_FACEBOOK_CLIENT_ID | -- | Application client ID. Also used to check if it is enabled in the front-end |
|
||||
| FACEBOOK_CLIENT_SECRET | -- | Application secret |
|
||||
|
||||
### S3 Storage (optional)
|
||||
</p></details>
|
||||
|
||||
<details><summary><h3>S3 Storage (Media uploads)</h3></summary>
|
||||
<p>
|
||||
|
||||
Used for uploading images, videos, etc... It can be any S3 compatible object storage service (Minio, Digital Oceans Space, AWS S3...)
|
||||
|
||||
@ -128,7 +136,10 @@ You also need to configure CORS so that an object can be uploaded from the brows
|
||||
]
|
||||
```
|
||||
|
||||
### Giphy (optional)
|
||||
</p></details>
|
||||
|
||||
<details><summary><h3>Giphy (GIF picker)</h3></summary>
|
||||
<p>
|
||||
|
||||
Used to search for GIF. You can create a Giphy app [here](https://developers.giphy.com/dashboard/)
|
||||
|
||||
@ -136,13 +147,16 @@ Used to search for GIF. You can create a Giphy app [here](https://developers.gip
|
||||
| ------------------------- | ------- | ------------- |
|
||||
| NEXT_PUBLIC_GIPHY_API_KEY | -- | Giphy API key |
|
||||
|
||||
### Others (optional)
|
||||
</p></details>
|
||||
|
||||
<details><summary><h3>Others</h3></summary>
|
||||
<p>
|
||||
|
||||
The [official Typebot managed service](https://app.typebot.io/) uses other services such as [Stripe](https://stripe.com/) for processing payments, [Sentry](https://sentry.io/) for tracking bugs and [Sleekplan](https://sleekplan.com/) for user feedbacks.
|
||||
|
||||
The related environment variables are listed here but you are probably not interested in these if you self-host Typebot.
|
||||
|
||||
<details><summary>Stripe</summary>
|
||||
<details><summary><h4>Stripe</h4></summary>
|
||||
<p>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
@ -155,7 +169,7 @@ The related environment variables are listed here but you are probably not inter
|
||||
|
||||
</p></details>
|
||||
|
||||
<details><summary>Sentry</summary>
|
||||
<details><summary><h4>Sentry</h4></summary>
|
||||
<p>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
@ -169,7 +183,7 @@ These can also be added to the `viewer` environment
|
||||
|
||||
</p></details>
|
||||
|
||||
<details><summary>Vercel (custom domains)</summary>
|
||||
<details><summary><h4>Vercel (custom domains)</h4></summary>
|
||||
<p>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
@ -180,7 +194,7 @@ These can also be added to the `viewer` environment
|
||||
|
||||
</p></details>
|
||||
|
||||
<details><summary>Sleekplan</summary>
|
||||
<details><summary><h4>Sleekplan</h4></summary>
|
||||
<p>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
@ -189,7 +203,7 @@ These can also be added to the `viewer` environment
|
||||
|
||||
</p></details>
|
||||
|
||||
<details><summary>Webhooks</summary>
|
||||
<details><summary><h4>Internal Webhooks</h4></summary>
|
||||
<p>
|
||||
|
||||
| Parameter | Default | Description |
|
||||
@ -197,3 +211,41 @@ These can also be added to the `viewer` environment
|
||||
| USER_CREATED_WEBHOOK_URL | -- | Webhook URL called whenever a new user is created (used for importing a new SendGrid contact) |
|
||||
|
||||
</p></details>
|
||||
|
||||
</p></details>
|
||||
|
||||
## Viewer
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| ---------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| DATABASE_URL | postgresql://postgres:typebot@db:5432/typebot | The database URL |
|
||||
| ENCRYPTION_SECRET | SgVkYp2s5v8y/B?E(H+MbQeThWmZq4t6 | A 256-bit key used to encrypt sensitive data. It is strongly recommended to [generate](https://www.allkeysgenerator.com/Random/Security-Encryption-Key-Generator.aspx) a new one. |
|
||||
| NEXT_PUBLIC_VIEWER_URL | http://localhost:3001 | The viewer base URL. Should be the publicly accessible URL (i.e. `https://typebot.io`) |
|
||||
|
||||
<details><summary><h3>Emails (Notifications)</h3></summary>
|
||||
<p>
|
||||
|
||||
Used for sending email notifications and authentication
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| --------------------- | ------- | ------------------------------------------------------------------------------- |
|
||||
| SMTP_USERNAME | -- | SMTP username |
|
||||
| SMTP_PASSWORD | -- | SMTP password |
|
||||
| SMTP_HOST | -- | SMTP host. (i.e. `smtp.host.com`) |
|
||||
| SMTP_PORT | 25 | SMTP port |
|
||||
| NEXT_PUBLIC_SMTP_FROM | - | From name and email (i.e. `"Typebot Notifications" <notifications@typebot.io>`) |
|
||||
| NEXT_PUBLIC_SMTP_FROM | - | From name and email (i.e. `"Typebot Notifications" <notifications@typebot.io>`) |
|
||||
|
||||
</p></details>
|
||||
|
||||
<details><summary><h3>Google (Sheets)</h3></summary>
|
||||
<p>
|
||||
|
||||
Used when executing a Google Sheets block. Make sure to set the required scopes (`userinfo.email`, `spreadsheets`, `drive.readonly`) in your console
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| ---------------------------- | ------- | --------------------------------------------- |
|
||||
| NEXT_PUBLIC_GOOGLE_CLIENT_ID | -- | The Client ID from the Google API Console |
|
||||
| GOOGLE_CLIENT_SECRET | -- | The Client secret from the Google API Console |
|
||||
|
||||
</p></details>
|
||||
|
||||
Reference in New Issue
Block a user