mirror of
https://github.com/psviderski/uncloud.git
synced 2026-08-26 11:03:34 +00:00
docs: improve Caddyfile header and note about misconfigured caddy service, minor docs update
This commit is contained in:
@@ -10,7 +10,7 @@ with [Let's Encrypt](https://letsencrypt.org/), and route requests to your servi
|
||||
## How it works
|
||||
|
||||
By default, Caddy runs as a global service `caddy` on every machine in your cluster, listening on the host ports 80
|
||||
(HTTP) and 443 (HTTPS).
|
||||
(HTTP), 443 (HTTPS), and 443/UDP (HTTP/3).
|
||||
|
||||
It's deployed during cluster initialisation (`uc machine init`) unless you use the `--no-caddy` flag.
|
||||
See [Managing Caddy](3-managing-caddy.md) for deployment and customisation instructions.
|
||||
|
||||
@@ -197,8 +197,9 @@ debugging and verifying your `x-caddy` configs.
|
||||
Example output:
|
||||
|
||||
```caddyfile
|
||||
# This file is autogenerated by Uncloud based on the configuration of running services.
|
||||
# Do not edit manually. Any manual changes will be overwritten on the next update.
|
||||
# Caddyfile autogenerated by Uncloud (DO NOT EDIT): 2025-12-20T22:43:56Z
|
||||
# Automatically updated on service or health status changes.
|
||||
# Docs: https://uncloud.run/docs/concepts/ingress/overview
|
||||
|
||||
# User-defined global config from service 'caddy'.
|
||||
*.example.com {
|
||||
|
||||
@@ -94,6 +94,7 @@ services:
|
||||
x-ports:
|
||||
- 80:80@host
|
||||
- 443:443@host
|
||||
- 443:443/udp@host
|
||||
x-caddy: Caddyfile
|
||||
deploy:
|
||||
mode: global
|
||||
@@ -138,7 +139,8 @@ internal.example.com {
|
||||
:::info note
|
||||
|
||||
The specified `command`, `environment`, `volumes`, and `x-ports` properties are essential for Caddy to function
|
||||
correctly in the Uncloud cluster.
|
||||
correctly in the Uncloud cluster. Do not change the source paths of the volume mounts as the Uncloud daemon relies on
|
||||
them to communicate with Caddy and update its configuration.
|
||||
|
||||
:::
|
||||
|
||||
@@ -160,8 +162,9 @@ uc caddy config
|
||||
Example output:
|
||||
|
||||
```caddyfile
|
||||
# This file is autogenerated by Uncloud based on the configuration of running services.
|
||||
# Do not edit manually. Any manual changes will be overwritten on the next update.
|
||||
# Caddyfile autogenerated by Uncloud (DO NOT EDIT): 2025-12-22T10:30:12Z
|
||||
# Automatically updated on service or health status changes.
|
||||
# Docs: https://uncloud.run/docs/concepts/ingress/overview
|
||||
|
||||
# User-defined global config from service 'caddy'.
|
||||
# Global options.
|
||||
|
||||
Reference in New Issue
Block a user