mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-07 04:12:04 +00:00
docs(deploy): describe the deploy webhook's signature and strict mode
The compose comment still called DEPLOY_WEBHOOK_REQUIRE_TIMESTAMP a requirement for a fresh timestamp header, which the route stopped accepting in strict mode once requests could be signed, and the env manifest named only the secret header and lacked the strict switch. Both now say what the route checks: the secret header, which has no replay protection, or X-Deploy-Webhook-Signature over the timestamp and body, and that the strict setting takes signed requests only. The development example says the same and points at the deploy runbook instead of a page that no longer exists.
This commit is contained in:
1 parent
877db9a5b7
commit
aebd7ea612
3 files changed
+26
-13
No files matched your search
@@ -260,11 +260,16 @@
|
||||
"variables": [
|
||||
{
|
||||
"name": "DEPLOY_WEBHOOK_SECRET",
|
||||
"purpose": "Shared secret for the X-Deploy-Webhook-Secret header on POST /api/internal/deploy-webhook. 64 hex chars."
|
||||
"purpose": "Shared secret of POST /api/internal/deploy-webhook. 64 hex chars. A request authenticates by sending it in the X-Deploy-Webhook-Secret header (Coolify's stock sender; no replay protection), or by signing: X-Deploy-Webhook-Signature: sha256=<HMAC-SHA256 under this secret of the X-Deploy-Webhook-Timestamp value, a dot and the raw body>, the timestamp within 5 minutes."
|
||||
},
|
||||
{
|
||||
"name": "DEPLOY_LOGS_URL",
|
||||
"purpose": "URL of the deployment dashboard (e.g. the Coolify UI) linked in deploy-failure notifications. Optional; when unset the notification omits the link."
|
||||
},
|
||||
{
|
||||
"name": "DEPLOY_WEBHOOK_REQUIRE_TIMESTAMP",
|
||||
"purpose": "\"true\" (or \"1\") accepts only signed deploy-webhook requests (X-Deploy-Webhook-Signature with a fresh X-Deploy-Webhook-Timestamp); the secret header alone is refused with 401. Leave unset for Coolify's stock sender, which can only send the secret header.",
|
||||
"example": "true"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
||||
Reference in new issue
Block a user