# TypeBot docker Automação chatbot e whatsapp # Instalação e configurações TypeBot Procedimentos de instalação e configuração TypeBot # Instalação TypeBot docker Link: [https://docs.typebot.io/self-hosting/deploy/docker](https://docs.typebot.io/self-hosting/deploy/docker) em 06/06/2025
The easiest way to get started with Typebot is with [the official managed service in the Cloud](https://app.typebot.io/). You’ll have high availability, backups, security, and maintenance all managed for you by me, Baptiste, Typebot’s founder. The cloud version can save a substantial amount of developer time and resources. For most sites this ends up being the best value option and the revenue goes to funding the maintenance and further development of Typebot. So you’ll be supporting fair source software and getting a great service!
[​
](https://docs.typebot.io/self-hosting/deploy/docker#requirements)
## Requirements You need a server with Docker installed. If your server doesn’t come with Docker pre-installed, you can follow [their docs](https://docs.docker.com/engine/install/#server) to install it.
[​
](https://docs.typebot.io/self-hosting/deploy/docker#installation)
## Installation
[​
](https://docs.typebot.io/self-hosting/deploy/docker#1-download-the-compose-file)
### 1. Download the compose file On your server, download the latest `docker-compose.yml` and the starter `.env` file:
``` wget https://raw.githubusercontent.com/baptisteArno/typebot.io/latest/docker-compose.yml wget https://raw.githubusercontent.com/baptisteArno/typebot.io/latest/.env.example -O .env ```
[​
](https://docs.typebot.io/self-hosting/deploy/docker#2-add-the-required-configuration)
### 2. Add the required configuration
1. You’ll first need a random 32-character secret key which will be used to encrypt sensitive data. Here is a simple way to generate one:
``` openssl rand -base64 24 | tr -d '\n' ; echo ``` 2. Fill the `.env` file with your values. 3. Configure at least one authentication provider (Email, Google, GitHub, Facebook or GitLab). More info here: [Configuration](https://docs.typebot.io/self-hosting/configuration).
By default the compose file will pull the latest stable Typebot images: `baptistearno/typebot-builder:latest` and `baptistearno/typebot-viewer:latest`. You can decide to replace `latest` with a specific version. You can find all the existing tags [here](https://hub.docker.com/r/baptistearno/typebot-builder/tags)
[​
](https://docs.typebot.io/self-hosting/deploy/docker#3-start-the-server)
### 3. Start the server Once you’ve added your configuration to the compose file, you’re ready to start up the server:
``` docker-compose up -d ``` When you run this command, by default, it does the following:
- Create a database - Run the migrations - Start the builder on port 8080 - Start the viewer on port 8081 - All Typebot’s data is stored in the `.typebot` folder in the current directory
You can now navigate to `http://typebot.domain.com:8080` and see the login screen. Login with the admin email to have access to a Team plan workspace automatically. Typebot server itself does not perform SSL termination. It only runs on unencrypted HTTP. If you want to run on HTTPS you also need to set up a reverse proxy in front of the server. See below instructions.
[​
](https://docs.typebot.io/self-hosting/deploy/docker#update-typebot)
### Update Typebot Typebot is updated regularly, but it is up to you to apply these updates on your server. By virtue of using Docker, these updates are safe and easy to apply.
1. Pull the new images:
``` docker-compose pull typebot-builder docker-compose pull typebot-viewer ``` Alternatively, you can pull specific versions:
``` docker-compose pull typebot-builder:3.4.2 docker-compose pull typebot-viewer:3.4.2 ``` 2. Stop the server:
``` docker-compose down ``` 3. Start the server (with the new images):
``` docker-compose up -d ```
The self-hosted version is somewhat of a LTS, only getting the changes (~ once per month) after they have been battle tested on the cloud version. If you want features as soon as they are available, consider becoming a [cloud user](https://app.typebot.io/).
[​
](https://docs.typebot.io/self-hosting/deploy/docker#optional-extras)
## Optional extras
[​
](https://docs.typebot.io/self-hosting/deploy/docker#reverse-proxy)
### Reverse proxy By default, Typebot runs on unencrypted HTTP on ports 8080 for the builder and 8081 for the viewer. We recommend running it on HTTPS behind a reverse proxy of some sort. You may or may not already be running a reverse proxy on your host, let’s look at both options:
[​
](https://docs.typebot.io/self-hosting/deploy/docker#no-existing-reverse-proxy)
#### No existing reverse proxy If your DNS is managed by a service that offers a proxy option with automatic SSL management, feel free to use that. For example, you could use Cloudflare as a reverse proxy in front of Typebot. Alternatively, you can run your Caddy server as a reverse proxy. This way your SSL certificate will be stored on the host machine and managed by Let’s Encrypt. The Caddy server will expose port 443, terminate SSL traffic and proxy the requests to your Typebot server. Here is an example of a docker-compose file using Caddy as a reverse proxy:
``` services: caddy-gen: container_name: caddy-gen image: 'wemakeservices/caddy-gen:latest' restart: always volumes: - /var/run/docker.sock:/tmp/docker.sock:ro - {$PWD}/.typebot/caddy-certificates:/data/caddy ports: - '80:80' - '443:443' depends_on: - typebot-builder - typebot-viewer typebot-builder: labels: virtual.host: 'typebot.domain.com' # change to your domain name virtual.port: '3000' virtual.tls-email: 'admin@example.com' # change to your email typebot-viewer: labels: virtual.host: 'bot.domain.com' # change to your domain name virtual.port: '3000' virtual.tls-email: 'admin@example.com' # change to your email # Necessary to enable message streaming virtual.proxy.directives: | flush_interval -1 ``` This config requires you to add the following DNS entry:
``` typebot IN A bot IN A ``` You can merge this compose file with the first one. Make sure that `NEXTAUTH_URL` is set to `https://typebot.domain.com` and `NEXT_PUBLIC_VIEWER_URL` is set to `https://bot.domain.com`. When running the compose file, it should automatically enable SSL on your server and you should be able to navigate to:
- `https://typebot.domain.com` for the builder - `https://bot.domain.com` for the viewer
[​
](https://docs.typebot.io/self-hosting/deploy/docker#existing-reverse-proxy)
#### Existing reverse proxy If you’re already running a reverse proxy, the most important things to note are:
1. Configure the virtual hosts to match the `NEXTAUTH_URL` and `NEXT_PUBLIC_VIEWER_URL` in your `docker-compose` configuration. 2. Proxy the traffic to `127.0.0.1:8080` or `{ip-address}:8080` and to `127.0.0.1:8081` or `{ip-address}:8081` if running on a remote machine
[​
](https://docs.typebot.io/self-hosting/deploy/docker#smtp)
### SMTP I highly recommend using an external SMTP service. There are tons of options out there, including [SendInBlue](https://www.sendinblue.com/), [Mailgun](https://www.mailgun.com/) and [SendGrid](https://sendgrid.com/). It will avoid severe headaches 😅. Then, you will only need to add the required [SMTP configuration variables](https://docs.typebot.io/self-hosting/configuration#email-auth-notifications). If, however, you don’t want to, you can instantiate an SMTP server in the docker-compose file.
``` services: mail: image: bytemark/smtp restart: always ``` And add the following variables to your `.env` file:
``` SMTP_HOST=mail NEXT_PUBLIC_SMTP_FROM=notifications@typebot.domain.com ``` You will probably need to make sure that `typebot.domain.com` has a valid SPF record and that your server IP has a rDNS set up. You can merge this compose file with the main one.
[​
](https://docs.typebot.io/self-hosting/deploy/docker#s3-storage)
### S3 storage If you don’t already have an S3 storage available, you could include it in your docker-compose file:
``` services: minio: image: minio/minio command: server /data ports: - '9000:9000' environment: MINIO_ROOT_USER: minio MINIO_ROOT_PASSWORD: minio123 volumes: - s3-data:/data # This service just makes sure a bucket with the right policies is created createbuckets: image: minio/mc depends_on: - minio entrypoint: > /bin/sh -c " sleep 10; /usr/bin/mc config host add minio http://minio:9000 minio minio123; /usr/bin/mc mb minio/typebot; /usr/bin/mc anonymous set public minio/typebot/public; exit 0; " volumes: s3-data: ``` And add the following variables to your `.env` file:
``` S3_ACCESS_KEY=minio S3_SECRET_KEY=minio123 S3_BUCKET=typebot S3_ENDPOINT=storage.domain.com ``` This config requires you to add the following DNS entry:
``` storage IN A ``` You can merge this compose file with the main one.
[​
](https://docs.typebot.io/self-hosting/deploy/docker#config-example-with-all-the-extras)
## Config example with all the extras Here is a config example that spins up Typebot with HTTPS, SMTP and S3 storage.
``` services: caddy-gen: image: 'wemakeservices/caddy-gen:latest' restart: always volumes: - /var/run/docker.sock:/tmp/docker.sock:ro - {$PWD}/.typebot/caddy-certificates:/data/caddy ports: - '80:80' - '443:443' depends_on: - typebot-builder - typebot-viewer typebot-db: image: postgres:16 restart: always volumes: - db-data:/var/lib/postgresql/data environment: - POSTGRES_DB=typebot - POSTGRES_PASSWORD=typebot healthcheck: test: ["CMD-SHELL", "pg_isready -U postgres"] interval: 5s timeout: 5s retries: 5 typebot-builder: labels: virtual.host: 'typebot.domain.com' # change to your domain virtual.port: '3000' virtual.tls-email: 'admin@example.com' # change to your email image: baptistearno/typebot-builder:latest depends_on: typebot-db: condition: service_healthy restart: always extra_hosts: - 'host.docker.internal:host-gateway' # See https://docs.typebot.io/self-hosting/configuration for more configuration options env_file: - .env typebot-viewer: labels: virtual.host: 'bot.domain.com' # change to your domain virtual.port: '3000' virtual.tls-email: 'admin@example.com' # change to your email # Necessary to enable message streaming virtual.proxy.directives: | flush_interval -1 image: baptistearno/typebot-viewer:latest depends_on: typebot-db: condition: service_healthy restart: always # See https://docs.typebot.io/self-hosting/configuration for more configuration options env_file: - .env mail: image: bytemark/smtp restart: always minio: labels: virtual.host: 'storage.domain.com' # change to your domain virtual.port: '9000' virtual.tls-email: 'admin@example.com' # change to your email image: minio/minio command: server /data ports: - '9000:9000' environment: MINIO_ROOT_USER: minio MINIO_ROOT_PASSWORD: minio123 volumes: - s3-data:/data # This service just make sure a bucket with the right policies is created createbuckets: image: minio/mc depends_on: - minio entrypoint: > /bin/sh -c " sleep 10; /usr/bin/mc config host add minio http://minio:9000 minio minio123; /usr/bin/mc mb minio/typebot; /usr/bin/mc anonymous set public minio/typebot/public; exit 0; " volumes: db-data: s3-data: ```
[​
](https://docs.typebot.io/self-hosting/deploy/docker#build-your-own-images)
## Build your own images To build your own builder Docker image
``` docker build -t typebot-builder --build-arg SCOPE=builder . ``` To build your own viewer Docker image
``` docker build -t typebot-viewer --build-arg SCOPE=viewer . ```
[​
](https://docs.typebot.io/self-hosting/deploy/docker#troubleshooting)
## Troubleshooting
[​
](https://docs.typebot.io/self-hosting/deploy/docker#avoiding-network-issues-when-migrating-in-portainer)
### Avoiding network issues when migrating in Portainer If you migrate a Typebot stack between Portainer instances, hostname resolution may fail, causing `typebot-viewer` to be unable to connect to `typebot-db`. Before deploying the stack in Portainer, ensure the network is **explicitly defined as attachable** in `docker-compose.yml`:
``` networks: typebot_network: driver: bridge attachable: true services: typebot-db: ... networks: - typebot_network typebot-builder: ... networks: - typebot_network typebot-viewer: ... networks: - typebot_network ``` When deploying the stack, Portainer will automatically create the network with the correct settings. This prevents hostname resolution issues after migration.
If you’re self-hosting Typebot, [sponsoring me](https://github.com/sponsors/baptisteArno) is a great way to give back to the community and to contribute to the long-term sustainability of the project. It also comes with some perks like priority support and private workshops. ❤️
This doc has been inspired by [Plausible docs](https://plausible.io/docs). They have a similar self-hosting solutions, and their documentation is 🔥.
# Dicas problemas de configurações LInk: [https://github.com/baptisteArno/typebot.io/issues/942](https://github.com/baptisteArno/typebot.io/issues/942) Procedimentos extraídos de listas do typebot sobre dificuldades de instalações. #### Cannot get SMTP config to send email \#942
**[baptisteArno](https://github.com/baptisteArno)** commented [on Oct 17, 2023](https://github.com/baptisteArno/typebot.io/issues/942#issuecomment-1766460032) •
Probably an issue with the single quote on `NEXT_PUBLIC_SMTP_FROM`
My config with Sendinblue: ``` SMTP_USERNAME=baptiste@typebot.io SMTP_PASSWORD=... SMTP_HOST=smtp-relay.sendinblue.com SMTP_PORT=587 NEXT_PUBLIC_SMTP_FROM="'Typebot Notifications' " ``` **[MAS-CreativeLabs](https://github.com/MAS-CreativeLabs)** commented [on Nov 12, 2023](https://github.com/baptisteArno/typebot.io/issues/942#issuecomment-1807079668) I apologize for the delayed reply, I was on a trip. her's my configuration: I'm hosting typebot on a Synology NAS with a reverse proxy (the same exact test machine I use for all my docker in my testing environment. I used portainer for the deployment of typebot and I followed the instructions from the official documentation. ##### Docker compose file : `version: '3.3' volumes: db-data: services: typebot-db: image: postgres:14-alpine restart: always volumes: \- db-data:/var/lib/postgresql/data ``` environment: - POSTGRES_DB=typebot - POSTGRES_PASSWORD=typebot ```
typebot-builder: image: baptistearno/typebot-builder:latest restart: always depends\_on: \- typebot-db ports: \- '8080:3000' extra\_hosts: \- 'host.docker.internal:host-gateway' env\_file: stack.env typebot-viewer: image: baptistearno/typebot-viewer:latest restart: always ports: \- '8081:3000' env\_file: stack.env` ### .env file: `ENCRYPTION\_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXX DATABASE\_URL=postgresql://postgres:typebot@typebot-db:5432/typebot NEXTAUTH\_URL=[https://typebot.mydonmain.com](https://typebot.mydonmain.com/) NEXT\_PUBLIC\_VIEWER\_URL=[https://bot.mydonmain.com](https://bot.mydonmain.com/) ADMIN\_EMAIL= NEXTAUTH\_URL\_INTERNAL=[http://localhost:3000](http://localhost:3000/) DEFAULT\_WORKSPACE\_PLAN=UNLIMITED DISABLE\_SIGNUP=false NEXT\_PUBLIC\_BOT\_FILE\_UPLOAD\_MAX\_SIZE=250 SMTP\_USERNAME= SMTP\_PASSWORD=XXXXXXXXXXXXXXXXXXXX SMTP\_HOST=ssl0.ovh.net SMTP\_PORT=465 SMTP\_SECURE=true NEXT\_PUBLIC\_SMTP\_FROM="'Typebot Notifications' " GOOGLE\_CLIENT\_ID=XXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.apps.googleusercontent.com GOOGLE\_CLIENT\_SECRET=XXXXX-XXXXXXXXXX\_XXXXX GITHUB\_CLIENT\_ID=XXXXXXXXXXXXXXXXXXXXXXXXX GITHUB\_CLIENT\_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX FACEBOOK\_CLIENT\_ID=XXXXXXXXXXXXXXXXXXXX FACEBOOK\_CLIENT\_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX NEXT\_PUBLIC\_GIPHY\_API\_KEY=XXXXXXXXXXXXXXXXXXXXXXXXX NEXT\_PUBLIC\_UNSPLASH\_APP\_NAME=Typebot NEXT\_PUBLIC\_UNSPLASH\_ACCESS\_KEY=XXXXXXXXXXXXXXXXXXXXXXXXX **Obs: Para funcionar no laboratório nestas configurações foi apontado o NEXTAUTH\_URL e NEXT\_PUBLIC\_VIEWER\_URL para o mesmo endereço de viewer.** # Configurations self-hosting TypeBot Link: [https://docs.typebot.io/self-hosting/configuration](https://docs.typebot.io/self-hosting/configuration)
### Configuration
If you’re self-hosting Typebot, [sponsoring me](https://github.com/sponsors/baptisteArno) is a great way to give back to the community and to contribute to the long-term sustainability of the project. It also comes with some perks like priority support and private workshops. ❤️ **Parameters marked with \* are required.** #### **​General**
ParameterDefaultDescription
DATABASE\_URL \* The database URL
ENCRYPTION\_SECRET \* A 256-bit key used to encrypt sensitive data. It is strongly recommended to [generate](https://docs.typebot.io/self-hosting/deploy/docker#2-add-the-required-configuration) 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. You can provide multiple emails separated by a comma without spaces.
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\_PLANFREEDefault 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\_SIGNUPfalseDisable new user sign ups. Invited users are still able to sign up.
NEXT\_PUBLIC\_ONBOARDING\_TYPEBOT\_ID Typebot ID used for the onboarding. Onboarding page is skipped if not provided.
DEBUGfalseIf enabled, the server will print valuable logs to debug config issues.
NEXT\_PUBLIC\_BOT\_FILE\_UPLOAD\_MAX\_SIZE Limits the size of each file that can be uploaded in the bots (i.e. Set `10` to limit the file upload to 10MB)
[​
](https://docs.typebot.io/self-hosting/configuration#email-auth-notifications)
## Email (Auth, notifications) Used for sending email notifications and authentication
ParameterDefaultDescription
SMTP\_USERNAME SMTP username
SMTP\_PASSWORD SMTP password
SMTP\_HOST SMTP host. (i.e. `smtp.host.com`)
SMTP\_PORT25SMTP port
NEXT\_PUBLIC\_SMTP\_FROM From name and email (i.e. `'Typebot Notifications' `)
SMTP\_SECUREfalseIf true the connection will use TLS when connecting to server. If false (the default) then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false
SMTP\_AUTH\_DISABLEDfalseTo disable the authentication by email but still use the provided config for notifications
[​
](https://docs.typebot.io/self-hosting/configuration#google-auth)
## Google Auth
ParameterDefaultDescription
GOOGLE\_CLIENT\_ID The Client ID from the Google API Console
GOOGLE\_CLIENT\_SECRET The Client secret from the Google API Console
NEXT\_PUBLIC\_GOOGLE\_API\_KEY The API Key from the Google API Console
[​
](https://docs.typebot.io/self-hosting/configuration#google-sheets)
## Google Sheets
ParameterDefaultDescription
GOOGLE\_CLIENT\_ID The Client ID from the Google API Console
GOOGLE\_CLIENT\_SECRET The Client secret from the Google API Console
NEXT\_PUBLIC\_GOOGLE\_API\_KEY The API Key from the Google API Console
##### **Google Fonts** Used authentication in the builder and for the Google Sheets integration step.
ParameterDefaultDescription
NEXT\_PUBLIC\_GOOGLE\_API\_KEY The API Key from the Google API Console
[​
](https://docs.typebot.io/self-hosting/configuration#github-auth)
## GitHub (Auth) 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). The Authorization callback URL should be `$NEXTAUTH_URL/api/auth/callback/github`
ParameterDefaultDescription
GITHUB\_CLIENT\_ID Application client ID. Also used to check if it is enabled in the front-end
GITHUB\_CLIENT\_SECRET Application secret
[​
](https://docs.typebot.io/self-hosting/configuration#gitlab-auth)
## GitLab (Auth) Used for authenticating with GitLab. Follow the official GitLab guide for creating OAuth2 applications [here](https://docs.gitlab.com/ee/integration/oauth_provider.html). The Authorization callback URL should be `$NEXTAUTH_URL/api/auth/callback/gitlab`
ParameterDefaultDescription
GITLAB\_CLIENT\_ID Application client ID. Also used to check if it is enabled in the front-end
GITLAB\_CLIENT\_SECRET Application secret
GITLAB\_BASE\_URL[https://gitlab.com](https://gitlab.com/)Base URL of the GitLab instance
GITLAB\_REQUIRED\_GROUPS Comma-separated list of groups the user has to be a direct member of, e.g. `foo,bar`
GITLAB\_NAMEGitLabName of the GitLab instance, used for the SSO Login Button
[​
](https://docs.typebot.io/self-hosting/configuration#facebook-auth)
## Facebook (Auth) You can create your own Facebook OAuth app [here](https://developers.facebook.com/apps/create/). The Authorization callback URL should be `$NEXTAUTH_URL/api/auth/callback/facebook`
ParameterDefaultDescription
FACEBOOK\_CLIENT\_ID Application client ID. Also used to check if it is enabled in the front-end
FACEBOOK\_CLIENT\_SECRET Application secret
[​
](https://docs.typebot.io/self-hosting/configuration#azure-ad-auth)
## Azure AD (Auth) If you are using [Azure Active Directory](https://azure.microsoft.com/en-us/services/active-directory/) for the authentication you can set the following environment variables. The Authorization callback URL should be `$NEXTAUTH_URL/api/auth/callback/azure-ad`
ParameterDefaultDescription
AZURE\_AD\_CLIENT\_ID Application client ID
AZURE\_AD\_CLIENT\_SECRET Application client secret. Can be obtained from Azure Portal.
AZURE\_AD\_TENANT\_ID Azure Tenant ID
[​
](https://docs.typebot.io/self-hosting/configuration#keycloak-auth)
## Keycloak (Auth) Used for authenticating with Keycloak. Follow the official Keycloak guide for creating OAuth2 applications [here](https://www.keycloak.org/).
ParameterDefaultDescription
KEYCLOAK\_CLIENT\_ID Application client ID.
KEYCLOAK\_CLIENT\_SECRET Application secret
KEYCLOAK\_REALM Your Keycloak Realm
KEYCLOAK\_BASE\_URL Base URL of the Keycloak instance
[​
](https://docs.typebot.io/self-hosting/configuration#custom-oauth-provider-auth)
## Custom OAuth Provider (Auth)
ParameterDefaultDescription
CUSTOM\_OAUTH\_NAMECustom OAuthProvider 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\_PATHidUsed to map the id from the user info object
CUSTOM\_OAUTH\_USER\_NAME\_PATHnameUsed to map the name from the user info object
CUSTOM\_OAUTH\_USER\_EMAIL\_PATHemailUsed to map the email from the user info object
CUSTOM\_OAUTH\_USER\_IMAGE\_PATHimageUsed to map the image from the user info object
CUSTOM\_OAUTH\_SCOPEopenid profile emailOAuth scope
For `*_PATH` parameters, you can use dot notation to access nested properties (i.e. `account.name`). The Authorization callback URL should be: `$NEXTAUTH_URL/api/auth/callback/custom-oauth`
[​
](https://docs.typebot.io/self-hosting/configuration#s3-storage-media-uploads)
## S3 Storage (Media uploads) Used for uploading images, videos, etc… It can be any S3 compatible object storage service (Minio, Digital Oceans Space, AWS S3…)
ParameterDefaultDescription
S3\_ACCESS\_KEY S3 access key. Also used to check if upload feature is enabled
S3\_SECRET\_KEY S3 secret key.
S3\_BUCKETtypebotName of the bucket where assets will be uploaded in.
S3\_PORT S3 Host port number
S3\_ENDPOINT S3 endpoint (i.e. `s3.domain.com`).
S3\_SSLtrueUse SSL when establishing the connection.
S3\_REGION S3 region.
S3\_PUBLIC\_CUSTOM\_DOMAIN If the final URL that is used to read public files is different from `S3_ENDPOINT`
Note that for AWS S3, your endpoint is usually: `s3..amazonaws.com` In order to function properly, your S3 bucket must be configured. Make sure to read through the [S3 configuration](https://docs.typebot.io/self-hosting/guides/s3) doc.
[​
](https://docs.typebot.io/self-hosting/configuration#giphy-gif-picker)
## Giphy (GIF picker) Used to search for GIF. You can create a Giphy app [here](https://developers.giphy.com/dashboard/)
ParameterDefaultDescription
NEXT\_PUBLIC\_GIPHY\_API\_KEY Giphy API key
[​
](https://docs.typebot.io/self-hosting/configuration#unsplash-image-picker)
## Unsplash (image picker) Used to search for images. You can create an Unsplash app [here](https://unsplash.com/developers)
ParameterDefaultDescription
NEXT\_PUBLIC\_UNSPLASH\_APP\_NAME Unsplash App name
NEXT\_PUBLIC\_UNSPLASH\_ACCESS\_KEY Unsplash API key
[​
](https://docs.typebot.io/self-hosting/configuration#pexels-video-picker)
## Pexels (video picker) Used to search for videos. You can create a Pexels app [here](https://www.pexels.com/api/key/)
ParameterDefaultDescription
NEXT\_PUBLIC\_PEXELS\_API\_KEY Pexels API key
[​
](https://docs.typebot.io/self-hosting/configuration#tolgee-i18n-contribution-dev-tool)
## Tolgee (i18n contribution dev tool)
If you’d like to join contribute to Typebot’s translation join the [Discord server](https://discord.gg/xjyQczWAXV) and ask for an access to Tolgee in the [\#contributors channel](https://discord.com/channels/1155799591220953138/1155883114455900190). Set up these environment variables to enable [Tolgee dev tool](https://tolgee.io/features/dev-tools).
ParameterDefaultDescription
NEXT\_PUBLIC\_TOLGEE\_API\_KEY Your Tolgee API key
NEXT\_PUBLIC\_TOLGEE\_API\_URL[https://tolgee.server.baptistearno.com](https://tolgee.server.baptistearno.com/)The Tolgee API base URL
[​
](https://docs.typebot.io/self-hosting/configuration#whatsapp-preview)
## WhatsApp (Preview) In order to be able to test your bot on WhatsApp from the Preview drawer, you need to set up a WhatsApp business app.
ParameterDefaultDescription
META\_SYSTEM\_USER\_TOKEN The system user token used to send WhatsApp messages
WHATSAPP\_PREVIEW\_FROM\_PHONE\_NUMBER\_ID The phone number ID from which the message will be sent
WHATSAPP\_PREVIEW\_TEMPLATE\_NAME The preview start template message name
WHATSAPP\_PREVIEW\_TEMPLATE\_LANGen\_USThe preview start template message name
WHATSAPP\_CLOUD\_API\_URL[https://graph.facebook.com](https://graph.facebook.com/)The WhatsApp Cloud API base URL
WHATSAPP\_INTERACTIVE\_GROUP\_SIZE3The array size of items to send to API on choice input. You can’t choose a number higher than 3 if you are using the official cloud API URL.
[​
](https://docs.typebot.io/self-hosting/configuration#redis)
## Redis In Typebot, Redis is optional and is used to:
- Rate limit the sign in requests based on user IP - Enable multiple media upload on WhatsApp
ParameterDefaultDescription
REDIS\_URL The database URL. i.e. `redis://:@:`
[​
](https://docs.typebot.io/self-hosting/configuration#others)
## Others 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. ##### **Vercel (custom domains)**
ParameterDefaultDescription
VERCEL\_TOKEN Vercel API token
NEXT\_PUBLIC\_VERCEL\_VIEWER\_PROJECT\_NAME The name of the viewer project in Vercel
VERCEL\_TEAM\_ID Vercel team ID that contains the viewer project
##### **Telemetry**
ParameterDefaultDescription
MESSAGE\_WEBHOOK\_URL Webhook URL called to receive important system messages
USER\_CREATED\_WEBHOOK\_URL Webhook URL called whenever a new user is created
**PostHog**
ParameterDefaultDescription
NEXT\_PUBLIC\_POSTHOG\_KEY PostHog API Key
NEXT\_PUBLIC\_POSTHOG\_HOST[https://app.posthog.com](https://app.posthog.com/)PostHog API Host
**System labels**
ParameterDefaultDescription
NEXT\_PUBLIC\_VIEWER\_404\_TITLE404
NEXT\_PUBLIC\_VIEWER\_404\_SUBTITLEThe bot you’re looking for doesn’t exist