@peterwangze/claude-trigger-router 1.1.1 → 1.2.0

package/docs/server-maintainer-guide.md

@@ -0,0 +1,81 @@
+# Server maintainer guide
+
+This guide is for the person who owns a self-hosted Claude Trigger Router server.
+
+If you are choosing between local use, server maintenance and remote service use, start with `docs/configuration-roles.md`.
+
+## 1. Prepare the server profile
+
+```bash
+ctr deploy init --target server
+```
+
+Fresh machines can also run `ctr setup` and choose `部署为远程服务端`; setup writes the same server profile shape and intentionally does not start the service.
+
+The command creates a server-oriented config with:
+
+- `HOST: "0.0.0.0"`
+- `Runtime.mode: "server"`
+- a bootstrap `APIKEY`
+- logging enabled
+- editable `Models` and `Router.default`
+
+Edit `Models[].key`, `Models[].api`, `Models[].interface` and `Models[].model` before exposing the service.
+
+## 2. Diagnose and start
+
+```bash
+ctr doctor
+ctr start --daemon
+ctr status
+```
+
+`ctr status` and `ctr doctor` should show:
+
+- current role: `server (router_service)`
+- listener: `0.0.0.0:<port>` or the host you configured
+- auth state: bootstrap and active managed key counts
+- remote client connection hint: `ANTHROPIC_BASE_URL=http://<server-host>:<port>`
+
+## 3. Issue client keys
+
+Keep the bootstrap `APIKEY` for service owners. Use it only to open `/ui`, save config, and manage auth.
+
+Create a managed key for remote users:
+
+```text
+POST /api/auth/keys
+```
+
+Recommended remote-user scopes:
+
+```json
+["client", "read-only"]
+```
+
+`client` allows model calls. `read-only` allows ready/status checks such as `/api/health`, `/api/service-info`, compiled model summaries and governance GET endpoints. `operator` is for day-to-day maintenance writes such as restart, governance snapshots, schedules, anomaly thresholds and archive deletion; it cannot read or save config and cannot manage auth keys. Generated secrets are returned once.
+
+## 4. Expose safely
+
+Prefer one of these deployment envelopes:
+
+- `config/deploy/docker-compose.server.yaml`
+- `config/deploy/systemd/claude-trigger-router.service`
+
+Before exposing the service to other machines:
+
+- keep auth enabled with bootstrap or active managed keys
+- put public deployments behind HTTPS reverse proxy or private network access
+- give remote users managed `client + read-only` keys, not admin/bootstrap keys
+
+## 5. Daily maintenance
+
+Use:
+
+```bash
+ctr status
+ctr doctor
+ctr ui
+```
+
+`ctr ui` opens the workbench. The maintainer area shows security status, auth scope guidance, quota usage, governance health and routing outcome summaries.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peterwangze/claude-trigger-router",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Intelligent trigger-based router for Claude Code with automatic task type detection and model routing",
   "bin": {
     "ctr": "dist/cli.js"
@@ -8,6 +8,7 @@
   "files": [
     "dist",
     "config",
+    "docs/*.md",
     "README.md"
   ],
   "repository": {