Skip to content

docs: fix inaccuracies in CLI reference #1565

@Mossaka

Description

@Mossaka

Summary

The CLI reference contains several inaccuracies that should be corrected.

Inaccuracies

1. --dns-servers default is wrong

2. --keep-containers cleanup note references wrong container name

  • Docs say: docker stop awf-squid awf-copilot
  • Actual: Container is named awf-agent, not awf-copilot

3. --mount default mounts description is misleading

  • Docs say: "host filesystem at /host (read-only)"
  • Actual: AWF uses selective bind mounts, not a blanket host FS mount. System binaries (/usr, /bin, /sbin, /lib, /lib64, /opt, /sys, /dev) are mounted read-only; workspace and /tmp read-write; whitelisted $HOME subdirs read-write; select /etc files only (not /etc/shadow).

4. --allow-host-ports default description is outdated

  • Docs say: "Current default allows all ports (future versions will default to 80,443)"
  • Actual: Default is already 80,443 in the current code.

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions