Firefly III

Description / name	Input element
Your domain name

Overview

Firefly III is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. Firefly III supports the use of budgets, categories and tags. Using a bunch of external tools, you can import data. It also has many neat financial reports available.

Manual

Releases

Community

---

Configuration

• The default installation utilises a seperate postgres database.
• This will install the fireflyiii core container and install the mariadb database

• Note: It can be installed using postgresql and mysql

• It will by default enable webhooks

Note: For all available settings please refer to the Firefly III example env

Email Notifications

To enable email notifications, set the following inventory entries to your desired values:

Firefly III Email Settings

MAIL_MAILER: "log"  # (1)!
MAIL_HOST: "localhost"  # (2)!
MAIL_PORT: "25"  # (3)!
MAIL_FROM: "fireflyiii@domain.com"  # (4)!
MAIL_USERNAME: ""  # (5)!
MAIL_PASSWORD: ""  # (6)!
MAIN_ENCRYPTION: ""  # (7)!

1. The MAIL_MAILER-setting indicates the system that is used for mailing. Firefly III supports the following mail systems: smtp, sendmail, mailgun, mandrill, sparkpost and log. Here is an explanation about each MAIL_MAILER option
2. Replace localhost with your email host. IE: smtp-relay.gmail.com
3. Replace 25 with your email port. IE: 587
4. The email address you want to send to. Replace "" with the email address you want to send to
5. Replace "" with your email username if necessary.
6. Replace "" with your email password if necessary.
7. Use SSL or TLS for communication with the SMTP server. Can be true or 'false.

Deployment

sb install sandbox-fireflyiii

Usage

Visit https://fireflyiii.iYOUR_DOMAIN_NAMEi.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   fireflyiii_name: "custom_value"
   

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like fireflyiii_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

   Instead, use the corresponding _custom variable (like fireflyiii_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

fireflyiii_name

# Type: string
fireflyiii_name: fireflyiii

fireflyiii_role_mariadb_name

# Type: string
fireflyiii_role_mariadb_name: "{{ fireflyiii_name }}-mariadb"

fireflyiii_role_mariadb_paths_folder

# Type: string
fireflyiii_role_mariadb_paths_folder: "{{ fireflyiii_name }}"

fireflyiii_role_mariadb_paths_location

# Type: string
fireflyiii_role_mariadb_paths_location: "{{ server_appdata_path }}/{{ lookup('role_var', '_paths_folder', role='mariadb') }}/mariadb"

fireflyiii_role_mariadb_docker_image_tag

# Type: string
fireflyiii_role_mariadb_docker_image_tag: "lts"

fireflyiii_role_mariadb_docker_env_password

# Type: string
fireflyiii_role_mariadb_docker_env_password: "{{ fireflyiii_db_password_saltbox_facts.facts.secret_key }}"

fireflyiii_role_mariadb_docker_env_db

# Type: string
fireflyiii_role_mariadb_docker_env_db: "{{ fireflyiii_name }}-mariadb"

fireflyiii_role_web_subdomain

# Type: string
fireflyiii_role_web_subdomain: "{{ fireflyiii_name }}"

fireflyiii_role_web_domain

# Type: string
fireflyiii_role_web_domain: "{{ user.domain }}"

fireflyiii_role_web_port

# Type: string
fireflyiii_role_web_port: "8080"

fireflyiii_role_web_url

# Type: string
fireflyiii_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='fireflyiii') + '.' + lookup('role_var', '_web_domain', role='fireflyiii')
                          if (lookup('role_var', '_web_subdomain', role='fireflyiii') | length > 0)
                          else lookup('role_var', '_web_domain', role='fireflyiii')) }}"

fireflyiii_role_dns_record

# Type: string
fireflyiii_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='fireflyiii') }}"

fireflyiii_role_dns_zone

# Type: string
fireflyiii_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='fireflyiii') }}"

fireflyiii_role_dns_proxy

# Type: bool (true/false)
fireflyiii_role_dns_proxy: "{{ dns_proxied }}"

fireflyiii_role_traefik_sso_middleware

# Type: string
fireflyiii_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

fireflyiii_role_traefik_middleware_default

