You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/self-hosting/README.md
-36Lines changed: 0 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,6 @@
2
2
3
3
Self-hosting Compass means running it on a computer you control instead of using `app.compasscalendar.com`.
4
4
5
-
The supported path today is **local Docker self-hosting**: install on your Mac or Linux machine, open the web app at `http://localhost:9080`, sign up with email and password. Google Calendar is optional.
6
-
7
5
## What Compass is made of
8
6
9
7
When you run the installer, you get a stack of small services on your machine. Only the web app and backend API are reachable from your browser. The rest stay private inside Docker.
@@ -26,19 +24,6 @@ flowchart TD
26
24
supertokens -->|Docker volume| postgres
27
25
```
28
26
29
-
Two important things this picture doesn't show:
30
-
31
-
-**Your tasks live in your browser**, not in Mongo. They're stored in IndexedDB. Docker volume backups do not include them.
32
-
-**The installer creates a folder at `~/compass`** to hold your `.env` file, the helper script, and the app source. That folder is the only thing on your machine the installer touches outside Docker.
33
-
34
-
## Three flavors of self-hosting
35
-
36
-
Most people want the first one. Pick based on where you want Compass to live and whether you want Google Calendar.
37
-
38
-
-**On your laptop, no Google.** The default. Run the installer, open `localhost:9080`, sign up with email and password. This is the recommended path.
39
-
-**On your laptop, with Google sign-in or import.** Same install, plus your own Google OAuth client added to `~/compass/.env`. Continuous Google Calendar sync (Google pushing changes to Compass) needs a public HTTPS URL, so it isn't part of this path.
40
-
-**On a public server.** A VPS with Docker, your own domain, and Caddy in front for HTTPS. More setup, more responsibility. Use this when you want Compass reachable from anywhere or want to set up Google Calendar sync.
41
-
42
27
## Start here
43
28
44
29
For the localhost guide, including what to expect, how to manage the install,
@@ -47,27 +32,6 @@ and troubleshooting, read [Local quickstart](./local-quickstart.md).
47
32
If you want Compass on a VPS with your own domain, read
48
33
[Server hosting guide](./server-guide.md).
49
34
50
-
## Choose a guide
51
-
52
-
| Guide | Use it when |
53
-
| --- | --- |
54
-
|[Local quickstart](./local-quickstart.md)| You want the recommended local Docker install on your own Mac or Linux machine. |
55
-
|[Backups and restore](./backups-and-restore.md)| You want to preserve or restore signed-in event data and auth data. |
56
-
|[Google Calendar](./google-calendar.md)| You want to understand no-Google mode, optional local Google OAuth/import, or public HTTPS Google watch notifications. |
57
-
|[Server hosting guide](./server-guide.md)| You want to serve Compass from a public domain with Docker Compose and Caddy. |
58
-
|[Advanced manual setup](./advanced-manual.md)| You want to run the pieces yourself instead of using the installer. |
59
-
60
-
## Keep `.env` with your data
61
-
62
-
`~/compass/.env` holds the generated passwords and tokens that match your
63
-
Docker volumes. If the volumes stay but `.env` is gone, a new install creates
64
-
different credentials and can lock you out of the old data.
65
-
66
-
Before `./compass update` or anything that touches the install, back up
67
-
`~/compass/.env`, the Mongo volume, and the SuperTokens Postgres volume together.
68
-
They're a set. See [Backups and restore](./backups-and-restore.md).
69
-
Browser IndexedDB data (tasks, pre-signup events) is not included.
70
-
71
35
## What you still need to handle yourself
72
36
73
37
These docs keep the default path focused on local Docker self-hosting. They do not set up:
0 commit comments