Skip to content

feat: add Paperless-ngx and Gatus templates#884

Open
BinkyTwin wants to merge 3 commits into
Dokploy:canaryfrom
BinkyTwin:codex/add-paperless-ngx-template
Open

feat: add Paperless-ngx and Gatus templates#884
BinkyTwin wants to merge 3 commits into
Dokploy:canaryfrom
BinkyTwin:codex/add-paperless-ngx-template

Conversation

@BinkyTwin
Copy link
Copy Markdown

@BinkyTwin BinkyTwin commented May 20, 2026

/claim #152

Summary

  • add a Paperless-ngx template for self-hosted document management and OCR workflows
  • add a Gatus template for self-hosted endpoint monitoring and status dashboards
  • use pinned application/database/cache images with persistent volumes where needed
  • configure Dokploy domain/env/mount settings for generated secrets, public app URLs, SQLite persistence, and editable app configuration

Refs #152 as a partial template-bounty contribution.

Verification

  • node dedupe-and-sort-meta.js
  • node --import ./build-scripts/node_modules/tsx/dist/loader.mjs build-scripts/validate-template.ts --dir blueprints/paperless-ngx
  • node --import ./build-scripts/node_modules/tsx/dist/loader.mjs build-scripts/validate-template.ts --dir blueprints/gatus
  • node --import ./build-scripts/node_modules/tsx/dist/loader.mjs build-scripts/validate-docker-compose.ts --file blueprints/paperless-ngx/docker-compose.yml
  • node --import ./build-scripts/node_modules/tsx/dist/loader.mjs build-scripts/validate-docker-compose.ts --file blueprints/gatus/docker-compose.yml
  • git diff --check
  • docker compose -f blueprints/paperless-ngx/docker-compose.yml config
  • docker compose -f blueprints/gatus/docker-compose.yml config
  • docker manifest inspect ghcr.io/paperless-ngx/paperless-ngx:2.20.15
  • docker manifest inspect postgres:18-alpine
  • docker manifest inspect redis:8-alpine
  • docker manifest inspect ghcr.io/twin/gatus:v5.36.0

Copilot AI review requested due to automatic review settings May 20, 2026 19:16
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. new-template labels May 20, 2026
@github-actions
Copy link
Copy Markdown

ghost commented May 20, 2026

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
templates ✅ Ready (View Log) Visit Preview 7e5691b

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Dokploy blueprint for Paperless-ngx (document management + OCR), including its compose stack, Dokploy template configuration, logo asset, and a new meta.json entry so it appears in the central template index.

Changes:

  • Added paperless-ngx blueprint with Docker Compose services (Paperless-ngx + Postgres + Redis) and persistent volumes.
  • Added Dokploy template.toml for domain/env variable wiring (URL, secret key, DB password, timezone, OCR language).
  • Registered the template in meta.json and added a paperless-ngx.svg logo.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

File Description
meta.json Adds the Paperless-ngx template entry (id/name/version/links/tags/logo).
blueprints/paperless-ngx/docker-compose.yml Defines Paperless-ngx + Postgres + Redis stack with healthchecks and volumes.
blueprints/paperless-ngx/template.toml Defines Dokploy variables, domain mapping, and env injection for the compose stack.
blueprints/paperless-ngx/paperless-ngx.svg Adds the template logo asset referenced by meta.json.

Comment thread blueprints/paperless-ngx/template.toml Outdated
main_domain = "${domain}"
postgres_password = "${password:32}"
paperless_secret_key = "${password:64}"
paperless_url = "https://${main_domain}"
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adjusted in 0c3d1cc: the default PAPERLESS_URL now uses http://${main_domain} to match the repository convention for app URL env vars behind Dokploy. Re-ran template validation, Docker Compose validation, metadata processing, git diff --check, and docker compose config with the updated URL.

Copilot AI review requested due to automatic review settings May 20, 2026 19:26
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels May 20, 2026
@BinkyTwin BinkyTwin changed the title feat: add Paperless-ngx template feat: add Paperless-ngx and Gatus templates May 20, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 7 changed files in this pull request and generated 1 comment.

Comment thread meta.json
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🙋 Bounty claim new-template size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants