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
| Requirement | Minimum | Recommended |
|---|---|---|
| Node.js | 20.0+ | 22.x LTS |
| RAM | 512 MB | 2 GB+ |
| Disk | 200 MB | 1 GB+ |
| OS | Any with Node.js | Ubuntu 22.04+ |
One-Line Install
Best for most people:
curl -fsSL https://overseer.sh/install | bashThis script will:
- check your machine for the basics
- download Overseer
- install everything it needs
- help you create your config
- create the local database
- 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 install2. Environment Configuration
cp .env.example .envNow open .env and fill in your values. If you want the smallest setup, start with:
ADMIN_USERNAMEADMIN_PASSWORDENCRYPTION_KEYSESSION_SECRET- one AI provider key, such as
OPENAI_API_KEY
See Quick Start for the shortest version.
3. Database Setup
pnpm run db:init4. 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 botsDocker Installation
Docker is useful if you already prefer containers. If not, the normal install is easier.
Development
docker compose -f docker-compose.dev.yml upProduction
docker compose up -dSystemd 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-discordUpdating
cd overseer
git pull
pnpm install
pnpm build
# Restart servicesAlways back up your data/ directory before updating. That folder contains
important local app data.