Dokploy/dokploy
1
0
Fork 0
mirror of https://github.com/Dokploy/dokploy.git synced 2026-06-15 20:25:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add comprehensive contributing guidelines and best practices

Browse Source
This commit is contained in:
dosubot[bot]
2026-03-29 00:33:02 +00:00
committed by GitHub
parent ddfcd1a671
commit e63b0aec93
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@@ -132,6 +132,21 @@ If you want to test the webhooks on development mode using localtunnel, make sur
pnpm dlx localtunnel --port 3000 pnpm dlx localtunnel --port 3000
``` ```
### Testing GitLab Webhooks
To test GitLab webhook functionality locally:
1. Configure a GitLab provider in Dokploy with a webhook secret
2. Set up the webhook in your GitLab project (Settings → Webhooks):
- **Webhook URL:** Your localtunnel URL + `/api/deploy/gitlab`
- **Secret token:** Paste the webhook secret from your Dokploy GitLab provider
- **Enable events:** Push events and Merge request events
The GitLab webhook endpoint (`/api/deploy/gitlab`) authenticates requests via the `X-Gitlab-Token` header matched against the provider's `webhookSecret`. The endpoint handles:
- **Push Hooks** — deploys matching applications and compose stacks; respects `watchPaths` filtering using commit file lists (added/modified/removed)
- **Merge Request Hooks** — creates or rebuilds preview deployments on `open/update/reopen/labeled` events; tears down preview deployments on `close/merge` events
If you run into permission issues of docker run the following command If you run into permission issues of docker run the following command
```bash ```bash