Skip to content

Commit 2135a80

Browse files
committed
docs(config): document monitor and control FIRMA_CONFIG binding
The monitor flags table said --config does not participate in resolution and listed no env var; control's section omitted it entirely. Both now bind FIRMA_CONFIG and select the config used for audit-log and policy discovery, failing closed on an unreadable file. Mirror the doctor guide's table.
1 parent 6e4039f commit 2135a80

1 file changed

Lines changed: 15 additions & 10 deletions

File tree

docs-site/src/content/docs/guides/manage-the-stack.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -227,16 +227,16 @@ firma monitor --state-dir /var/run/firma \
227227

228228
`monitor` flags:
229229

230-
| Flag | Default | Description |
231-
| ---------------- | -------- | -------------------------------------------------------- |
232-
| `--config` | _unset_ | Does not participate in state-directory resolution. |
233-
| `--state-dir` | resolved | State dir override. |
234-
| `--source` | `audit` | `audit`, `authority`, `sidecar`, or `all`. |
235-
| `--no-follow` | _off_ | Read once and exit; default is to follow tail. |
236-
| `--decision` | _unset_ | Audit-only: `allow`, `deny`, `passthrough`. |
237-
| `--action-class` | _unset_ | Audit-only: exact match on `intent.action_class`. |
238-
| `--since` | _unset_ | Backfill window: `15m`, `2h`, `1d` or RFC3339 timestamp. |
239-
| `--format` | `pretty` | `pretty` (human) or `json` (one object per line). |
230+
| Flag | Env | Default | Description |
231+
| ---------------- | --------------- | ---------- | --------------------------------------------------------------------------------------------------- |
232+
| `--config` | `FIRMA_CONFIG` | discovered | Unified `firma.toml` used to discover the audit log. When set, the file must load or `monitor` fails closed; it is not consulted once `--state-dir` is given. |
233+
| `--state-dir` | `FIRMA_STATE_DIR` | resolved | State dir override. |
234+
| `--source` | | `audit` | `audit`, `authority`, `sidecar`, or `all`. |
235+
| `--no-follow` | | _off_ | Read once and exit; default is to follow tail. |
236+
| `--decision` | | _unset_ | Audit-only: `allow`, `deny`, `passthrough`. |
237+
| `--action-class` | | _unset_ | Audit-only: exact match on `intent.action_class`. |
238+
| `--since` | | _unset_ | Backfill window: `15m`, `2h`, `1d` or RFC3339 timestamp. |
239+
| `--format` | | `pretty` | `pretty` (human) or `json` (one object per line). |
240240

241241
`--decision` and `--action-class` apply to audit events only — they
242242
are silently ignored for `authority` and `sidecar` log lines. The
@@ -250,6 +250,11 @@ tailer detects log rotation by inode and reopens automatically.
250250
firma control --config .firma/firma.toml
251251
```
252252

253+
`--config` is bound to `FIRMA_CONFIG`; when omitted it follows the shared
254+
[configuration resolution](https://github.com/Firma-AI/openfirma/blob/main/docs/configuration.md#configuration-resolution)
255+
model (`FIRMA_CONFIG`, then the nearest `.firma/firma.toml`). A selected file
256+
that cannot load fails closed.
257+
253258
The policy pane reads Cedar files from the Authority policy directory in
254259
`firma.toml`. Any policy with an `@id(...)` annotation is shown as a row:
255260

0 commit comments

Comments
 (0)