Skip to content

Commit 198fee9

Browse files
authored
docs(self-host): add backup-restore doc (#1795)
* docs: update URLs and simplify bun commands in documentation * docs: improve backup-and-restore guide with verification and rehearsal steps
1 parent 58f2444 commit 198fee9

8 files changed

Lines changed: 268 additions & 80 deletions

File tree

AGENTS.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Defaults
44

5-
- Frontend-only work usually starts with `bun run dev:web`; it does not require
5+
- Frontend-only work usually starts with `bun dev:web`; it does not require
66
backend services.
77
- Backend, auth, MongoDB, Google sync, and SSE work require
88
a `compass.yaml` at the repo root. Bootstrap with:
@@ -13,33 +13,33 @@ cp compass.example.yaml compass.yaml
1313

1414
- `compass.yaml` contains secrets. Do not commit it.
1515

16-
- Avoid defaulting to `bun run test`; use the focused package test first.
16+
- Avoid defaulting to `bun test`; use the focused package test first.
1717
- Formatting is handled by the repo-local Codex Stop hook after each agent turn.
18-
- Use `bun run lint` and relevant verification before push or handoff.
18+
- Use `bun lint` and relevant verification before push or handoff.
1919

2020
## Commands
2121

2222
```bash
2323
bun install
24-
bun run dev:web
25-
bun run dev:backend
26-
bun run test:core
27-
bun run test:web
28-
bun run test:backend
29-
bun run test:scripts
30-
bun run type-check
31-
bun run lint
32-
bun run lint:fix
24+
bun dev:web
25+
bun dev:backend
26+
bun test:core
27+
bun test:web
28+
bun test:backend
29+
bun test:scripts
30+
bun type-check
31+
bun lint
32+
bun lint:fix
3333
```
3434

3535
Validation defaults:
3636

37-
- Core: `bun run test:core`
38-
- Web: `bun run test:web`
39-
- Backend: `bun run test:backend`
40-
- Scripts: `bun run test:scripts`
37+
- Core: `bun test:core`
38+
- Web: `bun test:web`
39+
- Backend: `bun test:backend`
40+
- Scripts: `bun test:scripts`
4141
- Shared contracts/cross-package behavior: affected package tests plus
42-
`bun run type-check`
42+
`bun type-check`
4343
- Keep regression tests that protect real behavior. Remove temporary tests,
4444
scripts, debug hooks, or code added only to confirm a one-time hypothesis once
4545
that verification is complete.

docs/development/hosting-modes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ When you are debugging anything storage-, auth-, or sync-related, the first ques
2020

2121
| Hosting context | Account state | Calendar/event data location |
2222
| ---------------- | ------------- | ---------------------------- |
23-
| Compass Cloud (`app.compasscalendar.com`) | Anonymous | Browser IndexedDB |
24-
| Compass Cloud (`app.compasscalendar.com`) | Signed in | Compass backend -> Compass MongoDB |
23+
| Compass Cloud (`compasscalendar.com`) | Anonymous | Browser IndexedDB |
24+
| Compass Cloud (`compasscalendar.com`) | Signed in | Compass backend -> Compass MongoDB |
2525
| Self-hosted | Anonymous | Browser IndexedDB |
2626
| Self-hosted | Signed in | Operator backend -> configured MongoDB |
2727

@@ -35,7 +35,7 @@ The lightest state. Useful for trying Compass without creating an account.
3535
- events and tasks live in the browser's IndexedDB
3636
- calendar and task data never leave the browser
3737

38-
This is the same story everywhere: on [app.compasscalendar.com](https://app.compasscalendar.com) and on a self-hosted install before the user signs up. The web app might be served from Compass Cloud or from a self-hosted server, but either way, anonymous calendar and task data stay in the browser.
38+
This is the same story everywhere: on [compasscalendar.com](https://compasscalendar.com) and on a self-hosted install before the user signs up. The web app might be served from Compass Cloud or from a self-hosted server, but either way, anonymous calendar and task data stay in the browser.
3939

4040
## Self-Hosted Account Mode
4141

@@ -51,7 +51,7 @@ For the runtime env and required variables, see [Local Development](./local-deve
5151

5252
## Hosted Compass Cloud Account Mode
5353

54-
The signed-in state on the managed product at [app.compasscalendar.com](https://app.compasscalendar.com).
54+
The signed-in state on the managed product at [compasscalendar.com](https://compasscalendar.com).
5555

5656
- Compass-operated backend
5757
- Compass-owned MongoDB and SuperTokens configuration

docs/self-hosting/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Self-Hosting
22

3-
Self-hosting Compass means running it on a server you control instead of using `app.compasscalendar.com`.
3+
You can run Compass on infrastructure you control instead of using the hosted version on `compasscalendar.com`
44

5-
Start with [Run Compass on a server](./server-guide.md). It walks through a small VPS setup with your own domain, HTTPS, and the Compass services running behind Caddy.
5+
Start with [Run Compass on a server](./server-guide.md). It walks through a small VPS setup with your own domain, HTTPS, and the Compass services running behind a reverse proxy.
66

7-
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](./advanced-manual.md).
7+
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.
88

99
## What Compass is made of
1010

@@ -33,7 +33,7 @@ flowchart TD
3333
## Start here
3434

3535
- New self-host install: [Run Compass on a server](./server-guide.md)
36-
- Backups and restore: [Back up and restore your data](./backups-and-restore.md)
36+
- Backups and restore: [Back up and restore your data](./backup-and-restore.md)
3737
- Google Calendar: [Add Google Calendar](./google-calendar.md)
3838
- Manual Bun setup: [Run Compass without the installer](./advanced-manual.md)
3939
- Monitoring: [Monitoring](./monitoring.md)

0 commit comments

Comments
 (0)