Skip to Content
Getting StartedSelf Hosting ConvoForm

Self Hosting ConvoForm

ConvoForm is designed to be easily self-hosted using Docker.

Prerequisites

  • Docker  installed on your machine.
  • Git  installed.
  • OpenAI API Key.
  • Clerk API Keys (for authentication).

Quick Start via Docker Compose

  1. Clone the repository:

    git clone https://github.com/growupanand/ConvoForm.git cd ConvoForm
  2. Configure Environment Variables:

    Copy the example environment file:

    cp .env.example .env

    Edit .env and fill in your API keys (OpenAI, Clerk, etc.).

    Important: Generate strong keys for:

    • ENCRYPTION_KEY — Used to encrypt channel bot tokens stored in the database. Generate with openssl rand -hex 32.
  3. Run with Docker Compose:

    docker-compose up --build

    This starts three services:

    ServicePortDescription
    web3000Next.js web application
    websocket-server4000Real-time browser sync
    channels-server4001External channel webhooks (Telegram, etc.)
  4. Access the Application: Open http://localhost:3000  in your browser.

Telegram Channel Setup

To use Telegram bot integration with a self-hosted instance:

  1. Create a bot via @BotFather  on Telegram
  2. In the ConvoForm UI, go to Channels and add your bot token
  3. Expose your channels-server to the internet (e.g., via ngrok or a reverse proxy):
    ngrok http 4001
  4. Set CHANNELS_SERVER_URL in your .env to the public URL (e.g., https://xxxx.ngrok.io)
Last updated on