Skip to content

feat: add Firefly III template - #885

Closed
BinkyTwin wants to merge 3 commits into
Dokploy:canaryfrom
BinkyTwin:codex/add-firefly-iii-template
Closed

BinkyTwin wants to merge 3 commits into
Dokploy:canaryfrom
BinkyTwin:codex/add-firefly-iii-template

Conversation

@BinkyTwin

Copy link
Copy Markdown
Contributor

/claim #152

Summary

  • add a Firefly III template for self-hosted personal finance management
  • include MariaDB persistence, the Firefly III Data Importer, and the scheduled cron trigger used by the official Docker setup
  • configure Dokploy domains for the main app and importer, generated app/cron secrets, database credentials, timezone, and language

Closes #873.
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/firefly-iii
  • node --import ./build-scripts/node_modules/tsx/dist/loader.mjs build-scripts/validate-docker-compose.ts --file blueprints/firefly-iii/docker-compose.yml
  • git diff --check
  • docker compose -f blueprints/firefly-iii/docker-compose.yml config
  • docker manifest inspect fireflyiii/core:version-6.6.2
  • docker manifest inspect fireflyiii/data-importer:version-2.3.2
  • docker manifest inspect mariadb:11.8
  • docker manifest inspect alpine:3.22

Copilot AI review requested due to automatic review settings May 20, 2026 19:43
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. template New template request labels May 20, 2026
@BinkyTwin BinkyTwin mentioned this pull request May 20, 2026
@github-actions

github-actions Bot commented May 20, 2026 •

Copy link
Copy Markdown
built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
templates ✅ Ready (View Log) Visit Preview 89b22cc

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 deploying Firefly III (personal finance manager) with its MariaDB database, the official data importer, and a scheduled cron-trigger container, plus the corresponding metadata entry.

Changes:

  • Added blueprints/firefly-iii/ including docker-compose.yml, template.toml, and a logo asset.
  • Configured Dokploy domains and environment variables (app URL/keys, DB credentials, timezone, language, cron token).
  • Registered the new template in meta.json with links, tags, and version.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.

File Description
meta.json Adds the firefly-iii entry to the central templates index.
blueprints/firefly-iii/template.toml Defines variables, Dokploy domain routing for app/importer, and environment wiring.
blueprints/firefly-iii/docker-compose.yml Introduces the Firefly III + MariaDB + importer + cron service stack.
blueprints/firefly-iii/firefly-iii.svg Adds the template logo referenced by meta.json.

- 8080
environment:
FIREFLY_III_URL: http://firefly-iii:8080
VANITY_URL: ${APP_URL}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated in 4860544: VANITY_URL now uses an explicit FIREFLY_III_VANITY_URL env var instead of reusing APP_URL directly.

I kept the default value pointed at the public Firefly III app URL (http://${main_domain}), because the Firefly III data-importer docs describe FIREFLY_III_URL as the internal Docker URL and VANITY_URL as the public URL the importer should use when linking back to Firefly III: https://docs.firefly-iii.org/how-to/data-importer/installation/docker/

Comment thread blueprints/firefly-iii/template.toml
@Siumauricio

Copy link
Copy Markdown
Contributor

Automated template check 🤖

This PR's template was imported into a test Dokploy instance (using the docker-compose.yml + template.toml from the PR head) and deployed, and its configured domains were then checked over HTTP.

Result: ❌ some issues need attention

firefly-iii

  • Deploy: done (61s)
  • Domain checks:
    • firefly-iii:8080 → HTTP 500 ❌
    • firefly-iii-importer:8080 → HTTP 200 ✅
  • Container states at failure time: firefly-iii-importer-1: running · firefly-iii-cron-1: running · firefly-iii-1: running · firefly-iii-db-1: running
  • Issues:
    • domain check failed for service firefly-iii:8080 (path /): kept returning HTTP 500 for 3 minutes after the deploy finished

The test service is removed automatically after verification. Happy to re-test once the PR is updated.

…ii-template

# Conflicts:
#	blueprints/firefly-iii/docker-compose.yml
#	blueprints/firefly-iii/template.toml
#	meta.json
Copilot AI review requested due to automatic review settings July 8, 2026 06:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review is ineligible. To be eligible to request a review, you need a paid Copilot license, or your organization must enable Copilot code review.

@Siumauricio

Copy link
Copy Markdown
Contributor

Closing — a Firefly III template was already merged in #941 and is available in the repo (fireflyiii/core version-6.6.3). Thanks for the contribution!

@Siumauricio Siumauricio closed this Jul 8, 2026

This branch was successfully deployed

1 active deployment
Preview — 89b22ccb Deployed Jul 8, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Firefly III

3 participants