Overseer Docs
Guides

Deployment

Simple deployment guide for the app and for the docs site.

Deployment Guide

This page covers two different things:

  1. deploying the Overseer app
  2. deploying the documentation site

They are not the same.

Which one do you want?

Deploy the app

Choose this if you want the full Overseer product: chat, files, users, providers, bots, automation, and server access.

Deploy the docs

Choose this if you only want to publish the help website from apps/docs/.

VPS (Recommended)

Any VPS with 2GB+ RAM running Ubuntu 22.04+. DigitalOcean, Hetzner, AWS EC2, etc.

Docker

Use the included Docker Compose configuration for containerized deployment.

The full Overseer app is not a good fit for Vercel.

Overseer needs things like:

  • persistent local files
  • local SQLite storage by default
  • long-running background processes
  • bot workers
  • shell and filesystem access

That is why the app itself should usually run on a VPS or Docker host.

VPS Deployment

This is the recommended way to deploy the real app.

1. Install

curl -fsSL https://overseer.sh/install | bash

This gets the app onto your server and walks you through setup.

2. Configure Nginx (Optional)

server {
    listen 80;
    server_name your-domain.com;

    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_cache_bypass $http_upgrade;
    }
}

3. SSL with Certbot

sudo apt install certbot python3-certbot-nginx
sudo certbot --nginx -d your-domain.com

4. Systemd Services

sudo cp systemd/*.service /etc/systemd/system/
sudo systemctl enable --now overseer
sudo systemctl enable --now overseer-discord

Docker Deployment

If you already use Docker on your server:

docker compose up -d

Deploy the Docs on Vercel

The documentation now lives in the apps/docs/ folder as a standalone Fumadocs + Next.js app.

If your goal is: “I want the docs website online on Vercel”, follow this section.

According to Vercel’s official docs, Vercel can auto-detect Next.js apps, and you can deploy a monorepo app by setting the Root Directory in Project Settings. Sources: Next.js on Vercel, Configuring a Build, Project Settings.

The simple Vercel flow

  1. Open the Vercel Dashboard.
  2. Click Add NewProject.
  3. Import this repository.
  4. Set Root Directory to apps/docs.
  5. Keep the detected framework as Next.js.
  6. Deploy.

That is it.

What Vercel should run

Inside apps/docs, the important scripts are:

pnpm build
pnpm start

The build already uses the correct Next.js build mode for this standalone docs app.

Custom domain

If you want a custom docs domain:

  1. Deploy first
  2. Open the Vercel project
  3. Go to Settings → Domains
  4. Add your domain, such as docs.yourdomain.com

If you want proper Open Graph image URLs in production, set NEXT_PUBLIC_DOCS_URL in Vercel to your final docs URL, for example https://docs.yourdomain.com.

Local testing

Run the docs app locally before pushing:

cd apps/docs
pnpm dev

Open http://localhost:3000 to preview.

Environment Checklist

Strong admin password (16+ characters)
Unique encryption key (openssl rand -hex 32)
Unique session secret (openssl rand -hex 32)
SSL/TLS enabled (HTTPS)
Firewall configured (only expose 443)
Automated backups for data/ directory

On this page