CompassDocsOwn your knowledge base. Run it anywhere.
One command starts CompassDocs and its PostgreSQL database with Docker—then a browser wizard gets you going. No accounts, no lock-in, AGPL-3.0.
Run one command
With Docker installed, the installer starts CompassDocs and PostgreSQL together and generates strong passwords for you.
Open & set up
Visit localhost:3000 and the setup wizard has you create your admin account right in the browser—no password to look up.
Add your team
Create users and assign roles—Viewer, Editor, Approver, Admin—from the Settings console.
Make it yours
Set your name, logo, theme, and timezone, add your own domain, and turn on AI answers.
$ curl -fsSL https://raw.githubusercontent.com/mattny20/CompassDocs/main/install.sh | bash ✓ Fetched docker-compose.yml ✓ Generated .env with fresh secrets ▲ CompassDocs running at http://localhost:3000 → open the URL to create your admin account
Prefer to run it with Node.js and your own Postgres, or want the full configuration reference? Read the documentation →
Multi-arch images, native everywhere.
Docker pulls the right image for your host automatically. Not on Docker? It’s a standard Next.js server plus PostgreSQL.
| Architecture | Runs on |
|---|---|
| x86-64 (amd64) | Intel / AMD servers, desktops, most cloud VMs |
| ARM64 (aarch64) | Apple Silicon, AWS Graviton, Ampere, Raspberry Pi 4/5 Community image is native ARM64; the Enterprise image is amd64 today (runs emulated, native build planned). |
| Deployment | Requirements |
|---|---|
| Docker (recommended) | Any Linux host; macOS & Windows via Docker Desktop |
| Manual | Node.js 20+ and PostgreSQL 14+ on any OS |
Production essentials, no add-ons.
The operational features a self-hosted knowledge base needs—configured from the admin console, not config files.
Custom domain & HTTPS
A built-in Caddy proxy serves your domain with automatic Let’s Encrypt certificates, self-signed, or bring-your-own—set from the UI.
Backups & restore
Scheduled full-database backups with retention and one-click restore, mirrored off-site to S3, R2, MinIO, or Azure.
Attachments
File attachments and inline images with a configurable size limit, stored on a persistent volume.
Effortless updates
docker compose pull && up -d. The app migrates its own schema on start—no manual steps.
Setup wizard
A fresh install walks you through creating the first admin in the browser—no default password to change.
PostgreSQL storage
Everything—docs, versions, users, settings—lives in one Postgres database you control and can back up.
Deploy to Azure
Prefer the cloud? A one-click Azure portal wizard provisions the VM, networking, and storage—every size and option under your control. Azure guide →
Public site, when you want it
Serve chosen spaces to the internet as a read-only help center—off by default, one switch to enable.
Monitoring built in
Liveness & readiness probes, a Prometheus /metrics endpoint, a live diagnostics panel, and JSON logs—on-call ready with no sidecars. Monitoring guide →
Spin it up in about two minutes.
Everything you need is in the docs—install, custom domains, backups, and the full environment reference.