# Type: string
fireflyiii_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

fireflyiii_role_traefik_middleware_custom

# Type: string
fireflyiii_role_traefik_middleware_custom: ""

fireflyiii_role_traefik_certresolver

# Type: string
fireflyiii_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

fireflyiii_role_traefik_enabled

# Type: bool (true/false)
fireflyiii_role_traefik_enabled: true

fireflyiii_role_traefik_api_enabled

# Type: bool (true/false)
fireflyiii_role_traefik_api_enabled: true

fireflyiii_role_traefik_api_endpoint

# Type: string
fireflyiii_role_traefik_api_endpoint: "PathPrefix(`/api`)"

Container

fireflyiii_role_docker_container

# Type: string
fireflyiii_role_docker_container: "{{ fireflyiii_name }}"

Image

fireflyiii_role_docker_image_pull

# Type: bool (true/false)
fireflyiii_role_docker_image_pull: true

fireflyiii_role_docker_image_repo

# Type: string
fireflyiii_role_docker_image_repo: "fireflyiii/core"

fireflyiii_role_docker_image_tag

# Type: string
fireflyiii_role_docker_image_tag: "latest"

fireflyiii_role_docker_image

# Type: string
fireflyiii_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='fireflyiii') }}:{{ lookup('role_var', '_docker_image_tag', role='fireflyiii') }}"

Envs

fireflyiii_role_docker_envs_default

# Type: dict
fireflyiii_role_docker_envs_default:
  APP_ENV: "production"
  SITE_OWNER: "{{ user.email }}"
  APP_KEY: "{{ fireflyiii_appkey_saltbox_facts.facts.secret_key }}"
  DEFAULT_LANGUAGE: "en_US"
  DEFAULT_LOCALE: "equal"
  TZ: "{{ tz }}"
  TRUSTED_PROXIES: "**"
  LOG_CHANNEL: "stack"
  APP_LOG_LEVEL: "notice"
  AUDIT_LOG_LEVEL: "emergency"
  DB_CONNECTION: "mysql"
  DB_HOST: "{{ fireflyiii_name }}-mariadb"
  DB_PORT: "3306"
  DB_DATABASE: fireflyiii
  DB_USERNAME: "root"
  DB_PASSWORD: "{{ fireflyiii_db_password_saltbox_facts.facts.secret_key }}"
  AUTHENTICATION_GUARD: "web"
  APP_URL: "{{ lookup('role_var', '_web_url', role='fireflyiii') }}"
  ALLOW_WEBHOOKS: "True"

fireflyiii_role_docker_envs_custom

# Type: dict
fireflyiii_role_docker_envs_custom: {}

Volumes

fireflyiii_role_docker_volumes_default

# Type: list
fireflyiii_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='fireflyiii') }}/upload:/var/www/html/storage/upload"
  - /etc/timezone:/etc/timezone:ro
  - /etc/localtime:/etc/localtime:ro

fireflyiii_role_docker_volumes_custom

# Type: list
fireflyiii_role_docker_volumes_custom: []

Hostname

fireflyiii_role_docker_hostname

# Type: string
fireflyiii_role_docker_hostname: "{{ fireflyiii_name }}"

Networks

fireflyiii_role_docker_networks_alias

# Type: string
fireflyiii_role_docker_networks_alias: "{{ fireflyiii_name }}"

fireflyiii_role_docker_networks_default

# Type: list
fireflyiii_role_docker_networks_default: []

fireflyiii_role_docker_networks_custom

# Type: list
fireflyiii_role_docker_networks_custom: []

Restart Policy

fireflyiii_role_docker_restart_policy

# Type: string
fireflyiii_role_docker_restart_policy: unless-stopped

State

fireflyiii_role_docker_state

# Type: string
fireflyiii_role_docker_state: started

Dependencies

fireflyiii_role_depends_on

# Type: string
fireflyiii_role_depends_on: "{{ fireflyiii_name }}-mariadb"

fireflyiii_role_depends_on_delay

# Type: string (quoted number)
fireflyiii_role_depends_on_delay: "0"

fireflyiii_role_depends_on_healthchecks

