Commands
Every seawall command, generated from the code. A command marked --yes changes the host. Without --yes it prints the plan and changes nothing.
Global options
--checkExit 1 when a report finds something (drift, lint errors, attention): for scripts. Without it, a run that worked exits 0, so shell prompts stay green
All commands
| Command | Description |
|---|---|
tui | The command centre: a live, tabbed view with actions (a dry run first, then y to confirm) |
new | A wizard for a new stack or game server: a hardened compose file, ready to create |
status | One screen of what needs attention |
alerts | Firing alerts, each with what was found and what to do |
doctor | Check seawall's own setup: file permissions, access, coverage |
facts | Security facts for the alert rules (read-only) |
accept | Mark a finding as expected, so it stops alerting (written to the config) |
accept listener --yes | A program allowed to keep listening, by name on loopback or by address and port |
accept ls | The listeners accepted, with why |
accept rm --yes | Take an accepted listener out, so it alerts again |
images | Image updates: check the registries, list and explain what was found (stack update takes one) |
images prune --yes | Remove every image no container has and no compose file names, images typed (severe) |
images check | Check every running container's image for updates and the CVEs they fix, now |
images ls | Images with updates, by stack, from the last check |
images explain | The last check explained: what each rule would fire for, then each container |
images compare | The Critical and High CVEs in OLD that NEW fixes, both scanned with Trivy |
updates | Automatic updates: what seawall may take on its own, by stack |
updates plan | What the next night's run would take, per stack and candidate, and why (read-only) |
about | The logo, the version and where seawall lives |
optimise | What would make the host and its stacks run better, each with its fix (read-only) |
init --yes | Set this host up, and seawall with it |
posture | How this host compares with best practice, and what to change (read-only) |
notify | Where alerts go, and whether seawall routes them (read-only) |
notify test --yes | Send a test to a destination through Grafana, with the secrets Grafana holds |
notify link --yes | Add each alert's seawall.sh page to this host's message templates |
security | What is exposed, who is trying it, what isn't patched or hardened, what changed (read-only) |
security ct | The certificates logged for each zone seawall proxies, and what doesn't match its CAA |
security ct accept --yes | Count a CA's certificates for a zone as expected, until a day (in seawall.toml) |
security ct accept-cert --yes | One logged certificate: its CA, crt.sh link, dates and names; accepted until it expires |
config | The settings screen (like init, without the detection); --print for plain text |
config set --yes | Change one setting, as the settings screen does: the change, then with --yes the save |
stray | Compose folders no manager runs as a stack: list, ignore, bring in or move them to the trash |
stray ls | Each compose folder no manager runs, with its state and its three ways out |
stray ignore | Leave it alone from now on (paths.ignore) |
stray adopt --yes | Bring it in as a stack (outside the stacks folder it moves in first) |
stray rm --yes | Move it to seawall's trash, a verified copy kept first |
jobs | Jobs of the last week, with state and age |
jobs ls | Each job of the last week, running first, then newest |
jobs cancel | Stop a running job, or take back a queued one's confirm |
jobs follow | Follow a job's steps until it ends |
jobs show | A job's plan, steps and end |
verify | Look again for what the last rename or move left naming the old name |
align --yes | Bring the host to the state seawall wants, in one plan (a dry run until --yes) |
top | Every running container by CPU, with memory, network and disk I/O |
host | The machine: usage graphs, memory by stack, kernel, reboot, Docker and CrowdSec, RAID, drives, disk |
host mem | Memory by stack and each stack's growth |
host reclaim | Disk space this host could get back, by category, and what removes it (read-only) |
host reclaim clean --yes | One category's list, then, with its name typed, each thing on it removed |
host upgrade --yes | Upgrade Docker (engine, CLI, containerd, compose and buildx) and the CrowdSec bouncer |
host audit-reload --yes | Load the audit rules again from their files, dropping rules loaded by hand |
host rollback --yes | Roll back the latest upgrade of Docker or the CrowdSec bouncer, from root's record |
host fix | Fix what the Security tab's Hardening rows find, as root through sudo |
host fix sysctl --yes | Set the kernel settings CIS asks for that are off, in seawall's own sysctl.d file |
host fix perms --yes | Make the system files CIS finds loose root's, their modes tightened to CIS's |
host fix packages --yes | Finish a dpkg run left half done, and reinstall packages whose files changed |
host fix apparmor --yes | Load AppArmor's profiles where it's on and enforces none |
host fix sshd --yes | Set the ssh settings CIS asks for that let in a password, root or rhosts |
host fix lock --yes | Lock an account's empty password (passwd -l); a key it has still logs in |
host fix expire --yes | End an account no one uses (usermod --expiredate 1); its keys stop working too |
audit | seawall's audit trail: every change it made, from the system journal |
audit accept --yes | "That was me": accept the unattributed changes since a time, a day back at most |
stack | Stacks, run by Portainer or Compose |
stack ls | Every stack with its state, containers up, drift and pending updates |
stack show | One stack in detail: containers, state, CPU, memory, network and disk (now and over time) |
stack diff | Diff the disk compose against what is deployed |
stack save | Save the deployed compose file to its folder in paths.backups (the file only; data is db backup) |
stack deploy --yes | Deploy the disk compose, keeping the stack's env (backs up first) |
stack update --yes | Move a stack's images to newer versions found by the update check, then deploy |
stack lint --yes | Check compose files against the hardening baseline |
stack edit --yes | Edit a stack's compose file in $EDITOR, then see what a deploy of it would do |
stack env | A stack's env by name, never by value; set or remove one, then deploy what runs now |
stack env set --yes | Set or replace one value, then deploy what runs now with it |
stack env rm --yes | Remove one, then deploy what runs now without it |
stack secrets | Env var names set in Portainer vs used by the compose file (never values) |
stack reconcile --yes | Make the disk copy and the deployed compose match again, one side winning |
stack harden --yes | Lock a stack's containers down: capabilities, privileges, admin ports |
stack limits --yes | Set a stack's resource limits: memory, CPU, processes, open files |
stack isolate --yes | Take a database off the ingress network, onto the stack's own (dry run until --yes) |
stack pin --yes | Pin each image on a moving tag to the version that runs now (writes the disk copy) |
stack run-as --yes | Move a running stack onto its own user, seawall-<stack> (dry run until --yes) |
stack rollback --yes | Redeploy the newest backup that differs from what is deployed (or --to FILE or STAMP) |
stack new --yes | Set up a new stack from its folder under paths.stacks: lint, create, allowlist, map, capture |
stack create --yes | Create a new stack in Portainer from a compose file (prefer stack new) |
stack migrate --yes | Move a running stack between Portainer and Compose, keeping its volumes |
stack remove --yes | Remove a stack: through its manager, then its networks, ports and routes (severe) |
stack rename --yes | Give a running stack a new name, copying its volumes to the new name's (severe) |
stack runtime --yes | Move a running stack to the rootless owner's runtime, with its data |
stack find | Every stack on this host and where it lives |
stack expose --yes | Put a web app that publishes host ports behind the proxy |
stack move --yes | Move a stack that lives elsewhere into the stacks folder |
stack stop --yes | Stop a stack (silences its container alerts first) |
stack start --yes | Start a stopped stack |
stack logs | Recent logs from a stack's containers |
db | Database dumps that are proven to restore |
db ls | Database containers with their latest dump and whether it was restore-tested |
db backup --yes | Dump a stack's database to its folder in paths.backups (credentials stay in the container) |
db restore-test --yes | Load each database's latest dump into a throwaway container and compare it with the live database |
backup | Data backup: each stack's volumes and folders, and the database dumps, with restic |
backup setup --yes | Make the repository (a local folder, S3 or SFTP) and its password (shown once) |
backup run --yes | Back up every stack's volumes and folders, and the database dumps |
backup image --yes | Whether restic's image for this version is built (--yes builds it) |
backup ls | Each stack's snapshots in the repository |
backup restore --yes | Put a stack's volumes and folders back as a snapshot has them (severe) |
backup restore-test --yes | The weekly restore test now: 5% of the data read back, and one snapshot restored |
backup resume --yes | Put back any stack a backup that didn't finish left paused or stopped |
silence | Grafana alert silences |
silence ls | Active and pending silences |
silence add --yes | Silence ContainerDown, Unhealthy or RestartLoop for containers or whole stacks |
silence alert --yes | Silence one alert by name (and identifying labels); never a sev0 |
silence rm --yes | Expire silences by id |
reboot-prep --yes | Silence the alerts a planned reboot trips (never sev0) |
ports | Ports, privileged containers and firewall rules facts expects (for alerts; not a firewall) |
ports ls | What seawall facts expects, plus anything it flags now |
ports add --yes | Expect ports (7777/udp) or, with --privileged, container names |
ports rm --yes | Remove ports or, with --privileged, container names |
ports check | What seawall facts flags now |
cloud | The config repo that records the host's config |
cloud status | Capture and drift results, and whether the repo is pushed |
cloud init --yes | Make a config repo seawall keeps: its secrets sealed to your age key, pushed with a deploy key |
cloud sync --yes | Cover new /etc files, capture now and check drift again |
cloud capture | Run the capture now (commits and pushes) |
cloud drift | Run the drift check now: what the host has that the repo's last commit doesn't |
cloud log | Recent commits |
restore --yes | Put a host back from a config repo seawall keeps, at a commit you name |
grafana | Grafana administration |
grafana annotations --yes | Show seawall's audit trail as annotations on the UI-managed dashboards |
grafana reload | Restart Grafana to load its provisioning files |
grafana rules | seawall's alert rule files changed or gone since it wrote them, or that it didn't make |
grafana rules diff | The file against seawall's newer version |
grafana rules take --yes | Take seawall's newer version; a file there is kept in backups |
grafana rules adopt --yes | Replace this host's older copy of seawall's rules with its packs, the rest kept |
grafana rules keep --yes | Keep the file as it is; seawall offers its next version |
crowdsec | CrowdSec bans: list them, allowlist a player, lift a ban |
crowdsec bans | Local bans (or one IP's bans and allowlist status) |
crowdsec allow --yes | Never ban this IP (adds it to crowdsec.allowlist) and lift its current bans |
crowdsec unban --yes | Lift an IP's current bans (it can be banned again) |
crowdsec hub | The hub's parsers, scenarios and collections: what waits, what's kept back |
crowdsec hub upgrade --yes | Upgrade them (never an item edited here), then reload CrowdSec |
proxy | The reverse proxy's routes and certificates, whichever proxy it is (read-only) |
proxy cf-only --yes | An NPM site answers only through Cloudflare: a request straight to this host is closed |
proxy hosts | Every route: domains, backend, TLS and redirect, and problems |
proxy certs | Each route's certificate as the proxy serves it, or install one you have |
proxy certs ls | Each route's certificate as the proxy serves it, checked at the proxy itself |
proxy certs install --yes | Put a certificate you already have into the proxy |
proxy route | Add a stack's proxy host to NPM, with its certificate (NPM only) |
proxy route add --yes | A proxy host in NPM for a stack, with its certificate |
proxy route rm --yes | Remove a proxy host seawall made, with its access list and certificate (severe) |
proxy migrate --yes | Move the way in from Nginx Proxy Manager to Traefik |
proxy aop --yes | Cloudflare Authenticated Origin Pulls for a site on Traefik (Traefik only) |
proxy bouncer --yes | CrowdSec's bouncer plugin in Traefik, on routers with a verified client address |
proxy login | Log in seawall's own NPM user once and keep only its token (NPM only) |
proxy probes | Probe public hosts as a visitor reaches them, so a site that's down pages |
proxy probes ls | Each public host, its stack, whether it's probed and how the last probe went |
proxy probes add --yes | Probe public hosts |
proxy probes rm --yes | Stop probing public hosts |
npm | Nginx Proxy Manager (read-only): proxy hosts checked against the ingress rules |
npm certs | Certificates in NPM and as served (facts TLS probes), with expiry |
npm hosts | Every proxy host: backend, certificate, flags and problems |
npm fix --yes | Fix what NPM's API can on a proxy host, a dry run first |
game | Game server stacks: bring them up and down with their ports |
game ls | Every game: stack, state and ports (closed = not on the allowlist) |
game show | One game in detail: state, CPU, memory, network, disk and ports |
game up --yes | Start a game: checks port clashes and drift, adds its ports to the allowlist |
game down --yes | Stop a game and take its ports off the allowlist |
container | One container on its own: its state and settings, and a restart, stop or start |
container ls | Every container, or a stack's: its stack, state and image |
container inspect | Its settings, read-only: every env value shows as <set> |
container restart --yes | Restart one container |
container rebind --yes | Restart each container holding the Docker socket from before the engine's restart |
container stop --yes | Stop one container, its alerts silenced first; the rest of its stack keeps running |
container shell --yes | A shell in one container, as its own user; root only with --root and its name typed |
container start --yes | Start one stopped container |
container adopt --yes | Bring a container started with docker run under a compose stack |
container rm --yes | Remove a stopped container no stack runs, its name typed |
volumes | Docker's volumes: their size and who uses each, and removing an unused one |
volumes ls | Every volume, its size and who uses it (a container, or a stack's compose) |
volumes rm --yes | Remove one no container uses and no compose file names, its name typed (severe) |
volumes clean-aside --yes | Remove seawall's old aside copies, the count typed (severe) |
networks | Docker's networks: who uses each, and removing an unused one |
networks ls | Every network, its driver and who uses it |
networks rm --yes | Remove one no container joins and no compose file names, its name typed (severe) |
networks rename --yes | Rename a network, keeping its subnet: a short cutover, then each stack deploys (severe) |
completions --yes | Tab completion for bash, zsh or fish: the line to add, or --install to add it |