From e1de63a405b8824561aa3d06bc242e71cc121345 Mon Sep 17 00:00:00 2001 From: Baptiste Arnaud Date: Fri, 24 Mar 2023 08:11:13 +0100 Subject: [PATCH] :pencil: Add required asterix in apps config --- .../self-hosting/configuration/builder.mdx | 23 +++++++++++-------- .../self-hosting/configuration/viewer.mdx | 15 +++++++----- apps/docs/src/css/custom.css | 4 ++++ apps/docs/src/js/Asterix.jsx | 3 +++ 4 files changed, 29 insertions(+), 16 deletions(-) create mode 100644 apps/docs/src/js/Asterix.jsx diff --git a/apps/docs/docs/self-hosting/configuration/builder.mdx b/apps/docs/docs/self-hosting/configuration/builder.mdx index f513906ea..ee423f75f 100644 --- a/apps/docs/docs/self-hosting/configuration/builder.mdx +++ b/apps/docs/docs/self-hosting/configuration/builder.mdx @@ -3,21 +3,24 @@ title: Builder --- import { SponsorButton } from '../../../src/js/SponsorButton.jsx' +import { Asterix } from '../../../src/js/Asterix.jsx' # Builder configuration +Parameters marked with are required. + ## General -| Parameter | Default | Description | -| ---------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| DATABASE_URL | | The database URL | -| 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. | -| ADMIN_EMAIL | | The email that will get a "Pro" plan on user creation | -| 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`) | -| 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. | +| Parameter | Default | Description | +| --------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| DATABASE_URL | | The database URL | +| 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 a "Pro" 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. | ## Email (Auth, notifications) diff --git a/apps/docs/docs/self-hosting/configuration/viewer.mdx b/apps/docs/docs/self-hosting/configuration/viewer.mdx index a5dc423c9..1a83b322e 100644 --- a/apps/docs/docs/self-hosting/configuration/viewer.mdx +++ b/apps/docs/docs/self-hosting/configuration/viewer.mdx @@ -3,17 +3,20 @@ title: Viewer --- import { SponsorButton } from '../../../src/js/SponsorButton.jsx' +import { Asterix } from '../../../src/js/Asterix.jsx' # Viewer configuration +Parameters marked with are required. + ## General -| Parameter | Default | Description | -| ---------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| DATABASE_URL | | The database URL | -| 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. | -| NEXT_PUBLIC_VIEWER_URL | | The viewer base URL. Should be the publicly accessible URL (i.e. `https://bot.domain.com`) | -| NEXTAUTH_URL | | The builder base URL. Should be the publicly accessible URL (i.e. `https://typebot.domain.com`) | +| Parameter | Default | Description | +| --------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| DATABASE_URL | | The database URL | +| 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. | +| NEXT_PUBLIC_VIEWER_URL | | The viewer base URL. Should be the publicly accessible URL (i.e. `https://bot.domain.com`) | +| NEXTAUTH_URL | | The builder base URL. Should be the publicly accessible URL (i.e. `https://typebot.domain.com`) | ## Emails (Notifications) diff --git a/apps/docs/src/css/custom.css b/apps/docs/src/css/custom.css index 2cd97e52b..87cbaa322 100644 --- a/apps/docs/src/css/custom.css +++ b/apps/docs/src/css/custom.css @@ -133,3 +133,7 @@ details { video { width: 100%; } + +.asterix { + color: rgb(239, 81, 81); +} diff --git a/apps/docs/src/js/Asterix.jsx b/apps/docs/src/js/Asterix.jsx new file mode 100644 index 000000000..d39c01932 --- /dev/null +++ b/apps/docs/src/js/Asterix.jsx @@ -0,0 +1,3 @@ +import React from 'react' + +export const Asterix = () => *