Firefly III Data Importer¶

Description / name	Input element
Your domain name

Overview¶

Firefly III Data Importer is a tool designed to import financial data into the Firefly III personal finance manager.

Manual

Releases

Community

Configuration¶

Connection To Firefly III¶

The Required variables that should be defined in inventory:

To authenticate the Data Importer to Firefly III you require to use either:

Access Token
Client ID

Access Token¶

Firefly III Data Importer Access Token Settings

fireflyiii_importer_docker_envs_custom:
  - FIREFLY_III_ACCESS_TOKEN: ""  # (1)!

Your access token from your instance of Firefly III | Options | Profile | OAuth | Personal Access Tokens | Create New Token.

Client ID¶

Firefly III Data Importer Client ID Settings

fireflyiii_importer_docker_envs_custom:
  - FIREFLY_III_CLIENT_ID: "1"  # (1)!

Your client id from your instance of Firefly III | Options | Profile | OAuth | OAuth Clients | Create New Client.

Note: Your require to leave Confidential unticked

Import data¶

For the following methods, your data need to be formatted in CSV.

Web import¶

You can refer to the following documentation to execute import from the server: web import

Server import¶

You can refer to the following documentation to execute import from the server: CLI import

Additional Settings¶

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

Email Notifications¶

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

Firefly III Data Importer 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)!

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
Replace localhost with your email host. IE: smtp-relay.gmail.com
Replace 25 with your email port. IE: 587
The email address you want to send to. Replace "" with the email address you want to send to
Replace "" with your email username if necessary.
Replace "" with your email password if necessary.
Use SSL or TLS for communication with the SMTP server. Can be true or 'false.

Deployment¶

sb install sandbox-fireflyiii_importer

Usage¶

Visit https://fireflyiii-importer.iYOUR_DOMAIN_NAMEi.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
fireflyiii_importer_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like fireflyiii_importer_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_importer_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

fireflyiii_importer_name

# Type: string
fireflyiii_importer_name: fireflyiii-importer

fireflyiii_importer_role_web_subdomain

# Type: string
fireflyiii_importer_role_web_subdomain: "{{ fireflyiii_importer_name }}"

fireflyiii_importer_role_web_domain

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

fireflyiii_importer_role_web_port

# Type: string
fireflyiii_importer_role_web_port: "8080"

fireflyiii_importer_role_web_url

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

fireflyiii_importer_role_dns_record

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

fireflyiii_importer_role_dns_zone

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

fireflyiii_importer_role_dns_proxy

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

fireflyiii_importer_role_traefik_sso_middleware

# Type: string
fireflyiii_importer_role_traefik_sso_middleware: ""

fireflyiii_importer_role_traefik_middleware_default

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

fireflyiii_importer_role_traefik_middleware_custom

# Type: string
fireflyiii_importer_role_traefik_middleware_custom: ""

fireflyiii_importer_role_traefik_certresolver

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

fireflyiii_importer_role_traefik_enabled

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

fireflyiii_importer_role_traefik_api_enabled

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

fireflyiii_importer_role_traefik_api_endpoint

# Type: string
fireflyiii_importer_role_traefik_api_endpoint: ""

Container

fireflyiii_importer_role_docker_container

# Type: string
fireflyiii_importer_role_docker_container: "{{ fireflyiii_importer_name }}"

Image

fireflyiii_importer_role_docker_image_pull

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

fireflyiii_importer_role_docker_image_repo

# Type: string
fireflyiii_importer_role_docker_image_repo: "fireflyiii/data-importer"

fireflyiii_importer_role_docker_image_tag

# Type: string
fireflyiii_importer_role_docker_image_tag: "latest"

fireflyiii_importer_role_docker_image

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

Envs

fireflyiii_importer_role_docker_envs_default

# Type: dict
fireflyiii_importer_role_docker_envs_default:
  IMPORT_DIR_ALLOWLIST: /import
  FIREFLY_III_URL: "http://{{ fireflyiii_name }}:8080"
  VANITY_URL: "{{ lookup('role_var', '_web_url', role='fireflyiii') }}"
  TRUSTED_PROXIES: "**"
  TZ: "{{ tz }}"

fireflyiii_importer_role_docker_envs_custom

# Type: dict
fireflyiii_importer_role_docker_envs_custom: {}

Volumes

fireflyiii_importer_role_docker_volumes_default

# Type: list
fireflyiii_importer_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='fireflyiii') }}/import:/import"
  - "/etc/timezone:/etc/timezone:ro"
  - "/etc/localtime:/etc/localtime:ro"

fireflyiii_importer_role_docker_volumes_custom

# Type: list
fireflyiii_importer_role_docker_volumes_custom: []

Hostname

fireflyiii_importer_role_docker_hostname

# Type: string
fireflyiii_importer_role_docker_hostname: "{{ fireflyiii_importer_name }}"