# Type: string ("true"/"false")
fireflyiii_role_depends_on_healthchecks: "false"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

fireflyiii_role_docker_blkio_weight

# Type: int
fireflyiii_role_docker_blkio_weight:

fireflyiii_role_docker_cpu_period

# Type: int
fireflyiii_role_docker_cpu_period:

fireflyiii_role_docker_cpu_quota

# Type: int
fireflyiii_role_docker_cpu_quota:

fireflyiii_role_docker_cpu_shares

# Type: int
fireflyiii_role_docker_cpu_shares:

fireflyiii_role_docker_cpus

# Type: string
fireflyiii_role_docker_cpus:

fireflyiii_role_docker_cpuset_cpus

# Type: string
fireflyiii_role_docker_cpuset_cpus:

fireflyiii_role_docker_cpuset_mems

# Type: string
fireflyiii_role_docker_cpuset_mems:

fireflyiii_role_docker_kernel_memory

# Type: string
fireflyiii_role_docker_kernel_memory:

fireflyiii_role_docker_memory

# Type: string
fireflyiii_role_docker_memory:

fireflyiii_role_docker_memory_reservation

# Type: string
fireflyiii_role_docker_memory_reservation:

fireflyiii_role_docker_memory_swap

# Type: string
fireflyiii_role_docker_memory_swap:

fireflyiii_role_docker_memory_swappiness

# Type: int
fireflyiii_role_docker_memory_swappiness:

fireflyiii_role_docker_shm_size

# Type: string
fireflyiii_role_docker_shm_size:

Security & Devices

fireflyiii_role_docker_cap_drop

# Type: list
fireflyiii_role_docker_cap_drop:

fireflyiii_role_docker_cgroupns_mode

# Type: string
fireflyiii_role_docker_cgroupns_mode:

fireflyiii_role_docker_device_cgroup_rules

# Type: list
fireflyiii_role_docker_device_cgroup_rules:

fireflyiii_role_docker_device_read_bps

# Type: list
fireflyiii_role_docker_device_read_bps:

fireflyiii_role_docker_device_read_iops

# Type: list
fireflyiii_role_docker_device_read_iops:

fireflyiii_role_docker_device_requests

# Type: list
fireflyiii_role_docker_device_requests:

fireflyiii_role_docker_device_write_bps

# Type: list
fireflyiii_role_docker_device_write_bps:

fireflyiii_role_docker_device_write_iops

# Type: list
fireflyiii_role_docker_device_write_iops:

fireflyiii_role_docker_devices

# Type: list
fireflyiii_role_docker_devices:

fireflyiii_role_docker_devices_default

# Type: string
fireflyiii_role_docker_devices_default:

fireflyiii_role_docker_groups

# Type: list
fireflyiii_role_docker_groups:

fireflyiii_role_docker_privileged

# Type: bool (true/false)
fireflyiii_role_docker_privileged:

fireflyiii_role_docker_security_opts

# Type: list
fireflyiii_role_docker_security_opts:

fireflyiii_role_docker_user

# Type: string
fireflyiii_role_docker_user:

fireflyiii_role_docker_userns_mode

# Type: string
fireflyiii_role_docker_userns_mode:

Networking

fireflyiii_role_docker_dns_opts

# Type: list
fireflyiii_role_docker_dns_opts:

fireflyiii_role_docker_dns_search_domains

# Type: list
fireflyiii_role_docker_dns_search_domains:

fireflyiii_role_docker_dns_servers

# Type: list
fireflyiii_role_docker_dns_servers:

fireflyiii_role_docker_domainname

# Type: string
fireflyiii_role_docker_domainname:

fireflyiii_role_docker_exposed_ports

# Type: list
fireflyiii_role_docker_exposed_ports:

fireflyiii_role_docker_hosts

# Type: dict
fireflyiii_role_docker_hosts:

fireflyiii_role_docker_hosts_use_common

# Type: bool (true/false)
fireflyiii_role_docker_hosts_use_common:

fireflyiii_role_docker_ipc_mode

# Type: string
fireflyiii_role_docker_ipc_mode:

fireflyiii_role_docker_links

# Type: list
fireflyiii_role_docker_links:

fireflyiii_role_docker_network_mode

