---
argument_specs:
  main:
    short_description: Install and configure Firefly III
    description:
      - Install and configure [Firefly III](https://www.firefly-iii.org/).
    author:
      - jriou
    options:
      firefly_version:
        description:
          - Version of the docker image.
        default: latest

      firefly_port:
        descritpion:
          - Port to listen.
        type: int
        default: 8080

      firefly_static_cron_token:
        description:
          - Token used by the cron job (sensitive).
        required: true

      firefly_home:
        description:
          - Directory where to store data files.
        type: path
        default: /var/lib/firefly

      firefly_site_owner:
        description:
          - E-mail address of the site owner.
        default: root@localhost

      firefly_app_key:
        description:
          - Application key (sensitive).
        required: true

      firefly_language:
        description:
          - Language of the web interface.
        default: en_US

      firefly_tz:
        description:
          - Time zone of the web interface.
        default: Etc/UTC

      firefly_db_database:
        description:
          - Name of the database.
        default: firefly

      firefly_db_username:
        description:
          - Name of the user to connect to the database.
        default: firefly

      firefly_db_password:
        description:
          - Password to connect to the database (sensitive).
        required: true

      firefly_manage_iptables:
        description:
          - Configure iptables rules.
        type: bool
        default: false

      firefly_allowed_sources:
        description:
          - List of IP ranges to allow when `firefly_manage_iptables` is enabled.
        type: list