Portainer Templates logo

Portainer Templates

Firefly III Firefly III

Stack

Finance

Personal finance manager for tracking what comes in and goes out, with budgets, subscriptions, recurring transactions, rules and reports. This one runs on Postgres. Source: https://github.com/firefly-iii/firefly-iii

Source details

Repo: firefly-iii/firefly-iii
Stars: 24.9k
Forks: 2k
Language: PHP
License: AGPL-3.0
Latest: v6.7.9 · 4 days ago
Updated: 20 hours ago
Website: firefly-iii.org/

Configuration

Type
Compose
Platform
linux
Env vars
FIREFLY_APP_KEY=''FIREFLY_CRON_TOKEN=''FIREFLY_DB_PASSWORD=''FIREFLY_PORT=8092FIREFLY_TZ=UTCFIREFLY_TRUSTED_PROXIES=''
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Fill in all three secrets before you deploy, since the stack won't start without them. The app key and cron token must be exactly 32 characters (openssl rand -hex 16 makes one), and keep all three the same when you redeploy. Then open http://<your-host>:8092 (or whichever port you picked) and register. The first account becomes the admin and sign-ups close after it, so do it straight away. A small cron container pings Firefly III at 03:00 every night, which is what creates recurring transactions and fires subscription reminders. Transactions live in Postgres, in the postgres-data volume, and attachments in firefly-upload. Docs: docs.firefly-iii.org

Services

firefly

Configuration

Image
fireflyiii/core:version-6
Ports
${FIREFLY_PORT:-8092}:8080
Volumes
/var/www/html/storage/upload : firefly-upload
Env vars
APP_KEY=${FIREFLY_APP_KEY:?Set a 32 character app key}STATIC_CRON_TOKEN=${FIREFLY_CRON_TOKEN:?Set a 32 character cron token}TZ=${FIREFLY_TZ:-UTC}TRUSTED_PROXIES=${FIREFLY_TRUSTED_PROXIES:-}DB_CONNECTION=pgsqlDB_HOST=postgresDB_PORT=5432DB_DATABASE=fireflyDB_USERNAME=fireflyDB_PASSWORD=${FIREFLY_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 30.6M
User: jc5x
Created: May 04, 2021
Updated: 1 day ago
Status: active

postgres

Configuration

Image
postgres:17-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=fireflyPOSTGRES_USER=fireflyPOSTGRES_PASSWORD=${FIREFLY_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 11.9B
User: stackbrew
Created: Jun 05, 2014
Updated: 8 days ago
Status: active

cron

Configuration

Image
alpine:3
Command
sh,-c,apk add tzdata && (ln -s /usr/share/zoneinfo/$$TZ /etc/localtime || true) && echo "0 3 * * * wget -qO- http://firefly:8080/api/v1/cron/$$STATIC_CRON_TOKEN;echo" | crontab - && crond -f -L /dev/stdout
Env vars
TZ=${FIREFLY_TZ:-UTC}STATIC_CRON_TOKEN=${FIREFLY_CRON_TOKEN:?Set a 32 character cron token}
Restart
unless-stopped

Image details

Pulls: 12.4B
User: stackbrew
Created: Mar 17, 2015
Updated: 27 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Firefly III

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Firefly III, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  firefly:
    image: fireflyiii/core:version-6
    restart: unless-stopped
    ports:
      - "${FIREFLY_PORT:-8092}:8080"
    environment:
      APP_KEY: ${FIREFLY_APP_KEY:?Set a 32 character app key}
      STATIC_CRON_TOKEN: ${FIREFLY_CRON_TOKEN:?Set a 32 character cron token}
      TZ: ${FIREFLY_TZ:-UTC}
      TRUSTED_PROXIES: ${FIREFLY_TRUSTED_PROXIES:-}
      DB_CONNECTION: pgsql
      DB_HOST: postgres
      DB_PORT: "5432"
      DB_DATABASE: firefly
      DB_USERNAME: firefly
      DB_PASSWORD: ${FIREFLY_DB_PASSWORD:?Set a database password}
    volumes:
      - firefly-upload:/var/www/html/storage/upload
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      POSTGRES_DB: firefly
      POSTGRES_USER: firefly
      POSTGRES_PASSWORD: ${FIREFLY_DB_PASSWORD:?Set a database password}
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U firefly -d firefly"]
      interval: 10s
      timeout: 5s
      retries: 5

  cron:
    image: alpine:3
    restart: unless-stopped
    environment:
      TZ: ${FIREFLY_TZ:-UTC}
      STATIC_CRON_TOKEN: ${FIREFLY_CRON_TOKEN:?Set a 32 character cron token}
    command: ["sh", "-c", "apk add tzdata && (ln -s /usr/share/zoneinfo/$$TZ /etc/localtime || true) && echo \"0 3 * * * wget -qO- http://firefly:8080/api/v1/cron/$$STATIC_CRON_TOKEN;echo\" | crontab - && crond -f -L /dev/stdout"]
    depends_on:
      - firefly

volumes:
  firefly-upload:
  postgres-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/firefly-iii/compose.yml up -d

More install options in our documentation, or see firefly-iii/firefly-iii for app-specific guidance.

Container Documentation

firefly Documentation

Official Firefly III image

postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

cron Documentation

A minimal Docker image based on Alpine Linux with a complete package index and only 5 MB in size!

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Image won't pull

Test the pull directly on the host: docker pull fireflyiii/core:version-6

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Firefly III is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • firefly runs fireflyiii/core:version-6, starts after postgres
  • postgres runs postgres:17-alpine
  • cron runs alpine:3, starts after firefly

Volumes

A volume is where Firefly III keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/www/html/storage/upload kept in the firefly-upload volume Docker manages
  • /var/lib/postgresql/data kept in the postgres-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Firefly III takes 13 of them, and 4 need a value before it'll start properly:

  • APP_KEY, needs a value
  • STATIC_CRON_TOKEN, needs a value
  • TZ, defaults to UTC
  • TRUSTED_PROXIES, pulled from your own environment
  • DB_CONNECTION, defaults to pgsql
  • DB_HOST, defaults to postgres
  • DB_PORT, defaults to 5432
  • DB_DATABASE, defaults to firefly
  • DB_USERNAME, defaults to firefly
  • DB_PASSWORD, needs a value
  • POSTGRES_DB, defaults to firefly
  • POSTGRES_USER, defaults to firefly
  • POSTGRES_PASSWORD, needs a value

Restart policy

The restart policy here is unless-stopped, so Docker restarts Firefly III after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like firefly) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Firefly III is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Firefly III up. Add the template list to Portainer once, then deploying Firefly III is a click rather than a wall of config.