lms/specs/001-add-dokploy-deploy/contracts/gitea-webhook-setup.md

20 lines
1.3 KiB
Markdown

# Gitea → Dokploy Webhook Setup
Steps to configure the Gitea repository webhook to trigger Dokploy compose deployments:
1. In Gitea, open the repository and go to **Settings → Webhooks**.
2. Click **Add Webhook** and choose **Gitea** or **Custom** depending on your Gitea version.
3. Fill in the endpoint URL: `https://system.cloudarix.de/api/deploy/compose/JXSdfeHdc6wBKUEiJrX_9`.
4. Set **Content Type** to `application/json`.
5. (Optional but recommended) Add a secret token for payload signing. Store the secret in Dokploy project-level secrets and enable signature validation in Dokploy if supported.
6. Select events: enable **Push events** (and tag push if you want tag-triggered deploys).
7. Leave SSL verification enabled unless Dokploy uses a self-signed cert (then configure accordingly).
8. Save the webhook and use the **Test Delivery** function to send a sample payload.
Verification
- A successful delivery should return HTTP 2xx from Dokploy. Verify a deployment run appears in Dokploy and that the `commit_sha` from the payload is recorded in the run.
Troubleshooting
- If Dokploy returns 4xx, check webhook secret/signature and Dokploy project authentication.
- If Dokploy cannot clone the repo, ensure `REPO_DEPLOY_KEY` is configured and has read access.