## Summary axe reports `empty-table-header` on 116 generated CLI reference pages and several hand-written pages: a header cell with no text is announced by screen readers as an unnamed column. This PR gives every table header cell in `docs/` text, and adds a lint check so empty header cells can't come back. ## How to review this PR - `docs/reference/cli/`: 116 files, these all generate identically, so I would only spot check 2-3 of them and skip the rest - `docs/*` outside of `docs/reference/cli/`: 6 files, normal review of these - `scripts`: 5 files, code review of the Bash and Go files to make sure we're properly inserting headers into each table ## What changed **Generator.** `scripts/clidocgen` wrote an empty header row (`| | |`) over each option's metadata table (Type, Environment, YAML, Default). It now writes `| Property | Value |`. Subcommand tables already had `Name | Purpose` and are unchanged. Regenerated with `make docs/reference/cli/index.md`: 116 files under `docs/reference/cli/` change. The header rows change, and the body rows of each option table are re-padded to the wider first column; the content is otherwise identical. Every option on those 116 pages now shows a visible `Property | Value` header row above Type, Environment, YAML, and Default, so this is a visual change on the docs site as well as a screen reader one. The CLI's own `--help` output doesn't use this template, so it's unchanged. **Audit logs.** `docs/admin/security/audit-logs.md` already has `Field | Tracked` headers on `main` (the generator writes them), so there was nothing to change there; the live-site finding predates that. **Hand-written tables.** - `docs/admin/networking/port-forwarding.md`: the CORS matrix had three empty spanning corner cells. The corner now reads `From user` and `From workspace` (spanning the three row-header columns, beside the Alice/Bob and Workspace rows) and `To user`, `To workspace`, `To app` (over the three row-header columns). The grid is still 3 header rows by 7 columns. The From cells have `scope="row"` and the other header-row cells `scope="col"`, so the From labels don't become column headers for the body's label columns; the body's user, workspace, and app labels are `<th scope="row">`; and a `<caption>` says columns are the origin and rows the destination. - `groups-roles.md`, `airgap.md`, `scale-testing.md`, `workspace-tags.md`: these four corner cells are already filled by #30873. The new check would fail CI without them, so this PR carries the same four lines, byte-identical to #30873 (`Permission`, `Component`, `Scenario`, `Input`), so whichever PR merges second rebases without conflict. If #30873 merges first, these hunks drop out. **New check.** `scripts/docshtmlcheck` (`make lint/docs-html`, part of `make lint`) now also reports `empty-table-header`. I put it there because that checker already parses every Markdown file under `docs/`, generated pages included, with goldmark and tokenizes raw HTML with `golang.org/x/net/html`, and it already runs in CI. A markdownlint custom rule would have needed a new JS rule and HTML parsing there. - Markdown pipe tables: the header row, via goldmark's GFM table extension. - Raw HTML tables: every `<th>`, tracked across HTML blocks, with entities decoded and whitespace trimmed, so `<th></th>`, `<th> </th>`, and `<th><br></th>` are all reported. Markdown between the HTML blocks of an open `<th>` counts as its text. Tables in code blocks are ignored. - Output: `docs/x.md:29: empty-table-header: header cell 1 has no text (table's first header "Auditor")`, plus a summary footer. - The tokenizer loop moved out of `scanNode` into a shared `tokenizeSegments` helper so both checks use it; `scanNode`'s behavior is unchanged. - The style guide's checks table gets one row; the README for the checker describes the rule. ## Testing - Tests first: `TestCheckTables` (now 22 cases) and `TestRunEmptyTableHeader` failed against a stub, then pass. The existing `docshtmlcheck` tests pass unchanged. - `go run ./scripts/docshtmlcheck` on `main` reports 1,561 empty header cells (116 CLI pages, port-forwarding, and the four #30873 tables); on this branch it reports none. - `go test ./scripts/docshtmlcheck/ ./scripts/clidocgen/ ./scripts/docgenenv/`, golangci-lint on the changed packages, `make lint/docs-html lint/docs-manifest lint/docs-gen-filter lint/emdash`, `pnpm run check-docs`, and Vale on the changed hand-written pages all pass. - `make gen` couldn't run to completion locally (no `protoc-gen-go`); CI's gen check covers it. The CLI pages were regenerated with the repo's own target. Review feedback applied incfd29a2160(entities decoded in Markdown text, image alt text and autolinks count as text),709a58f603(per-kind counts, finding order, CLI generator note),8e61ff3afa(CORS matrix scopes and caption), andb807bcbbc7and2871f89bdf(style guide rule section, `make lint/docs-html` in the checks table, coverage counts). Linear: DOCS-1308 --- 🤖 Built with AI assistance.
173 lines
6.0 KiB
Markdown
Generated
173 lines
6.0 KiB
Markdown
Generated
---
|
|
# Code generated by make gen. DO NOT EDIT.
|
|
title: "`coder agent-firewall`"
|
|
description: Network isolation tool for monitoring and restricting HTTP/HTTPS requests.
|
|
---
|
|
|
|
<!-- DO NOT EDIT | GENERATED CONTENT -->
|
|
|
|
Network isolation tool for monitoring and restricting HTTP/HTTPS requests
|
|
|
|
## Usage
|
|
|
|
```console
|
|
coder agent-firewall [flags] [args...]
|
|
```
|
|
|
|
## Description
|
|
|
|
```console
|
|
boundary creates an isolated network environment for target processes, intercepting HTTP/HTTPS traffic through a transparent proxy that enforces user-defined allow rules.
|
|
```
|
|
|
|
## Options
|
|
|
|
### --config
|
|
|
|
| Property | Value |
|
|
|-------------|-------------------------------|
|
|
| Type | <code>yaml-config-path</code> |
|
|
| Environment | <code>$BOUNDARY_CONFIG</code> |
|
|
|
|
Path to YAML config file.
|
|
|
|
### --allow
|
|
|
|
| Property | Value |
|
|
|-------------|------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$BOUNDARY_ALLOW</code> |
|
|
|
|
Allow rule (repeatable). These are merged with allowlist from config file. Format: "pattern" or "METHOD[,METHOD] pattern".
|
|
|
|
### --log-level
|
|
|
|
| Property | Value |
|
|
|-------------|----------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$BOUNDARY_LOG_LEVEL</code> |
|
|
| YAML | <code>log_level</code> |
|
|
| Default | <code>warn</code> |
|
|
|
|
Set log level (error, warn, info, debug).
|
|
|
|
### --log-dir
|
|
|
|
| Property | Value |
|
|
|-------------|--------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$BOUNDARY_LOG_DIR</code> |
|
|
| YAML | <code>log_dir</code> |
|
|
|
|
Set a directory to write logs to rather than stderr.
|
|
|
|
### --proxy-port
|
|
|
|
| Property | Value |
|
|
|-------------|--------------------------|
|
|
| Type | <code>int</code> |
|
|
| Environment | <code>$PROXY_PORT</code> |
|
|
| YAML | <code>proxy_port</code> |
|
|
| Default | <code>8080</code> |
|
|
|
|
Set a port for HTTP proxy.
|
|
|
|
### --pprof
|
|
|
|
| Property | Value |
|
|
|-------------|------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$BOUNDARY_PPROF</code> |
|
|
| YAML | <code>pprof_enabled</code> |
|
|
|
|
Enable pprof profiling server.
|
|
|
|
### --pprof-port
|
|
|
|
| Property | Value |
|
|
|-------------|-----------------------------------|
|
|
| Type | <code>int</code> |
|
|
| Environment | <code>$BOUNDARY_PPROF_PORT</code> |
|
|
| YAML | <code>pprof_port</code> |
|
|
| Default | <code>6060</code> |
|
|
|
|
Set port for pprof profiling server.
|
|
|
|
### --jail-type
|
|
|
|
| Property | Value |
|
|
|-------------|----------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$BOUNDARY_JAIL_TYPE</code> |
|
|
| YAML | <code>jail_type</code> |
|
|
| Default | <code>nsjail</code> |
|
|
|
|
Jail type to use for network isolation. Options: nsjail (default), landjail.
|
|
|
|
### --use-real-dns
|
|
|
|
| Property | Value |
|
|
|-------------|-------------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$BOUNDARY_USE_REAL_DNS</code> |
|
|
| YAML | <code>use_real_dns</code> |
|
|
|
|
Use real DNS in the jail instead of the dummy DNS (allows DNS exfiltration). Default: false.
|
|
|
|
### --no-user-namespace
|
|
|
|
| Property | Value |
|
|
|-------------|------------------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$BOUNDARY_NO_USER_NAMESPACE</code> |
|
|
| YAML | <code>no_user_namespace</code> |
|
|
|
|
Do not create a user namespace. Use in restricted environments that disallow user NS (e.g. Bottlerocket in EKS auto-mode).
|
|
|
|
### --disable-audit-logs
|
|
|
|
| Property | Value |
|
|
|-------------|----------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$DISABLE_AUDIT_LOGS</code> |
|
|
| YAML | <code>disable_audit_logs</code> |
|
|
|
|
Disable sending of audit logs to the workspace agent when set to true.
|
|
|
|
### --log-proxy-socket-path
|
|
|
|
| Property | Value |
|
|
|-------------|----------------------------------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$CODER_AGENT_BOUNDARY_LOG_PROXY_SOCKET_PATH</code> |
|
|
| Default | <code>/tmp/boundary-audit.sock</code> |
|
|
|
|
Path to the socket where the boundary log proxy server listens for audit logs.
|
|
|
|
### --version
|
|
|
|
| Property | Value |
|
|
|----------|-------------------|
|
|
| Type | <code>bool</code> |
|
|
|
|
Print version information and exit.
|
|
|
|
### --enable-session-correlation
|
|
|
|
| Property | Value |
|
|
|-------------|----------------------------------------------------|
|
|
| Type | <code>bool</code> |
|
|
| Environment | <code>$BOUNDARY_SESSION_CORRELATION_ENABLED</code> |
|
|
| YAML | <code>session_correlation_enabled</code> |
|
|
|
|
Enable session correlation header injection. When no inject targets are configured, the target is auto-derived from CODER_AGENT_URL (set automatically inside Coder workspaces). Disable for deployments without Coder AI Gateway in front.
|
|
|
|
### --session-id-inject-target
|
|
|
|
| Property | Value |
|
|
|-------------|-------------------------------------------------|
|
|
| Type | <code>string</code> |
|
|
| Environment | <code>$BOUNDARY_SESSION_ID_INJECT_TARGET</code> |
|
|
|
|
Inject target for session correlation headers. Repeat the flag once per target; each value describes exactly one target. Format: `domain=<host> [path=<glob>]`. Example: `--session-id-inject-target "domain=prod.coder.com path=/api/v2/aibridge/*"`.
|