# Type: string
fireflyiii_role_docker_network_mode:

fireflyiii_role_docker_pid_mode

# Type: string
fireflyiii_role_docker_pid_mode:

fireflyiii_role_docker_ports

# Type: list
fireflyiii_role_docker_ports:

fireflyiii_role_docker_uts

# Type: string
fireflyiii_role_docker_uts:

Storage

fireflyiii_role_docker_keep_volumes

# Type: bool (true/false)
fireflyiii_role_docker_keep_volumes:

fireflyiii_role_docker_mounts

# Type: list
fireflyiii_role_docker_mounts:

fireflyiii_role_docker_storage_opts

# Type: dict
fireflyiii_role_docker_storage_opts:

fireflyiii_role_docker_tmpfs

# Type: list
fireflyiii_role_docker_tmpfs:

fireflyiii_role_docker_volume_driver

# Type: string
fireflyiii_role_docker_volume_driver:

fireflyiii_role_docker_volumes_from

# Type: list
fireflyiii_role_docker_volumes_from:

fireflyiii_role_docker_volumes_global

# Type: bool (true/false)
fireflyiii_role_docker_volumes_global:

fireflyiii_role_docker_working_dir

# Type: string
fireflyiii_role_docker_working_dir:

Monitoring & Lifecycle

fireflyiii_role_docker_auto_remove

# Type: bool (true/false)
fireflyiii_role_docker_auto_remove:

fireflyiii_role_docker_cleanup

# Type: bool (true/false)
fireflyiii_role_docker_cleanup:

fireflyiii_role_docker_force_kill

# Type: string
fireflyiii_role_docker_force_kill:

fireflyiii_role_docker_healthcheck

# Type: dict
fireflyiii_role_docker_healthcheck:

fireflyiii_role_docker_healthy_wait_timeout

# Type: int
fireflyiii_role_docker_healthy_wait_timeout:

fireflyiii_role_docker_init

# Type: bool (true/false)
fireflyiii_role_docker_init:

fireflyiii_role_docker_kill_signal

# Type: string
fireflyiii_role_docker_kill_signal:

fireflyiii_role_docker_log_driver

# Type: string
fireflyiii_role_docker_log_driver:

fireflyiii_role_docker_log_options

# Type: dict
fireflyiii_role_docker_log_options:

fireflyiii_role_docker_oom_killer

# Type: bool (true/false)
fireflyiii_role_docker_oom_killer:

fireflyiii_role_docker_oom_score_adj

# Type: int
fireflyiii_role_docker_oom_score_adj:

fireflyiii_role_docker_output_logs

# Type: bool (true/false)
fireflyiii_role_docker_output_logs:

fireflyiii_role_docker_paused

# Type: bool (true/false)
fireflyiii_role_docker_paused:

fireflyiii_role_docker_recreate

# Type: bool (true/false)
fireflyiii_role_docker_recreate:

fireflyiii_role_docker_restart_retries

# Type: int
fireflyiii_role_docker_restart_retries:

fireflyiii_role_docker_stop_timeout

# Type: int
fireflyiii_role_docker_stop_timeout:

Other Options

fireflyiii_role_docker_capabilities

# Type: list
fireflyiii_role_docker_capabilities:

fireflyiii_role_docker_cgroup_parent

# Type: string
fireflyiii_role_docker_cgroup_parent:

fireflyiii_role_docker_commands

# Type: list
fireflyiii_role_docker_commands:

fireflyiii_role_docker_create_timeout

# Type: int
fireflyiii_role_docker_create_timeout:

fireflyiii_role_docker_entrypoint

# Type: string
fireflyiii_role_docker_entrypoint:

fireflyiii_role_docker_env_file

# Type: string
fireflyiii_role_docker_env_file:

fireflyiii_role_docker_labels

# Type: dict
fireflyiii_role_docker_labels:

fireflyiii_role_docker_labels_use_common

# Type: bool (true/false)
fireflyiii_role_docker_labels_use_common:

fireflyiii_role_docker_read_only

# Type: bool (true/false)
fireflyiii_role_docker_read_only:

fireflyiii_role_docker_runtime

