Firefly iii

`services.firefly-iii.dataDir`

The place where firefly-iii stores its state.

Type: path

Default

"/var/lib/firefly-iii"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.enable`

Whether to enable Firefly III: A free and open source personal finance manager. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.enableNginx`

Whether to enable nginx or not. If enabled, an nginx virtual host will be created for access to firefly-iii. If not enabled, then you may use ${config.services.firefly-iii.package} as your document root in whichever webserver you wish to setup.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.group`

Group under which firefly-iii runs. It is best to set this to the group of whatever webserver is being used as the frontend.

Type: string

Default

"Ifservices.firefly-iii.enableNginxis true thennginxelse firefly-iii"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.package`

The firefly-iii package served by php-fpm and the webserver of choice. This option can be used to point the webserver to the correct root. It may also be used to set the package to a different version, say a development version.

Type: package

Default

pkgs.firefly-iii

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.poolConfig`

Options for the Firefly III PHP pool. See the documentation on php-fpm.conf for details on configuration directives.

Type: attribute set of (string or signed integer or boolean)

Default

{pm = "dynamic";"pm.max_children" = 32;"pm.max_requests" = 500;"pm.max_spare_servers" = 4;"pm.min_spare_servers" = 2;"pm.start_servers" = 2;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.settings`

Options for firefly-iii configuration. Refer to https://github.com/firefly-iii/firefly-iii/blob/main/.env.example for details on supported values. All

APP_URL will be the same as services.firefly-iii.virtualHost if the former is unset in services.firefly-iii.settings.

Type: attribute set of (string or signed integer or boolean)

Default

{ }

Example

{APP_ENV = "production";APP_KEY_FILE = "/var/secrets/firefly-iii-app-key.txt";SITE_OWNER = "mail@example.com";DB_CONNECTION = "mysql";DB_HOST = "db";DB_PORT = 3306;DB_DATABASE = "firefly";DB_USERNAME = "firefly";DB_PASSWORD_FILE = "/var/secrets/firefly-iii-mysql-password.txt;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.settings.APP_ENV`

The app environment. It is recommended to keep this at "local". Possible values are "local", "production" and "testing"

Type: one of "local", "production", "testing"

Default

"local"

Example

"production"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.settings.APP_KEY_FILE`

The path to your appkey. The file should contain a 32 character random app key. This may be set using echo "base64:$(head -c 32 /dev/urandom | base64)" > /path/to/key-file.

Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.settings.APP_URL`

The APP_URL used by firefly-iii internally. Please make sure this URL matches the external URL of your Firefly III installation. It is used to validate specific requests and to generate URLs in emails.

Type: string

Default

'' http(s)://''${config.services.firefly-iii.virtualHost}''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.settings.DB_CONNECTION`

The type of database you wish to use. Can be one of "sqlite", "mysql" or "pgsql".

Type: one of "sqlite", "pgsql", "mysql"

Default

"sqlite"

Example

"pgsql"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/firefly-iii.nix

`services.firefly-iii.settings.DB_HOST`

The machine which hosts your database. This is left at the default value for "mysql" because we use the "DB_SOCKET" option to connect to a unix socket instead. "pgsql" requires that the unix socket location be specified here instead of at "DB_SOCKET". This option does not affect "sqlite".

Type: string