Networks

fireflyiii_importer_role_docker_networks_alias

# Type: string
fireflyiii_importer_role_docker_networks_alias: "{{ fireflyiii_importer_name }}"

fireflyiii_importer_role_docker_networks_default

# Type: list
fireflyiii_importer_role_docker_networks_default: []

fireflyiii_importer_role_docker_networks_custom

# Type: list
fireflyiii_importer_role_docker_networks_custom: []

Restart Policy

fireflyiii_importer_role_docker_restart_policy

# Type: string
fireflyiii_importer_role_docker_restart_policy: unless-stopped

State

fireflyiii_importer_role_docker_state

# Type: string
fireflyiii_importer_role_docker_state: started

Dependencies

fireflyiii_importer_role_depends_on

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

fireflyiii_importer_role_depends_on_delay

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

fireflyiii_importer_role_depends_on_healthchecks

# Type: string ("true"/"false")
fireflyiii_importer_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_importer_role_docker_blkio_weight

# Type: int
fireflyiii_importer_role_docker_blkio_weight:

fireflyiii_importer_role_docker_cpu_period

# Type: int
fireflyiii_importer_role_docker_cpu_period:

fireflyiii_importer_role_docker_cpu_quota

# Type: int
fireflyiii_importer_role_docker_cpu_quota:

fireflyiii_importer_role_docker_cpu_shares

# Type: int
fireflyiii_importer_role_docker_cpu_shares:

fireflyiii_importer_role_docker_cpus

# Type: string
fireflyiii_importer_role_docker_cpus:

fireflyiii_importer_role_docker_cpuset_cpus

# Type: string
fireflyiii_importer_role_docker_cpuset_cpus:

fireflyiii_importer_role_docker_cpuset_mems

# Type: string
fireflyiii_importer_role_docker_cpuset_mems:

fireflyiii_importer_role_docker_kernel_memory

# Type: string
fireflyiii_importer_role_docker_kernel_memory:

fireflyiii_importer_role_docker_memory

# Type: string
fireflyiii_importer_role_docker_memory:

fireflyiii_importer_role_docker_memory_reservation

# Type: string
fireflyiii_importer_role_docker_memory_reservation:

fireflyiii_importer_role_docker_memory_swap

# Type: string
fireflyiii_importer_role_docker_memory_swap:

fireflyiii_importer_role_docker_memory_swappiness

# Type: int
fireflyiii_importer_role_docker_memory_swappiness:

fireflyiii_importer_role_docker_shm_size

# Type: string
fireflyiii_importer_role_docker_shm_size:

Security & Devices

fireflyiii_importer_role_docker_cap_drop

# Type: list
fireflyiii_importer_role_docker_cap_drop:

fireflyiii_importer_role_docker_cgroupns_mode

# Type: string
fireflyiii_importer_role_docker_cgroupns_mode:

fireflyiii_importer_role_docker_device_cgroup_rules

# Type: list
fireflyiii_importer_role_docker_device_cgroup_rules:

fireflyiii_importer_role_docker_device_read_bps

# Type: list
fireflyiii_importer_role_docker_device_read_bps:

fireflyiii_importer_role_docker_device_read_iops

# Type: list
fireflyiii_importer_role_docker_device_read_iops:

fireflyiii_importer_role_docker_device_requests

# Type: list
fireflyiii_importer_role_docker_device_requests:

fireflyiii_importer_role_docker_device_write_bps

# Type: list
fireflyiii_importer_role_docker_device_write_bps:

fireflyiii_importer_role_docker_device_write_iops

# Type: list
fireflyiii_importer_role_docker_device_write_iops:

fireflyiii_importer_role_docker_devices

# Type: list
fireflyiii_importer_role_docker_devices:

fireflyiii_importer_role_docker_devices_default

# Type: string
fireflyiii_importer_role_docker_devices_default:

fireflyiii_importer_role_docker_groups

# Type: list
fireflyiii_importer_role_docker_groups:

fireflyiii_importer_role_docker_privileged

# Type: bool (true/false)
fireflyiii_importer_role_docker_privileged:

fireflyiii_importer_role_docker_security_opts

# Type: list
fireflyiii_importer_role_docker_security_opts:

fireflyiii_importer_role_docker_user

# Type: string
fireflyiii_importer_role_docker_user:

fireflyiii_importer_role_docker_userns_mode

# Type: string
fireflyiii_importer_role_docker_userns_mode:

Networking

fireflyiii_importer_role_docker_dns_opts

# Type: list
fireflyiii_importer_role_docker_dns_opts:

fireflyiii_importer_role_docker_dns_search_domains

# Type: list
fireflyiii_importer_role_docker_dns_search_domains:

fireflyiii_importer_role_docker_dns_servers

# Type: list
fireflyiii_importer_role_docker_dns_servers:

