Skip to content
📚 boreal.chat Docs

Self-Hosting

You can easily self-host boreal.chat using Docker Compose.

Installing Docker

Section titled “Installing Docker”

Please follow the official Docker installation guide to install Docker on your system if you haven’t already.

Running boreal.chat

Section titled “Running boreal.chat”

To run boreal.chat, you need to download our docker-compose.yaml file and configure the .env file.

Let’s start by downloading the docker-compose.yaml file:

Terminal window
wget "https://raw.githubusercontent.com/wosherco/boreal.chat/refs/heads/main/docker-compose.deploy.yaml" -O docker-compose.yaml

Now, let’s download the .env file:

Terminal window
wget "https://raw.githubusercontent.com/wosherco/boreal.chat/refs/heads/main/.env.deploy" -O .env

The values are already filled with the correct defaults, but you can modify them if needed.

Now, let’s start the containers:

Terminal window
docker compose up -d

You should see boreal.chat running on port 3000 in your browser at http://localhost:3000.

Configuring boreal.chat for HTTP/2

Section titled “Configuring boreal.chat for HTTP/2”

For optimal performance, you need to configure a reverse proxy to use HTTP/2.

For Local Use (Quick Setup)

Section titled “For Local Use (Quick Setup)”

Install caddy on your system, run caddy trust, and then proxy port 3000. Make sure to update the PUBLIC_URL in the .env file to match your setup.

Section titled “Using Caddy as a Reverse Proxy (Recommended)”

You will need:

  • A domain name
  • An SSL certificate for that domain (you can use Let’s Encrypt for free)
Section titled “Using Cloudflare Tunnel (Recommended)”

You will need:

  • A Cloudflare account with a domain name configured