diff --git a/apps/docs/docs/self-hosting/configuration/builder.mdx b/apps/docs/docs/self-hosting/configuration/builder.mdx index 5d28a46ea..48076175d 100644 --- a/apps/docs/docs/self-hosting/configuration/builder.mdx +++ b/apps/docs/docs/self-hosting/configuration/builder.mdx @@ -17,7 +17,7 @@ Parameters marked with are required. | ENCRYPTION_SECRET | | 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. | | NEXTAUTH_URL | | The builder base URL. Should be the publicly accessible URL (i.e. `https://typebot.domain.com`) | | NEXT_PUBLIC_VIEWER_URL | | The viewer base URL. Should be the publicly accessible URL (i.e. `https://bot.domain.com`) | -| ADMIN_EMAIL | | The email that will get an `UNLIMITED` plan on user creation. The associated user will be able to bypass database rules. | +| ADMIN_EMAIL | | The email that will get an `UNLIMITED` plan on user creation. The associated user will be able to bypass database rules. | | NEXTAUTH_URL_INTERNAL | | The internal builder base URL. You have to set it only when `NEXTAUTH_URL` can't be reached by your builder container / server. For a docker deployment, you should set it to `http://localhost:3000`. | | DEFAULT_WORKSPACE_PLAN | FREE | Default workspace plan on user creation or when a user creates a new workspace. Possible values are `FREE`, `STARTER`, `PRO`, `LIFETIME`, `UNLIMITED`. The default plan for admin user is `UNLIMITED` | | DISABLE_SIGNUP | false | Disable new user sign ups. Invited users are still able to sign up. | @@ -113,17 +113,17 @@ The Authorization callback URL should be `$NEXTAUTH_URL/api/auth/callback/azure- ## Custom OAuth Provider (Auth) -| Parameter | Default | Description | -| ---------------------------- | ------------ | --------------------------------------------------------------------------------------- | -| CUSTOM_OAUTH_NAME | Custom OAuth | Provider name. Will be displayed in the sign in form. | -| CUSTOM_OAUTH_CLIENT_ID | | OAuth client ID. | -| CUSTOM_OAUTH_CLIENT_SECRET | | OAuth client secret. | -| CUSTOM_OAUTH_WELL_KNOWN_URL | | OAuth .well-known URL (i.e. `https://auth.domain.com/.well-known/openid-configuration`) | -| CUSTOM_OAUTH_USER_ID_PATH | id | Used to map the id from the user info object | -| CUSTOM_OAUTH_USER_NAME_PATH | name | Used to map the name from the user info object | -| CUSTOM_OAUTH_USER_EMAIL_PATH | email | Used to map the email from the user info object | -| CUSTOM_OAUTH_USER_IMAGE_PATH | image | Used to map the image from the user info object | -| CUSTOM_OAUTH_SCOPE | openid profile email | OAuth scope | +| Parameter | Default | Description | +| ---------------------------- | -------------------- | --------------------------------------------------------------------------------------- | +| CUSTOM_OAUTH_NAME | Custom OAuth | Provider name. Will be displayed in the sign in form. | +| CUSTOM_OAUTH_CLIENT_ID | | OAuth client ID. | +| CUSTOM_OAUTH_CLIENT_SECRET | | OAuth client secret. | +| CUSTOM_OAUTH_WELL_KNOWN_URL | | OAuth .well-known URL (i.e. `https://auth.domain.com/.well-known/openid-configuration`) | +| CUSTOM_OAUTH_USER_ID_PATH | id | Used to map the id from the user info object | +| CUSTOM_OAUTH_USER_NAME_PATH | name | Used to map the name from the user info object | +| CUSTOM_OAUTH_USER_EMAIL_PATH | email | Used to map the email from the user info object | +| CUSTOM_OAUTH_USER_IMAGE_PATH | image | Used to map the image from the user info object | +| CUSTOM_OAUTH_SCOPE | openid profile email | OAuth scope | For `*_PATH` parameters, you can use dot notation to access nested properties (i.e. `account.name`). @@ -220,7 +220,6 @@ The related environment variables are listed here but you are probably not inter | STRIPE_STARTER_STORAGE_YEARLY_PRICE_ID | | Starter Additional storage yearly price id | | STRIPE_PRO_STORAGE_MONTHLY_PRICE_ID | | Pro Additional storage monthly price id | | STRIPE_PRO_STORAGE_YEARLY_PRICE_ID | | Pro Additional storage yearly price id | -| STRIPE_ADDITIONAL_STORAGE_PRICE_ID | | Additional storage price id | | STRIPE_WEBHOOK_SECRET | | Stripe Webhook secret |