@ainyc/canonry 1.15.2 → 1.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -46,8 +46,8 @@ All commands support `--format json` for machine-readable output.
46
46
  canonry init [--force] # Initialize config and database (interactive)
47
47
  canonry init --gemini-key <key> # Initialize non-interactively (flags or env vars)
48
48
  canonry bootstrap [--force] # Bootstrap config/database from env vars only
49
- canonry serve [--port 4100] # Start server in foreground (API + web dashboard)
50
- canonry start [--port 4100] # Start server as a background daemon
49
+ canonry serve [--port 4100] [--base-path /prefix/] # Start server (foreground)
50
+ canonry start [--port 4100] [--base-path /prefix/] # Start server (background daemon)
51
51
  canonry stop # Stop the background daemon
52
52
  canonry settings # View active provider and quota settings
53
53
  ```
@@ -309,7 +309,21 @@ pnpm run lint
309
309
  pnpm run dev:web # Run SPA in dev mode
310
310
  ```
311
311
 
312
- ## Docker Deployment
312
+ ## Deployment
313
+
314
+ See **[docs/deployment.md](docs/deployment.md)** for the full guide — local, reverse proxy (Caddy/nginx), sub-path, Tailscale, systemd, and Docker.
315
+
316
+ ### Sub-path deployments
317
+
318
+ Serve canonry under a URL prefix without rebuilding:
319
+
320
+ ```bash
321
+ canonry serve --base-path /canonry/
322
+ ```
323
+
324
+ The server injects the base path at runtime — no build-time config needed.
325
+
326
+ ### Docker Deployment
313
327
 
314
328
  Canonry currently deploys as a **single Node.js service with a SQLite file on persistent disk**.
315
329