CLI

Exit codes: 0 success, 1 the command ran and found problems (for example validate reported errors), 2 the command could not run (bad arguments, unreadable files, the admin API unreachable).

ReverseDock: one reverse proxy for every dock

Usage: rdock <COMMAND>

Commands:
  run          Run the proxy
  validate     Validate configuration files without starting the proxy
  reload       Ask the running proxy to reload its configuration
  status       Show the state of the running proxy
  healthcheck  Exit 0 when the running proxy is ready (for container health checks)
  hash         Create an argon2id password hash for `basic_auth` (reads the password from stdin)
  trust        Install the local CA's root (for localhost and private names) into the system trust stores, or remove it with --uninstall
  migrate      Turn another proxy's configuration into rdock.yaml
  schema       Print the JSON Schema of rdock.yaml
  version      Print version and build information
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

rdock run

Run the proxy

Usage: rdock run [OPTIONS]

Options:
  -c, --config <CONFIG>
          Configuration file [default: /etc/rdock/rdock.yaml]. Without one, rdock runs in zero-config mode: HTTPS on :443 with automatic certificates, :80 redirecting, routes from Docker labels

          [env: RDOCK_CONFIG=]

      --data-dir <DATA_DIR>
          Directory for state (configuration history, last-known-good copy, admin token, certificates and the local CA)

          [env: RDOCK_DATA_DIR=]
          [default: /var/lib/rdock]

      --no-watch
          Do not reload when the configuration or referenced files change

      --log <LOG>
          Log filter, e.g. `info` or `info,rdock_proxy=debug`

          [env: RDOCK_LOG=]
          [default: info]

      --log-format <LOG_FORMAT>
          Format of the application log

          Possible values:
          - auto: JSON unless standard error is a terminal
          - json: JSON lines
          - text: Text

          [env: RDOCK_LOG_FORMAT=]
          [default: auto]

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

rdock validate

Validate configuration files without starting the proxy

Usage: rdock validate [OPTIONS] <FILES>...

Arguments:
  <FILES>...  Configuration files (YAML, or JSON with a .json extension)

Options:
      --strict           Treat warnings as errors
      --format <FORMAT>  Output format [default: text] [possible values: text, json]
  -h, --help             Print help
  -V, --version          Print version

rdock reload

Ask the running proxy to reload its configuration

Usage: rdock reload [OPTIONS]

Options:
      --admin <ADMIN>        Admin listener of the running proxy. Read from the configuration file when omitted [env: RDOCK_ADMIN=]
  -c, --config <CONFIG>      Configuration file, to find the admin listener [env: RDOCK_CONFIG=] [default: /etc/rdock/rdock.yaml]
      --data-dir <DATA_DIR>  Data directory, to find the admin token [env: RDOCK_DATA_DIR=] [default: /var/lib/rdock]
  -h, --help                 Print help
  -V, --version              Print version

rdock status

Show the state of the running proxy

Usage: rdock status [OPTIONS]

Options:
      --admin <ADMIN>        Admin listener of the running proxy. Read from the configuration file when omitted [env: RDOCK_ADMIN=]
  -c, --config <CONFIG>      Configuration file, to find the admin listener [env: RDOCK_CONFIG=] [default: /etc/rdock/rdock.yaml]
      --data-dir <DATA_DIR>  Data directory, to find the admin token [env: RDOCK_DATA_DIR=] [default: /var/lib/rdock]
      --json                 Print the raw JSON document
  -h, --help                 Print help
  -V, --version              Print version

rdock healthcheck

Exit 0 when the running proxy is ready (for container health checks)

Usage: rdock healthcheck [OPTIONS]

Options:
      --admin <ADMIN>        Admin listener of the running proxy. Read from the configuration file when omitted [env: RDOCK_ADMIN=]
  -c, --config <CONFIG>      Configuration file, to find the admin listener [env: RDOCK_CONFIG=] [default: /etc/rdock/rdock.yaml]
      --data-dir <DATA_DIR>  Data directory, to find the admin token [env: RDOCK_DATA_DIR=] [default: /var/lib/rdock]
  -h, --help                 Print help
  -V, --version              Print version

rdock hash

Create an argon2id password hash for `basic_auth` (reads the password from stdin)

Usage: rdock hash [OPTIONS]

Options:
      --user <USER>  Print a complete `user:hash` entry for `basic_auth.users`
  -h, --help         Print help
  -V, --version      Print version

rdock trust

Install the local CA's root (for localhost and private names) into the system trust stores, or remove it with --uninstall

Usage: rdock trust [OPTIONS]

Options:
      --uninstall            Remove the root from the trust stores instead of installing it
      --data-dir <DATA_DIR>  Data directory holding the local CA (`pki/`); the CA is created there when missing [env: RDOCK_DATA_DIR=] [default: /var/lib/rdock]
  -h, --help                 Print help
  -V, --version              Print version

rdock migrate

Turn another proxy's configuration into rdock.yaml

Usage: rdock migrate <COMMAND>

Commands:
  traefik  Traefik labels (a Compose file) or a Traefik dynamic configuration → rdock.yaml
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

rdock schema

Print the JSON Schema of rdock.yaml

Usage: rdock schema

Options:
  -h, --help     Print help
  -V, --version  Print version

rdock version

Print version and build information

Usage: rdock version [OPTIONS]

Options:
      --json     Print as JSON
  -h, --help     Print help
  -V, --version  Print version