`services.invoiceplane.sites`

Specification of one or more WordPress sites to serve Type: attribute set of (submodule)

Default

{ }

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

`services.invoiceplane.sites.<name>.cron.enable`

Enable cron service which periodically runs Invoiceplane tasks. Requires key taken from the administration page. Refer to https://wiki.invoiceplane.com/en/1.0/modules/recurring-invoices on how to configure it.

Type: boolean

Default

false

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

`services.invoiceplane.sites.<name>.cron.key`

Cron key taken from the administration page. Type: string

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

`services.invoiceplane.sites.<name>.database.createLocally`

Create the database and database user locally. Type: boolean

Default

true

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

`services.invoiceplane.sites.<name>.database.host`

Database host address. Type: string

Default

"localhost"

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

`services.invoiceplane.sites.<name>.database.name`

Database name. Type: string

Default

"invoiceplane"

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

`services.invoiceplane.sites.<name>.database.passwordFile`

A file containing the password corresponding to {option}database.user.

Type: null or path

Default

null

Example

"/run/keys/invoiceplane-dbpassword"

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

`services.invoiceplane.sites.<name>.database.port`

Database host port. Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

3306

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

`services.invoiceplane.sites.<name>.database.user`

Database user. Type: string

Default

"invoiceplane"

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

`services.invoiceplane.sites.<name>.enable`

Whether to enable InvoicePlane web application. Type: boolean

Default

false

Example

true

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

`services.invoiceplane.sites.<name>.invoiceTemplates`

List of path(s) to respective template(s) which are copied from the 'invoice_templates/pdf' directory.

::: {.note} These templates need to be packaged before use, see example. :::

Type: list of path

Default

[ ]

Example

`#!nix let # Let's package an example template template-vtdirektmarketing = pkgs.stdenv.mkDerivation { name = "vtdirektmarketing"; # Download the template from a public repository src = pkgs.fetchgit { url = "https://git.project-insanity.org/onny/invoiceplane-vtdirektmarketing.git"; sha256 = "1hh0q7wzsh8v8x03i82p6qrgbxr4v5fb05xylyrpp975l8axyg2z"; }; sourceRoot = "."; # Installing simply means copying template php file to the output directory installPhase = "" mkdir -p $out cp invoiceplane-vtdirektmarketing/vtdirektmarketing.php $out/ ""; };

And then pass this package to the template list like this:

in [ template-vtdirektmarketing ] `

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

`services.invoiceplane.sites.<name>.poolConfig`

Options for the InvoicePlane 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/invoiceplane.nix

`services.invoiceplane.sites.<name>.settings`

Structural InvoicePlane configuration. Refer to https://github.com/InvoicePlane/InvoicePlane/blob/master/ipconfig.php.example for details and supported values.

Type: attribute set of anything

Default

{ }

Example

{SETUP_COMPLETED = true;DISABLE_SETUP = true;IP_URL = "https://invoice.example.com";}

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

`services.invoiceplane.sites.<name>.stateDir`

This directory is used for uploads of attachments and cache. The directory passed here is automatically created and permissions adjusted as required.

Type: path

Default

"/var/lib/invoiceplane/‹name›"

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

`services.invoiceplane.webserver`

Which webserver to use for virtual host management.

Type: one of "caddy", "nginx"

Default

"caddy"

Example

"nginx"

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