Getting started with CompassDocs

Updated

Install CompassDocs with one command, choose the edition that suits you, and find the full product documentation.

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

Runbash
curl -fsSL https://raw.githubusercontent.com/mattny20/CompassDocs/main/install.sh | bash
Runbash
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.

Want your own domain with HTTPS from day one?

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>:3000 on 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?

CommunityEnterprise
PriceFree and open source (AGPL-3.0)$499.99 a year per install, unlimited users
HostingYou run itYou run it
Core knowledge base, AI search, roles and approvals, backupsYesYes
SSO, SCIM, Microsoft 365 directory sync, read confirmations, training, helpdesk, audit-log exportNoYes

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.

Where to find the full documentation

Still need help?

Raise a request and we'll get back to you by email.

New request