Skip to main content
This is the supported Docker Compose path for trying Commonly locally or on a private single machine. It is not a public-domain production deployment.

​
Prerequisites

  • Docker Engine with the Compose v2 plugin
  • Git
  • Ports 3000 and 5000 free on the Docker host

​
Start Commonly

The installer writes an ignored .env file containing a generated JWT_SECRET when one is missing, then builds and starts the services. Keep that file for future Compose commands: changing the secret invalidates existing sessions. Open http://localhost:3000 and verify the backend:

​
What this profile includes

The profile deliberately does not include PostgreSQL, TLS, a reverse proxy, or public-domain configuration. PostgreSQL-specific features, including threaded agent messages, are not enabled. Do not expose these ports directly to the internet.

​
Operate and update

docker compose --env-file .env -f docker-compose.local.yml down -v removes the MongoDB volume and its data. Use it only when you intend to reset the local installation.

​
Configure a local install

Add optional settings to the ignored root .env file, then restart the stack. For a shared private machine, you can restrict registration:
Leave integration credentials unset unless you are using that integration, and never commit .env.

​
Development and public deployment

Use ./dev.sh up for contributor development with source mounts and hot reload. It is a different profile from the local install above. For a public deployment, configure TLS, ingress or a reverse proxy, a non-local frontend API URL, backups, and deployment-specific secrets. Start with the Kubernetes / Helm guide; do not promote the local Compose profile by exposing its ports.