Skip to content

Commit aaa629b

Browse files
committed
update readme
1 parent 832e74b commit aaa629b

7 files changed

Lines changed: 71 additions & 394 deletions

File tree

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ FOCUS_COMPASS_IMAGE=ghcr.io/focus-compass/focus-compass-sync-server:latest
66
# Optional: strong random token.
77
# If omitted, the server starts in setup mode and the first visit to '/' can
88
# generate a token that will be persisted to ./data/auth.json.
9-
HOCUSPOCUS_TOKEN=
9+
ACCESS_TOKEN=
1010

1111
# Optional: MCP token (read-only MCP access via POST /mcp).
1212
# If omitted, MCP starts disabled. Enable it from the admin UI (/) to generate

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Hocuspocus/Yjs with SQLite persistence.
88
- Entrypoint: `src/server.js`
99
- Persistence: SQLite file at `DB_PATH` (default `./data/db.sqlite`)
1010
- Images: files under `IMAGES_DIR` (default `./data/images`) plus `*.meta.json`
11-
- Auth: Bearer token (`HOCUSPOCUS_TOKEN`) for WebSocket + all REST endpoints
11+
- Auth: Bearer token (`ACCESS_TOKEN`) for WebSocket + all REST endpoints
1212

1313
## Commands
1414
Local (no build step; plain Node runtime):
@@ -27,7 +27,7 @@ Docker:
2727

2828
Smoke checks:
2929
- `curl http://localhost:8080/health`
30-
- `curl -H "Authorization: Bearer $HOCUSPOCUS_TOKEN" http://localhost:8080/api/images`
30+
- `curl -H "Authorization: Bearer $ACCESS_TOKEN" http://localhost:8080/api/images`
3131
- Admin UI: `http://localhost:8080/`
3232

3333
### Tests
@@ -61,7 +61,7 @@ Smoke checks:
6161
- Do not commit secrets: `.env` is gitignored (see `.gitignore`).
6262
- Do not commit runtime data: `data/`, `*.sqlite`, backups, images are ignored.
6363
- Auth constraints (enforced in `src/server.js`):
64-
- If `HOCUSPOCUS_TOKEN` is not set, the server starts in setup mode and the first
64+
- If `ACCESS_TOKEN` is not set, the server starts in setup mode and the first
6565
visit to `/` can generate a token that is persisted to `AUTH_FILE_PATH` (default `./data/auth.json`).
6666

6767
## Code Style Guidelines

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Requires Node.js >= 24.0.0. Uses ES modules (`"type": "module"`).
5454

5555
```bash
5656
PORT=8080 # Server port
57-
HOCUSPOCUS_TOKEN=your-secret-token # Bearer token for auth
57+
ACCESS_TOKEN=your-secret-token # Bearer token for auth
5858
DB_PATH=./data/db.sqlite # SQLite database path
5959
IMAGES_DIR=./data/images # Image storage directory
6060
BACKUP_DIR=./data/backups # Backup directory

0 commit comments

Comments
 (0)