Overseer Docs

Installation

Step-by-step installation guide with plain-language explanations.

Installation

This page explains all supported installation options in a slower, more detailed way than the Quick Start.

If you are unsure, use the One-Line Install option first.

System Requirements

RequirementMinimumRecommended
Node.js20.0+22.x LTS
RAM512 MB2 GB+
Disk200 MB1 GB+
OSAny with Node.jsUbuntu 22.04+

One-Line Install

Best for most people:

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

This script will:

  1. check your machine for the basics
  2. download Overseer
  3. install everything it needs
  4. help you create your config
  5. create the local database
  6. get the app ready to start

Manual Installation

Best if you prefer seeing each step yourself.

1. Clone & Install

git clone https://github.com/Quad-Labs-LLC/overseer.git
cd overseer
pnpm install

2. Environment Configuration

cp .env.example .env

Now open .env and fill in your values. If you want the smallest setup, start with:

  • ADMIN_USERNAME
  • ADMIN_PASSWORD
  • ENCRYPTION_KEY
  • SESSION_SECRET
  • one AI provider key, such as OPENAI_API_KEY

See Quick Start for the shortest version.

3. Database Setup

pnpm run db:init

4. Start Services

# Development mode
pnpm dev          # Web dashboard
pnpm bots:dev     # Telegram + Discord bots (optional)

# Production mode
pnpm build
pnpm start        # Web dashboard
pnpm bots         # Chat bots

Docker Installation

Docker is useful if you already prefer containers. If not, the normal install is easier.

Development

docker compose -f docker-compose.dev.yml up

Production

docker compose up -d

Systemd Services (Linux)

Use this if you are deploying Overseer on a Linux server and want it to start automatically after a reboot.

# Copy service files
sudo cp systemd/*.service /etc/systemd/system/

# Edit configuration
sudo systemctl edit overseer

# Enable and start
sudo systemctl enable --now overseer
sudo systemctl enable --now overseer-discord

Updating

cd overseer
git pull
pnpm install
pnpm build
# Restart services

Always back up your data/ directory before updating. That folder contains important local app data.

On this page