aegis-bridge 2.17.2 → 2.17.4

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
@@ -298,6 +298,25 @@ AI orchestrators delegate coding tasks through Aegis — monitor progress, send
298
298
 
299
299
  Works with [OpenClaw](https://openclaw.ai), custom orchestrators, or any agent that can make HTTP calls.
300
300
 
301
+ ### Web Dashboard
302
+
303
+ Aegis ships with a built-in dashboard at `http://localhost:9100/dashboard/` — real-time session monitoring, activity streams, and health overview.
304
+
305
+ ```bash
306
+ npx aegis-bridge # visit http://localhost:9100/dashboard/
307
+ ```
308
+
309
+ ---
310
+
311
+ ## Security
312
+
313
+ Aegis includes built-in security defaults:
314
+
315
+ - **Permission mode** — `default` requires approval for dangerous operations (shell commands, file writes). Change with `permissionMode` when creating a session.
316
+ - **Hook secrets** — webhook and hook secrets are passed via headers (not query params) to prevent log leakage.
317
+ - **Auth tokens** — protect the API with `AEGIS_AUTH_TOKEN` (Bearer auth on all endpoints except `/v1/health`).
318
+ - **WebSocket auth** — session existence is not revealed before authentication.
319
+
301
320
  ---
302
321
 
303
322
  ## Configuration
@@ -309,6 +328,7 @@ Works with [OpenClaw](https://openclaw.ai), custom orchestrators, or any agent t
309
328
  | `AEGIS_PORT` | 9100 | Server port |
310
329
  | `AEGIS_HOST` | 127.0.0.1 | Server host |
311
330
  | `AEGIS_AUTH_TOKEN` | — | Bearer token for API auth |
331
+ | `AEGIS_PERMISSION_MODE` | default | `default`, `bypassPermissions`, `plan`, `acceptEdits`, `dontAsk`, `auto` |
312
332
  | `AEGIS_TMUX_SESSION` | aegis | tmux session name |
313
333
  | `AEGIS_TG_TOKEN` | — | Telegram bot token |
314
334
  | `AEGIS_TG_GROUP` | — | Telegram group chat ID |
@@ -318,6 +338,8 @@ Works with [OpenClaw](https://openclaw.ai), custom orchestrators, or any agent t
318
338
 
319
339
  ## Contributing
320
340
 
341
+ See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full guide — issue workflow, labels, commit conventions, and PR requirements.
342
+
321
343
  ```bash
322
344
  git clone https://github.com/OneStepAt4time/aegis.git
323
345
  cd aegis
@@ -353,6 +375,14 @@ src/
353
375
 
354
376
  ---
355
377
 
378
+ ## API Reference
379
+
380
+ Full API documentation is auto-generated with TypeDoc and published to GitHub Pages:
381
+
382
+ **<https://onestepat4time.github.io/aegis/>**
383
+
384
+ ---
385
+
356
386
  ## Support the Project
357
387
 
358
388
  <p align="center">