Instalação e configurações TypeBot

• Instalação TypeBot docker
• Dicas problemas de configurações
• Configurations self-hosting TypeBot

Instalação TypeBot docker

Link: https://docs.typebot.io/self-hosting/deploy/docker

The easiest way to get started with Typebot is with the official managed service in the Cloud. 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 open source software and getting a great service!

Requirements

You need a server with Docker installed. If your server doesn’t come with Docker pre-installed, you can follow their docs to install it.

​Installation

​

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

2. Add the required 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

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:

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.

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.

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.

Optional extras

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:

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:

version: '3.3'
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

This config requires you to add the following DNS entry:

typebot IN A <server_ip>
bot IN A <server_ip>

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:

Existing reverse proxy

If you’re already running a reverse proxy, the most important things to note are:

SMTP

I highly recommend using an external SMTP service. There are tons of options out there, including SendInBlue, Mailgun and SendGrid. It will avoid severe headaches 😅. Then, you will only need to add the required SMTP configuration variables.

If, however, you don’t want to, you can instantiate an SMTP server in the docker-compose file.

version: '3.3'
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.

S3 storage

If you don’t already have an S3 storage available, you could include it in your docker-compose file:

version: '3.3'

volumes:
  s3-data:

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;
      "

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 <server_ip>

You can merge this compose file with the main one.

Config example with all the extras

Here is a config example that spins up Typebot with HTTPS, SMTP and S3 storage.

version: '3.3'

volumes:
  db-data:
  s3-data:

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:14-alpine
    restart: always
    volumes:
      - db-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=typebot
      - POSTGRES_PASSWORD=typebot
  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
    restart: always
    depends_on:
      - typebot-db
    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
    image: baptistearno/typebot-viewer:latest
    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;
      "

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 .

If you’re self-hosting Typebot, sponsoring me 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. 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

Procedimentos extraídos de listas do typebot sobre dificuldades de instalações.

Cannot get SMTP config to send email #942

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' <notifications@typebot.io>"

MAS-CreativeLabs commented on Nov 12, 2023

 

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

NEXT_PUBLIC_VIEWER_URL=https://bot.mydonmain.com

ADMIN_EMAIL=XXXXX@gmail.com

NEXTAUTH_URL_INTERNAL=http://localhost:3000

DEFAULT_WORKSPACE_PLAN=UNLIMITED

DISABLE_SIGNUP=false

NEXT_PUBLIC_BOT_FILE_UPLOAD_MAX_SIZE=250

SMTP_USERNAME=XXXXX@XXXXX.com

SMTP_PASSWORD=XXXXXXXXXXXXXXXXXXXX

SMTP_HOST=ssl0.ovh.net

SMTP_PORT=465

SMTP_SECURE=true

NEXT_PUBLIC_SMTP_FROM="'Typebot Notifications' XXXXX@XXXXX.com"

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

Configuration

If you’re self-hosting Typebot, sponsoring me 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

Email (Auth, notifications)

Used for sending email notifications and authentication

Google Auth

Google Sheets

Parameter	Default	Description
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.

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. The Authorization callback URL should be $NEXTAUTH_URL/api/auth/callback/github

GitLab (Auth)

Used for authenticating with GitLab. Follow the official GitLab guide for creating OAuth2 applications here. The Authorization callback URL should be $NEXTAUTH_URL/api/auth/callback/gitlab

Facebook (Auth)

You can create your own Facebook OAuth app here. The Authorization callback URL should be $NEXTAUTH_URL/api/auth/callback/facebook

Azure AD (Auth)

If you are using Azure 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

Keycloak (Auth)

Used for authenticating with Keycloak. Follow the official Keycloak guide for creating OAuth2 applications here.

Custom OAuth Provider (Auth)

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

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…)

Note that for AWS S3, your endpoint is usually: s3.<S3_REGION>.amazonaws.com

In order to function properly, your S3 bucket must be configured. Make sure to read through the S3 configuration doc.

Giphy (GIF picker)

Used to search for GIF. You can create a Giphy app here

Unsplash (image picker)

Used to search for images. You can create an Unsplash app here

Pexels (video picker)

Used to search for videos. You can create a Pexels app here

Tolgee (i18n contribution dev tool)

If you’d like to join contribute to Typebot’s translation join the Discord server and ask for an access to Tolgee in the #contributors channel.

Set up these environment variables to enable Tolgee dev tool.

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.

Redis

In Typebot, Redis is optional and is used to:

Others

The official Typebot managed service uses other services such as Stripe for processing payments, Sentry for tracking bugs and Sleekplan 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)

Parameter	Default	Description
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