fireflyiii_importer_role_docker_domainname

# Type: string
fireflyiii_importer_role_docker_domainname:

fireflyiii_importer_role_docker_exposed_ports

# Type: list
fireflyiii_importer_role_docker_exposed_ports:

fireflyiii_importer_role_docker_hosts

# Type: dict
fireflyiii_importer_role_docker_hosts:

fireflyiii_importer_role_docker_hosts_use_common

# Type: bool (true/false)
fireflyiii_importer_role_docker_hosts_use_common:

fireflyiii_importer_role_docker_ipc_mode

# Type: string
fireflyiii_importer_role_docker_ipc_mode:

fireflyiii_importer_role_docker_links

# Type: list
fireflyiii_importer_role_docker_links:

fireflyiii_importer_role_docker_network_mode

# Type: string
fireflyiii_importer_role_docker_network_mode:

fireflyiii_importer_role_docker_pid_mode

# Type: string
fireflyiii_importer_role_docker_pid_mode:

fireflyiii_importer_role_docker_ports

# Type: list
fireflyiii_importer_role_docker_ports:

fireflyiii_importer_role_docker_uts

# Type: string
fireflyiii_importer_role_docker_uts:

Storage

fireflyiii_importer_role_docker_keep_volumes

# Type: bool (true/false)
fireflyiii_importer_role_docker_keep_volumes:

fireflyiii_importer_role_docker_mounts

# Type: list
fireflyiii_importer_role_docker_mounts:

fireflyiii_importer_role_docker_storage_opts

# Type: dict
fireflyiii_importer_role_docker_storage_opts:

fireflyiii_importer_role_docker_tmpfs

# Type: list
fireflyiii_importer_role_docker_tmpfs:

fireflyiii_importer_role_docker_volume_driver

# Type: string
fireflyiii_importer_role_docker_volume_driver:

fireflyiii_importer_role_docker_volumes_from

# Type: list
fireflyiii_importer_role_docker_volumes_from:

fireflyiii_importer_role_docker_volumes_global

# Type: bool (true/false)
fireflyiii_importer_role_docker_volumes_global:

fireflyiii_importer_role_docker_working_dir

# Type: string
fireflyiii_importer_role_docker_working_dir:

Monitoring & Lifecycle

fireflyiii_importer_role_docker_auto_remove

# Type: bool (true/false)
fireflyiii_importer_role_docker_auto_remove:

fireflyiii_importer_role_docker_cleanup

# Type: bool (true/false)
fireflyiii_importer_role_docker_cleanup:

fireflyiii_importer_role_docker_force_kill

# Type: string
fireflyiii_importer_role_docker_force_kill:

fireflyiii_importer_role_docker_healthcheck

# Type: dict
fireflyiii_importer_role_docker_healthcheck:

fireflyiii_importer_role_docker_healthy_wait_timeout

# Type: int
fireflyiii_importer_role_docker_healthy_wait_timeout:

fireflyiii_importer_role_docker_init

# Type: bool (true/false)
fireflyiii_importer_role_docker_init:

fireflyiii_importer_role_docker_kill_signal

# Type: string
fireflyiii_importer_role_docker_kill_signal:

fireflyiii_importer_role_docker_log_driver

# Type: string
fireflyiii_importer_role_docker_log_driver:

fireflyiii_importer_role_docker_log_options

# Type: dict
fireflyiii_importer_role_docker_log_options:

fireflyiii_importer_role_docker_oom_killer

# Type: bool (true/false)
fireflyiii_importer_role_docker_oom_killer:

fireflyiii_importer_role_docker_oom_score_adj

# Type: int
fireflyiii_importer_role_docker_oom_score_adj:

fireflyiii_importer_role_docker_output_logs

# Type: bool (true/false)
fireflyiii_importer_role_docker_output_logs:

fireflyiii_importer_role_docker_paused

# Type: bool (true/false)
fireflyiii_importer_role_docker_paused:

fireflyiii_importer_role_docker_recreate

# Type: bool (true/false)
fireflyiii_importer_role_docker_recreate:

fireflyiii_importer_role_docker_restart_retries

# Type: int
fireflyiii_importer_role_docker_restart_retries:

fireflyiii_importer_role_docker_stop_timeout

# Type: int
fireflyiii_importer_role_docker_stop_timeout:

Other Options

fireflyiii_importer_role_docker_capabilities

# Type: list
fireflyiii_importer_role_docker_capabilities:

fireflyiii_importer_role_docker_cgroup_parent

# Type: string
fireflyiii_importer_role_docker_cgroup_parent:

fireflyiii_importer_role_docker_commands

# Type: list
fireflyiii_importer_role_docker_commands:

fireflyiii_importer_role_docker_create_timeout

# Type: int
fireflyiii_importer_role_docker_create_timeout:

fireflyiii_importer_role_docker_entrypoint

