Manual

This doc is for deploying Typebot on a server manually. If you’re looking for running Typebot locally, for development purposes, check out the local installation guide.

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 fair source software and getting a great service!

Requirements

A Postgres database hosted somewhere. For production, Neon is my provider of choice. This is not an affiliate link; it is simply the provider I use and recommend for a production database. You can also use any compatible Postgres provider or host Postgres yourself.
A server with Node.js 24.x, bun, Nginx, and PM2 installed.
Experience in deploying Next.js applications with PM2. Check out this guide for more information.

Getting Started

Fork/clone the repository and checkout the latest stable version.

git clone [email protected]:<username>/typebot.io.git
cd typebot.io
git checkout latest

Setup environment variables by copying the example files and following the configuration guide to fill in the missing values.

cp .env.example .env

The database user should have the SUPERUSER role. You can setup and migrate the database with the bunx nx db:migrate prisma command.

Install dependencies

bun install

Run the database migrations

bunx nx db:migrate prisma

Build the builder and viewer

bunx nx run-many -t build -p builder,viewer

If you face the issue Node ran out of memory, then you should increase the memory limit for Node.js. For example,NODE_OPTIONS=--max-old-space-size=4096 will increase the memory limit to 4GB. Check this stackoverflow answer for more information.

Deployments

Deploy the builder

From the repository root, start the builder with PM2:

pm2 start bunx --name=typebot-builder -- nx start builder -- -p 3000

Deploy the viewer

From the repository root, start the viewer with PM2:

pm2 start bunx --name=typebot-viewer -- nx start viewer -- -p 3001

You can change the ports passed after -p. The PM2 commands must be run from the repository root so Nx can resolve the workspace.

Nginx configuration

You can use the following configuration to serve the builder and viewer with Nginx. Make sure to replace the server_name values with the respective domain names for your Typebot instance. They should match NEXTAUTH_URL and NEXT_PUBLIC_VIEWER_URL. Check out this guide for a step-by-step guide on how to setup Nginx and PM2.

server {
     listen 80;
     server_name typebot.example.com;
     return 301 https://typebot.example.com$request_uri;
}

server {
    listen 443 ssl;
    server_name typebot.example.com;

    # managed by Certbot
    ssl_certificate /etc/letsencrypt/live/typebot.example.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/typebot.example.com/privkey.pem;
    include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot

    location ^~ / {
         proxy_pass http://localhost:3000;
         proxy_http_version 1.1;
         proxy_set_header Upgrade $http_upgrade;
         proxy_set_header Connection 'upgrade';
         proxy_set_header Host $host;
         proxy_set_header X-Real-IP $remote_addr;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         proxy_set_header X-Forwarded-Proto $scheme;
         proxy_cache_bypass $http_upgrade;
    }
}

server {
     listen 80;
     server_name bot.example.com;
     return 301 https://bot.example.com$request_uri;
}

server {
    listen 443 ssl;
    server_name bot.example.com;

    # managed by Certbot
    ssl_certificate /etc/letsencrypt/live/bot.example.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/bot.example.com/privkey.pem;
    include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot

    location ^~ / {
         proxy_pass http://localhost:3001;
         proxy_http_version 1.1;
         proxy_set_header Upgrade $http_upgrade;
         proxy_set_header Connection 'upgrade';
         proxy_set_header Host $host;
         proxy_set_header X-Real-IP $remote_addr;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         proxy_set_header X-Forwarded-Proto $scheme;
         proxy_cache_bypass $http_upgrade;

         # Necessary to enable message streaming
         proxy_buffering off;
    }
}

Get started

Deploy

Guides

Misc

Requirements

Getting Started

Deployments

Deploy the builder

Deploy the viewer

Nginx configuration

​Requirements

​Getting Started

​Deployments

​Deploy the builder

​Deploy the viewer

​Nginx configuration

Requirements

Getting Started

Deployments

Deploy the builder

Deploy the viewer

Nginx configuration