# Type: string
fireflyiii_role_docker_runtime:

fireflyiii_role_docker_sysctls

# Type: list
fireflyiii_role_docker_sysctls:

fireflyiii_role_docker_ulimits

# Type: list
fireflyiii_role_docker_ulimits:

fireflyiii_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
fireflyiii_role_autoheal_enabled: true

fireflyiii_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
fireflyiii_role_depends_on: ""

fireflyiii_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
fireflyiii_role_depends_on_delay: "0"

fireflyiii_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
fireflyiii_role_depends_on_healthchecks:

fireflyiii_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
fireflyiii_role_diun_enabled: true

fireflyiii_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
fireflyiii_role_dns_enabled: true

fireflyiii_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
fireflyiii_role_docker_controller: true

fireflyiii_role_docker_image_repo

# Type: string
fireflyiii_role_docker_image_repo:

fireflyiii_role_docker_image_tag

# Type: string
fireflyiii_role_docker_image_tag:

fireflyiii_role_docker_volumes_download

# Type: bool (true/false)
fireflyiii_role_docker_volumes_download:

fireflyiii_role_paths_folder

# Type: string
fireflyiii_role_paths_folder:

fireflyiii_role_paths_location

# Type: string
fireflyiii_role_paths_location:

fireflyiii_role_themepark_addons

# Type: string
fireflyiii_role_themepark_addons:

fireflyiii_role_themepark_app

# Type: string
fireflyiii_role_themepark_app:

fireflyiii_role_themepark_theme

# Type: string
fireflyiii_role_themepark_theme:

fireflyiii_role_traefik_api_endpoint

# Type: dict/omit
fireflyiii_role_traefik_api_endpoint:

fireflyiii_role_traefik_api_middleware

# Type: string
fireflyiii_role_traefik_api_middleware:

fireflyiii_role_traefik_api_middleware_http

# Type: string
fireflyiii_role_traefik_api_middleware_http:

fireflyiii_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
fireflyiii_role_traefik_autodetect_enabled: false

fireflyiii_role_traefik_certresolver

# Type: string
fireflyiii_role_traefik_certresolver:

fireflyiii_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
fireflyiii_role_traefik_crowdsec_enabled: false

fireflyiii_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
fireflyiii_role_traefik_error_pages_enabled: false

fireflyiii_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
fireflyiii_role_traefik_gzip_enabled: false

fireflyiii_role_traefik_middleware_http

# Type: string
fireflyiii_role_traefik_middleware_http:

fireflyiii_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
fireflyiii_role_traefik_middleware_http_api_insecure:

fireflyiii_role_traefik_middleware_http_insecure

# Type: bool (true/false)
fireflyiii_role_traefik_middleware_http_insecure:

fireflyiii_role_traefik_priority

# Type: string
fireflyiii_role_traefik_priority:

fireflyiii_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
fireflyiii_role_traefik_robot_enabled: true

fireflyiii_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
fireflyiii_role_traefik_tailscale_enabled: false

fireflyiii_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
fireflyiii_role_traefik_wildcard_enabled: true

fireflyiii_role_web_domain

# Type: string
fireflyiii_role_web_domain:

fireflyiii_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
fireflyiii_role_web_fqdn_override:

Example Override

fireflyiii_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "fireflyiii2.{{ user.domain }}"
  - "fireflyiii.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

fireflyiii_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
fireflyiii_role_web_host_override:

Example Override

fireflyiii_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'fireflyiii2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

fireflyiii_role_web_http_port

# Type: string (quoted number)
fireflyiii_role_web_http_port:

fireflyiii_role_web_http_scheme

# Type: string ("http"/"https")
fireflyiii_role_web_http_scheme:

fireflyiii_role_web_http_serverstransport

# Type: dict/omit
fireflyiii_role_web_http_serverstransport:

fireflyiii_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
fireflyiii_role_web_scheme:

fireflyiii_role_web_serverstransport

# Type: dict/omit
fireflyiii_role_web_serverstransport:

fireflyiii_role_web_subdomain

# Type: string
fireflyiii_role_web_subdomain:

fireflyiii_role_web_url

# Type: string
fireflyiii_role_web_url: