docs
This commit is contained in:
1 parent
d8ad1c44c5
commit
72fccc34f8
14 files changed
+811
-261
No files matched your search
+2
-2
@@ -2,7 +2,7 @@
|
||||
|
||||
skyg-linux-tracker (binary and CLI: `slinuxm`) is a read-only Linux system monitor in Rust, shipped as a single binary. It exposes systemd state, journald logs and Docker container state/logs over three surfaces that share one core: a **REST API**, an **MCP server** (Streamable HTTP) and **OpenTelemetry export**. Everything is read live from the source on every request. Nothing is collected or buffered, except a small SQLite database holding hashed API tokens.
|
||||
|
||||
User-facing usage is in [`README.md`](README.md). Work tracking is in [`TODO.md`](TODO.md). Per-workstream design logs from the original build and Phase 5 are archived in [`docs/workstreams/`](docs/workstreams/).
|
||||
User-facing docs start at [`README.md`](README.md) and the guides in [`docs/`](docs/README.md). Work tracking is in [`TODO.md`](TODO.md). Per-workstream design logs from the original build and Phase 5 are archived in [`docs/workstreams/`](docs/workstreams/).
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -214,7 +214,7 @@ All accepted. Rationale is kept; the build history is in [`docs/workstreams/`](d
|
||||
- **DEC-3 runtime queries.** `sqlx::query!` macros need `DATABASE_URL` at build time or a committed `.sqlx/` cache. With one table and about five queries, runtime `query`/`query_as` plus tests gives the same safety with no build-time DB.
|
||||
- **DEC-4 HTTP 401.** The MCP authorization spec puts auth at the HTTP layer and clients expect 401 with `WWW-Authenticate: Bearer`. One middleware gives the same response for `/api/v1` and `/mcp`; `AppError::Unauthorized` renders it.
|
||||
- **DEC-5 no subscriptions.** Subscriptions need change detection, i.e. background polling, which conflicts with "live reads only". Resources are resolved live on each read.
|
||||
- **DEC-6 Docker socket.** `docker` group membership is root-equivalent. The unit ships with `SupplementaryGroups=docker` commented out; the hardened setup points `sources.docker_socket` at a read-only socket proxy (see the README). No code change is needed either way. The NixOS module's `docker.enable` adds the group explicitly.
|
||||
- **DEC-6 Docker socket.** `docker` group membership is root-equivalent. The unit ships with `SupplementaryGroups=docker` commented out; the hardened setup points `sources.docker_socket` at a read-only socket proxy (see [docs/operations.md](docs/operations.md#docker-access)). No code change is needed either way. The NixOS module's `docker.enable` adds the group explicitly.
|
||||
- **DEC-7 metrics scope.** "Empty allowlist = all units" would export every loaded unit (often 300+ including devices and mounts), so empty means `*.service` and `*.timer`.
|
||||
- **DEC-8 Origin validation.** The P0 spike showed rmcp 3.5 validates both headers itself: `with_allowed_hosts` (default loopback names) and `with_allowed_origins` (default empty means off; requests without `Origin` always pass). No custom tower layer. Hosts: loopback names, `server.bind`, `server.allowed_hosts`. Origins: `http(s)://localhost:*`, `127.0.0.1:*`, `[::1]:*`, `<bind>:*` plus `server.allowed_origins`.
|
||||
- **DEC-9 defaults.** Binary and NixOS module both default to port 1984 and `bind = "127.0.0.1"` (the binary default was 9109 until 2026-10-16). LAN exposure is an install-time choice: set `bind`, `openFirewall` or an interface-scoped rule, and `allowedHosts`.
|
||||
|
||||
Reference in new issue
Block a user