From f78a8ca8b54530ec77912f275d37fc210acb892c Mon Sep 17 00:00:00 2001 From: Pasha Sviderski Date: Thu, 1 Oct 2026 21:00:05 +1000 Subject: [PATCH] docs(caddy): regenerate CLI reference for 'caddy cert ls' command --- website/docs/9-cli-reference/uc_caddy.md | 1 + website/docs/9-cli-reference/uc_caddy_cert.md | 24 ++++++++++++ .../docs/9-cli-reference/uc_caddy_cert_ls.md | 38 +++++++++++++++++++ 3 files changed, 63 insertions(+) create mode 100644 website/docs/9-cli-reference/uc_caddy_cert.md create mode 100644 website/docs/9-cli-reference/uc_caddy_cert_ls.md diff --git a/website/docs/9-cli-reference/uc_caddy.md b/website/docs/9-cli-reference/uc_caddy.md index 227d52a3..c05ea434 100644 --- a/website/docs/9-cli-reference/uc_caddy.md +++ b/website/docs/9-cli-reference/uc_caddy.md @@ -20,6 +20,7 @@ Manage Caddy reverse proxy service. ## See also * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes. +* [uc caddy cert](uc_caddy_cert.md) - Inspect certificates in cluster storage for Caddy. * [uc caddy config](uc_caddy_config.md) - Show the current Caddy configuration (Caddyfile). * [uc caddy deploy](uc_caddy_deploy.md) - Deploy or upgrade Caddy reverse proxy across all machines in the cluster. * [uc caddy logs](uc_caddy_logs.md) - View caddy logs. diff --git a/website/docs/9-cli-reference/uc_caddy_cert.md b/website/docs/9-cli-reference/uc_caddy_cert.md new file mode 100644 index 00000000..508688c5 --- /dev/null +++ b/website/docs/9-cli-reference/uc_caddy_cert.md @@ -0,0 +1,24 @@ +# uc caddy cert + +Inspect certificates in cluster storage for Caddy. + +## Options + +``` + -h, --help help for cert +``` + +## Options inherited from parent commands + +``` + --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] + Format: [ssh://]user@host[:port], ssh+go://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock + -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] + --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") +``` + +## See also + +* [uc caddy](uc_caddy.md) - Manage Caddy reverse proxy service. +* [uc caddy cert ls](uc_caddy_cert_ls.md) - List certificates in cluster storage for Caddy. + diff --git a/website/docs/9-cli-reference/uc_caddy_cert_ls.md b/website/docs/9-cli-reference/uc_caddy_cert_ls.md new file mode 100644 index 00000000..9238f824 --- /dev/null +++ b/website/docs/9-cli-reference/uc_caddy_cert_ls.md @@ -0,0 +1,38 @@ +# uc caddy cert ls + +List certificates in cluster storage for Caddy. + +## Synopsis + +List certificates stored in the Uncloud cluster storage for Caddy. + +Caddy must use the Uncloud storage module (https://github.com/unlabs-dev/caddy-uncloud) +configured with 'storage uncloud' in the global options for its certificates to appear here. + +This inventory does not check whether Caddy currently serves or trusts a certificate. + +``` +uc caddy cert ls [flags] +``` + +## Options + +``` + -h, --help help for ls + -m, --machine string Name or ID of the machine to read certificate storage from. (default is connected machine) + -o, --output string Output format: 'json' or empty for a human-readable table. +``` + +## Options inherited from parent commands + +``` + --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] + Format: [ssh://]user@host[:port], ssh+go://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock + -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] + --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") +``` + +## See also + +* [uc caddy cert](uc_caddy_cert.md) - Inspect certificates in cluster storage for Caddy. +