docs(caddy): update references to custom global configuration in deployment instructions, typo fixes

This commit is contained in:
Pasha Sviderski
2026-11-06 19:29:32 +10:00
parent 68d2bd5656
commit cef6916544
3 changed files with 17 additions and 9 deletions
@@ -132,8 +132,8 @@ Use it when you need:
- Advanced TLS settings. - Advanced TLS settings.
- Other Caddy features and plugins. - Other Caddy features and plugins.
See [Deploying or updating Caddy](3-managing-caddy.md#deploying-or-updating-caddy) for details on deploying Caddy with a See [Custom global configuration](3-managing-caddy.md#custom-global-configuration) to learn how to deploy Caddy
custom global configuration. with a custom global config.
### Templates ### Templates
@@ -278,7 +278,7 @@ example.com {
The generated config combines: The generated config combines:
- Global Caddy configuration (`x-caddy` from the `caddy` service). - Global Caddy configuration (`x-caddy` from the `caddy` service).
See [Deploying or updating Caddy](3-managing-caddy.md#deploying-or-updating-caddy) for details. See [Custom global configuration](3-managing-caddy.md#custom-global-configuration) for details.
- Auto-generated configs from published service ports (`x-ports`). - Auto-generated configs from published service ports (`x-ports`).
- Custom Caddy configs from services (`x-caddy`). - Custom Caddy configs from services (`x-caddy`).
- Skipped invalid configs with error messages as comments. - Skipped invalid configs with error messages as comments.
@@ -30,6 +30,8 @@ uc inspect caddy
Service ID: b5b269d5dc5ed4fdae6542894f94de82 Service ID: b5b269d5dc5ed4fdae6542894f94de82
Name: caddy Name: caddy
Mode: global Mode: global
Labels:
uncloud.caddy.managed=
CONTAINER ID IMAGE CREATED STATUS IP ADDRESS MACHINE CONTAINER ID IMAGE CREATED STATUS IP ADDRESS MACHINE
fb8f390e634d ghcr.io/unlabs-dev/caddy-uncloud:0.1.4 3 weeks ago Up 3 weeks 10.210.1.2 prod-ap1 fb8f390e634d ghcr.io/unlabs-dev/caddy-uncloud:0.1.4 3 weeks ago Up 3 weeks 10.210.1.2 prod-ap1
@@ -132,7 +134,7 @@ storage. It must also include `curl` for the health check and start Caddy with `
The default Uncloud Caddy image The default Uncloud Caddy image
[`ghcr.io/unlabs-dev/caddy-uncloud`](https://github.com/unlabs-dev/caddy-uncloud/pkgs/container/caddy-uncloud) satisfies [`ghcr.io/unlabs-dev/caddy-uncloud`](https://github.com/unlabs-dev/caddy-uncloud/pkgs/container/caddy-uncloud) satisfies
these requirements. See the [release notest](https://github.com/unlabs-dev/caddy-uncloud/releases/latest) for the Caddy these requirements. See the [release notes](https://github.com/unlabs-dev/caddy-uncloud/releases/latest) for the Caddy
version and the list of included modules. version and the list of included modules.
If you need other Caddy modules or want to choose a compatible Caddy version, you can If you need other Caddy modules or want to choose a compatible Caddy version, you can
@@ -24,13 +24,19 @@ storage.
Before you deploy, upgrade the [`uc` CLI](../../2-getting-started/1-install-cli.md) and the daemon on all machines to Before you deploy, upgrade the [`uc` CLI](../../2-getting-started/1-install-cli.md) and the daemon on all machines to
v0.22.0 or newer. Follow the [upgrade instructions](https://github.com/psviderski/uncloud/releases/latest) for daemon v0.22.0 or newer. Follow the [upgrade instructions](https://github.com/psviderski/uncloud/releases/latest) for daemon
upgrades, including any required migrations from older releases. Check current versions with `uc version` and `uc upgrades, including any required migrations from older releases. Check current versions with `uc version` and
machine ls`. `uc machine ls`.
The first `uc caddy deploy` after the upgrade doesn't know the values you set with earlier versions of `uc`. It replaces The first `uc caddy deploy` after the upgrade doesn't know the values you set with earlier versions of `uc`. It replaces
your image, global config, and machine list with the defaults unless you pass them as flags. your image, global config, and machine list with the defaults unless you pass them as flags. If you deployed Caddy only
to some machines, add `--machine` with the same machines to every `uc caddy deploy` command below.
If you already use `storage uncloud`, your certificates stay where they are, so you only need to run `uc caddy deploy`. If you already use `storage uncloud`, your certificates stay where they are. Run `uc caddy deploy` and pass the global
config you deployed it with, unless it only contains `storage uncloud`:
```shell
uc caddy deploy --caddyfile global.Caddyfile
```
### Quick upgrade ### Quick upgrade
@@ -96,7 +102,7 @@ Follow these steps to keep your existing certificates and avoid HTTPS failures:
### Upgrading a Compose deployment ### Upgrading a Compose deployment
If you manage Caddy with Compose, keep using `uc deploy` and update your Compose file to match If you manage Caddy with Compose, keep using `uc deploy` and update your Compose file to match the
[Compose example](3-managing-caddy.md#managing-caddy-with-compose). To keep your certificates, follow the [Compose example](3-managing-caddy.md#managing-caddy-with-compose). To keep your certificates, follow the
[migration steps](#migrating-certificates) with these changes: [migration steps](#migrating-certificates) with these changes: