lms/specs/001-add-dokploy-deploy/quickstart.md

26 lines
944 B
Markdown

# Quickstart: Verify Dokploy deployment for this repo
This quickstart describes the minimal steps to verify Dokploy pulls the repo's `docker-compose.yml` and deploys the application.
Prerequisites:
- Dokploy project configured with project-level secrets (see checklists/deployment-credentials.md)
- Dokploy webhook URL: https://system.cloudarix.de/api/deploy/compose/JXSdfeHdc6wBKUEiJrX_9
- Repository contains `docker-compose.yml` at repository root
Steps:
1. Push a test commit to `main`:
```bash
git checkout main
git pull
git commit --allow-empty -m "test dokploy webhook"
git push origin main
```
2. Wait for Dokploy to receive the webhook and start a deployment (watch Dokploy UI or check the project runs).
3. Verify the deployment run completes and application healthchecks succeed (e.g., curl the app endpoint or check service logs).
4. If deployment fails, gather logs from Dokploy run and follow `runbooks/failed-deploy.md`.