caddy: keep admin on for hot reload; deploy.sh reloads after render
The Caddyfile had 'admin off', which disables Caddy's config file watcher. Rendered Caddyfile changes never loaded until the container was recreated, so the double-hash basicauth fix sat on disk unapplied across deploys (2026-08-22). Admin binds to 127.0.0.1:2019 inside the container and the port is unpublished, so nothing outside reaches it. deploy.sh now issues an explicit 'caddy reload' (retry loop) after 'up -d', with the file watcher as backstop.
This commit is contained in:
1 parent
da68b5ce1a
commit
bb1ef9bfb3
5 files changed
+45
-1
No files matched your search
+5
-1
@@ -23,7 +23,11 @@
|
|||||||
# resolves these names to 192.168.0.143.
|
# resolves these names to 192.168.0.143.
|
||||||
|
|
||||||
{
|
{
|
||||||
admin off
|
# Admin stays ON: it binds to 127.0.0.1:2019 inside the container and the
|
||||||
|
# port is not published, so nothing outside the container can reach it.
|
||||||
|
# It powers the config file watcher, so a rendered Caddyfile change
|
||||||
|
# hot-reloads without a container restart. 'admin off' once left a broken
|
||||||
|
# basicauth hash sitting on disk unapplied for hours (2026-08-22).
|
||||||
email admin@franksdank.cloud
|
email admin@franksdank.cloud
|
||||||
|
|
||||||
# Solve ACME challenges for every site via Porkbun DNS (no port 80/443
|
# Solve ACME challenges for every site via Porkbun DNS (no port 80/443
|
||||||
|
|||||||
@@ -73,10 +73,17 @@ Validate before a reload:
|
|||||||
caddy validate --config /etc/caddy/Caddyfile --adapter caddyfile
|
caddy validate --config /etc/caddy/Caddyfile --adapter caddyfile
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The admin endpoint stays on (loopback-only, unpublished port), so a Caddyfile change hot-reloads within seconds via the file watcher. deploy.sh also issues an explicit reload after rendering. Manual reload from the host:
|
||||||
|
|
||||||
|
```
|
||||||
|
podman exec caddy caddy reload --config /etc/caddy/Caddyfile --adapter caddyfile
|
||||||
|
```
|
||||||
|
|
||||||
Certificates and ACME state live in the caddy data volume. Back it up with the stack. Each vhost owns one certificate; renewals are automatic and also use DNS-01.
|
Certificates and ACME state live in the caddy data volume. Back it up with the stack. Each vhost owns one certificate; renewals are automatic and also use DNS-01.
|
||||||
|
|
||||||
## Gotchas
|
## Gotchas
|
||||||
|
|
||||||
|
- `admin off` disables the config file watcher: rendered changes then sit on disk while Caddy serves its stale in-memory config until the container is recreated, and nothing logs an error (2026-08-22: a broken basicauth hash survived several deploys this way). `tests/caddyfile.bats` forbids `admin off`.
|
||||||
- The basicauth template must stay a bare `REPLACE_WITH_HASH` token (no `$2a$14$` prefix) — the rendered value is the complete hash. A double prefix silently rejects every password with 401; no Caddy error is logged.
|
- The basicauth template must stay a bare `REPLACE_WITH_HASH` token (no `$2a$14$` prefix) — the rendered value is the complete hash. A double prefix silently rejects every password with 401; no Caddy error is logged.
|
||||||
- A new vhost needs three things: a dnsmasq `addn-hosts` line, a Porkbun A record, and the Caddyfile block. See [[LAN-DNS]].
|
- A new vhost needs three things: a dnsmasq `addn-hosts` line, a Porkbun A record, and the Caddyfile block. See [[LAN-DNS]].
|
||||||
- The G36 has no NAT loopback, so LAN clients must resolve the name to the LAN IP. That is the dnsmasq role in [[LAN-DNS]].
|
- The G36 has no NAT loopback, so LAN clients must resolve the name to the LAN IP. That is the dnsmasq role in [[LAN-DNS]].
|
||||||
|
|||||||
@@ -155,6 +155,18 @@ if [ '${COMPOSE_UP[$TARGET]}' = '1' ]; then
|
|||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
podman-compose -f '${COMPOSE[$TARGET]}' up -d
|
podman-compose -f '${COMPOSE[$TARGET]}' up -d
|
||||||
|
|
||||||
|
# A Caddyfile render is a bind-mount content change, not a container
|
||||||
|
# config change: the caddy container often survives 'up -d' and keeps
|
||||||
|
# serving its in-memory config. Reload explicitly; the file watcher
|
||||||
|
# (admin on) is the backstop if the API is not up yet.
|
||||||
|
for i in 1 2 3 4 5; do
|
||||||
|
if podman exec caddy caddy reload --config /etc/caddy/Caddyfile --adapter caddyfile >/dev/null 2>&1; then
|
||||||
|
echo \" Caddy reloaded.\"
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
sleep 3
|
||||||
|
done
|
||||||
else
|
else
|
||||||
echo '[4/4] Skipping compose restart (stack runs as bare containers on this host)'
|
echo '[4/4] Skipping compose restart (stack runs as bare containers on this host)'
|
||||||
fi
|
fi
|
||||||
|
|||||||
@@ -49,6 +49,19 @@ CADDYFILE="$REPO_ROOT/dankclaw/Caddyfile"
|
|||||||
grep -q 'REPLACE_WITH_HASH' "$CADDYFILE"
|
grep -q 'REPLACE_WITH_HASH' "$CADDYFILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@test "the Caddyfile does not disable the admin endpoint (hot reload needs it)" {
|
||||||
|
# admin off disables Caddy's config file watcher: rendered Caddyfile
|
||||||
|
# changes are never loaded until the container is recreated, and the
|
||||||
|
# stale config fails silently (2026-08-22: basicauth stayed broken for
|
||||||
|
# hours across deploys). The admin API binds to 127.0.0.1:2019 inside
|
||||||
|
# the container and the port is not published, so it is not reachable
|
||||||
|
# from the LAN.
|
||||||
|
if grep -qE '^\s*admin\s+off' "$CADDYFILE"; then
|
||||||
|
echo "Caddyfile: 'admin off' disables hot reload of rendered config"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
@test "the basicauth placeholder is a bare token (no bcrypt prefix in the template)" {
|
@test "the basicauth placeholder is a bare token (no bcrypt prefix in the template)" {
|
||||||
# Regression (2026-08-22): the template line was
|
# Regression (2026-08-22): the template line was
|
||||||
# dank $2a$14$REPLACE_WITH_HASH
|
# dank $2a$14$REPLACE_WITH_HASH
|
||||||
|
|||||||
@@ -37,6 +37,14 @@ load helpers
|
|||||||
# Regression: the Caddyfile render step in deploy.sh must survive a bcrypt
|
# Regression: the Caddyfile render step in deploy.sh must survive a bcrypt
|
||||||
# hash (which contains '/' characters). Reproduce the sed expression with a
|
# hash (which contains '/' characters). Reproduce the sed expression with a
|
||||||
# slash-bearing hash and confirm the placeholder is replaced.
|
# slash-bearing hash and confirm the placeholder is replaced.
|
||||||
|
@test "deploy.sh reloads Caddy after rendering (hot reload, not just container start)" {
|
||||||
|
# The caddy container often survives 'up -d' (a Caddyfile change is a
|
||||||
|
# bind-mount content change, not a container config change). Without an
|
||||||
|
# explicit reload, a rendered fix can sit on disk while Caddy serves the
|
||||||
|
# stale in-memory config.
|
||||||
|
grep -q 'caddy reload' "$REPO_ROOT/scripts/deploy.sh"
|
||||||
|
}
|
||||||
|
|
||||||
@test "deploy.sh Caddyfile render survives a slash-bearing bcrypt hash" {
|
@test "deploy.sh Caddyfile render survives a slash-bearing bcrypt hash" {
|
||||||
local hash='$2a$14$dndiQ9EaycJv0w3Gp2oAYO/xH6O9x2ZRhMLJdCxrgi9rMn1te9D/spy'
|
local hash='$2a$14$dndiQ9EaycJv0w3Gp2oAYO/xH6O9x2ZRhMLJdCxrgi9rMn1te9D/spy'
|
||||||
local rendered
|
local rendered
|
||||||
|
|||||||
Reference in new issue
Block a user