Skip to content

labops proxy

Manage the Caddy reverse proxy

Usage:

$ labops proxy [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List all reverse-proxy routes...
  • access: Show the resolved CIDR...
  • render: Render the Caddyfile: print...
  • sync: Sync the rendered Caddyfile...
  • deploy: Deploy the Caddyfile to the...
  • reload: Reload Caddy on the target...

labops proxy list

List all reverse-proxy routes derived from web_services.

One row per web_services entry that has a proxy_name; entries without one are tracked in the config but not routed. Shows the resolved access lists, so it is the quickest way to check what a service is exposed to. Reads the config only — Caddy is not contacted.

Usage:

$ labops proxy list [OPTIONS]

Options:

  • --help: Show this message and exit.

labops proxy access

Show the resolved CIDR accept/deny sets for each proxy route.

Resolves the named access lists to their actual CIDRs — the union across all lists a service references, after dedup. Use this to verify what can reach a service before opening it up. Reads the config only — Caddy is not contacted.

Usage:

$ labops proxy access [OPTIONS]

Options:

  • --help: Show this message and exit.

labops proxy render

Render the Caddyfile: print it, or write it to a file with -o.

Delivery to the running Caddy is proxy sync / proxy deploy; -o is just for inspecting or saving a local copy.

Usage:

$ labops proxy render [OPTIONS]

Options:

  • -o, --output <path>: Write the Caddyfile to this path instead of printing it.
  • --force: Overwrite the output path if it already exists.
  • --help: Show this message and exit.

labops proxy sync

Sync the rendered Caddyfile to the Caddy host (no reload).

The file lands on the target but Caddy keeps serving its old config until something reloads it — proxy reload, or proxy deploy which does both. Requires settings.proxy.deploy.

Usage:

$ labops proxy sync [OPTIONS]

Options:

  • --help: Show this message and exit.

labops proxy deploy

Deploy the Caddyfile to the Caddy host and reload (only if changed).

sync + reload, and the reload is skipped when the file on the target is already identical — so this is safe to run repeatedly. The usual command after editing web_services. Requires settings.proxy.deploy.

There is no caddy validate step: a Caddyfile that renders but that Caddy rejects lands on the target and fails at reload. Check it first with proxy render.

Usage:

$ labops proxy deploy [OPTIONS]

Options:

  • --help: Show this message and exit.

labops proxy reload

Reload Caddy on the target using its on-disk config (no sync).

Nothing is rendered or copied — this reloads whatever Caddyfile is already on the target. Use it after a sync, or to pick up a change made on the target itself. Requires settings.proxy.deploy.

Usage:

$ labops proxy reload [OPTIONS]

Options:

  • --help: Show this message and exit.