Quick Start
The easiest way to get Overseer working, written for first-time users.
Quick Start
This page is for people who want the shortest path from “nothing installed” to “I can chat with Overseer”.
If you are not technical, start here.
What you are setting up
By the end of this guide, you will have:
- the Overseer web dashboard running
- an admin login you can use in the browser
- at least one AI provider connected
- optional Telegram or Discord chat later if you want it
Before You Begin
You do not need Telegram or Discord to try Overseer.
The web chat works on its own. Bots are optional.
Prerequisites
If you only want to use the web chat, you can skip Telegram and Discord for now.
Installation
curl -fsSL https://overseer.sh/install | bashThis is the easiest option. It clones the project, installs dependencies, and walks you through setup.
Minimum Configuration
If you want the smallest possible setup, fill in these first:
# Admin Credentials
ADMIN_USERNAME=admin
ADMIN_PASSWORD=your-secure-password
# Security Keys (generate with: openssl rand -hex 32)
ENCRYPTION_KEY=your-64-char-hex-key
SESSION_SECRET=your-session-secret
# Telegram Bot (optional)
TELEGRAM_BOT_TOKEN=123456:ABC-DEF...
TELEGRAM_ALLOWED_USERS=123456789
# Discord Bot (optional)
DISCORD_BOT_TOKEN=your-discord-token
DISCORD_ALLOWED_GUILDS=server-id
# Default LLM Provider
DEFAULT_PROVIDER=openai
DEFAULT_MODEL=gpt-4o
OPENAI_API_KEY=sk-...You can add Telegram and Discord later. They are optional.
Start Services
# Web Dashboard (http://localhost:3000)
pnpm dev
# Telegram + Discord bots (separate terminal)
pnpm bots:devOpen the App
Open http://localhost:3000 in your browser and log in with your admin username and password.
First Things To Click
Open http://localhost:3000 and sign in with the admin username and password you set.
Go to Settings → Providers and add at least one provider such as OpenAI, Anthropic, or Google.
Go back to the main chat screen and send a simple message like “What can you do?” or “Explain this server.”
Telegram and Discord can be configured later in Settings → Interfaces.
If something feels confusing, skip ahead to the User Guide after setup. It explains the interface in plain language.
Want to publish the docs site on Vercel? See Deployment — Deploy the docs on Vercel.