# Type: string
fireflyiii_importer_role_docker_entrypoint:

fireflyiii_importer_role_docker_env_file

# Type: string
fireflyiii_importer_role_docker_env_file:

fireflyiii_importer_role_docker_labels

# Type: dict
fireflyiii_importer_role_docker_labels:

fireflyiii_importer_role_docker_labels_use_common

# Type: bool (true/false)
fireflyiii_importer_role_docker_labels_use_common:

fireflyiii_importer_role_docker_read_only

# Type: bool (true/false)
fireflyiii_importer_role_docker_read_only:

fireflyiii_importer_role_docker_runtime

# Type: string
fireflyiii_importer_role_docker_runtime:

fireflyiii_importer_role_docker_sysctls

# Type: list
fireflyiii_importer_role_docker_sysctls:

fireflyiii_importer_role_docker_ulimits

# Type: list
fireflyiii_importer_role_docker_ulimits:

fireflyiii_importer_role_autoheal_enabled

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

fireflyiii_importer_role_depends_on

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

fireflyiii_importer_role_depends_on_delay

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

fireflyiii_importer_role_depends_on_healthchecks

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

fireflyiii_importer_role_diun_enabled

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

fireflyiii_importer_role_dns_enabled

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

fireflyiii_importer_role_docker_controller

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

fireflyiii_importer_role_docker_image_repo

# Type: string
fireflyiii_importer_role_docker_image_repo:

fireflyiii_importer_role_docker_image_tag

# Type: string
fireflyiii_importer_role_docker_image_tag:

fireflyiii_importer_role_docker_volumes_download

# Type: bool (true/false)
fireflyiii_importer_role_docker_volumes_download:

fireflyiii_importer_role_paths_location

# Type: string
fireflyiii_importer_role_paths_location:

fireflyiii_importer_role_themepark_addons

# Type: string
fireflyiii_importer_role_themepark_addons:

fireflyiii_importer_role_themepark_app

# Type: string
fireflyiii_importer_role_themepark_app:

fireflyiii_importer_role_themepark_theme

# Type: string
fireflyiii_importer_role_themepark_theme:

fireflyiii_importer_role_traefik_api_endpoint

# Type: dict/omit
fireflyiii_importer_role_traefik_api_endpoint:

fireflyiii_importer_role_traefik_api_middleware

# Type: string
fireflyiii_importer_role_traefik_api_middleware:

fireflyiii_importer_role_traefik_api_middleware_http

# Type: string
fireflyiii_importer_role_traefik_api_middleware_http:

fireflyiii_importer_role_traefik_autodetect_enabled

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

fireflyiii_importer_role_traefik_certresolver

# Type: string
fireflyiii_importer_role_traefik_certresolver:

fireflyiii_importer_role_traefik_crowdsec_enabled

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

fireflyiii_importer_role_traefik_error_pages_enabled

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

fireflyiii_importer_role_traefik_gzip_enabled

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

fireflyiii_importer_role_traefik_middleware_http

# Type: string
fireflyiii_importer_role_traefik_middleware_http:

fireflyiii_importer_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
fireflyiii_importer_role_traefik_middleware_http_api_insecure:

fireflyiii_importer_role_traefik_middleware_http_insecure

# Type: bool (true/false)
fireflyiii_importer_role_traefik_middleware_http_insecure:

fireflyiii_importer_role_traefik_priority

# Type: string
fireflyiii_importer_role_traefik_priority:

fireflyiii_importer_role_traefik_robot_enabled

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

fireflyiii_importer_role_traefik_tailscale_enabled

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

fireflyiii_importer_role_traefik_wildcard_enabled

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

fireflyiii_importer_role_web_domain

# Type: string
fireflyiii_importer_role_web_domain:

fireflyiii_importer_role_web_fqdn_override

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

Example Override

fireflyiii_importer_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "fireflyiii_importer2.{{ user.domain }}"
  - "fireflyiii_importer.otherdomain.tld"

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

fireflyiii_importer_role_web_host_override

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

Example Override

fireflyiii_importer_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'fireflyiii_importer2.' + user.domain }}`)"

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

fireflyiii_importer_role_web_http_port

# Type: string (quoted number)
fireflyiii_importer_role_web_http_port:

fireflyiii_importer_role_web_http_scheme

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

fireflyiii_importer_role_web_http_serverstransport

# Type: dict/omit
fireflyiii_importer_role_web_http_serverstransport:

fireflyiii_importer_role_web_scheme

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

fireflyiii_importer_role_web_serverstransport

# Type: dict/omit
fireflyiii_importer_role_web_serverstransport:

fireflyiii_importer_role_web_subdomain

# Type: string
fireflyiii_importer_role_web_subdomain:

fireflyiii_importer_role_web_url

# Type: string
fireflyiii_importer_role_web_url: