Skip to main content

Self-Hosting

Self-hosting Compass means running it on a server you control instead of using app.compasscalendar.com.

Start with Run Compass on a server. It walks through a small VPS setup with your own domain, HTTPS, and the Compass services running behind Caddy.

If you only want to run Compass on your own computer, use the normal local development flow with Bun instead of the self-host installer. See Run Compass without the installer.

What Compass is made of​

When you self-host Compass on a server, you get a stack of small services. Only the public website and API are reachable from your browser. The databases stay private inside Docker.

Start here​

What you still need to handle yourself​

These docs keep the default self-host path focused on a small server. They do not set up:

  • a built-in backup scheduler
  • an automatic restore flow
  • a rollback command for ./compass update
  • Docker backups for browser IndexedDB data
  • automatic Google Calendar watch maintenance (see Google Calendar)

Have an idea on how we can make self-hosting easier? Let us know in this GitHub Discussion.