ahmido/lms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
e949f7e175
lms/specs/001-add-dokploy-deploy/dokploy-config.md

1.1 KiB
Raw Blame History

Dokploy Configuration Recommendations

Repository & Branch

  • repository: Gitea clone URL (SSH or HTTPS)
  • branch: main (default automatic deploy branch)
  • compose_path: docker-compose.yml (repo root)

Secrets

  • REPO_DEPLOY_KEY (SSH private key or token) — Dokploy project-level secret used to clone private repos
  • REGISTRY_USERNAME, REGISTRY_PASSWORD — optional registry credentials stored as Dokploy secrets

Sample Dokploy project snippet (conceptual)

project:
  repository: git@gitea.example.com:org/repo.git
  branch: main
  compose_path: docker-compose.yml
  secrets:
    - name: REPO_DEPLOY_KEY
      type: ssh_key
    - name: REGISTRY_PASSWORD
      type: masked
  healthcheck:
    url: https://your-app.example.com/health
    timeout_seconds: 600

Timeouts & Limits

  • Recommended job timeout: 10 minutes (adjust for heavier builds)
  • Allow Dokploy to stream logs and preserve logs on failure for troubleshooting

Notes

  • Ensure Dokploy runner has network access to Gitea and any external registries.
  • Reference Dokploy secrets by name in project configuration rather than embedding credentials in compose files.