CompassDocs is a team knowledge base you run on your own server. This article gets you from nothing to a working install in a few minutes.
Before you start
You need Docker with Docker Compose v2 (the
docker compose command). Docker Desktop includes both. Linux is recommended for production; macOS and Windows work through Docker Desktop.
Install with one command
curl -fsSL https://raw.githubusercontent.com/mattny20/CompassDocs/main/install.sh | bash
curl -fsSL https://raw.githubusercontent.com/mattny20/CompassDocs/main/install.sh | COMPASSDOCS_EDITION=enterprise bash
The installer creates a ./compassdocs folder with a docker-compose.yml and a .env, pulls the image and starts the app with its PostgreSQL database.
Add COMPASSDOCS_TLS=1 before bash (for example | COMPASSDOCS_TLS=1 bash). You then enter your domain and HTTPS mode in the setup wizard.
Finish setup in your browser
- Open
http://localhost:3000 (or
http://<server-ip>:3000on a remote server, with the port allowed through your firewall). - Enter the setup token. From your install folder, run
docker compose logs app | grep -i 'setup token'to find it. - Create your admin account. You can also add your company name and, on the Enterprise image, your licence key.
- Add everyone else from Settings → Users.
Which edition is right for you?
| Community | Enterprise | |
|---|---|---|
| Price | Free and open source (AGPL-3.0) | $499.99 a year per install, unlimited users |
| Hosting | You run it | You run it |
| Core knowledge base, AI search, roles and approvals, backups | Yes | Yes |
| SSO, SCIM, Microsoft 365 directory sync, read confirmations, training, helpdesk, audit-log export | No | Yes |
The Enterprise image without a licence key behaves exactly like Community, so you can switch later without losing anything. CompassDocs Cloud, a fully managed option, is coming soon.