Plausible

`services.plausible.adminUser.activate`

Whether to enable activating the freshly created admin-user. Type: boolean

Default

false

Example

true

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

`services.plausible.adminUser.email`

Email-address of the admin-user.

Type: string

Example

"admin@localhost"

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

`services.plausible.adminUser.name`

Name of the admin user that plausible will created on initial startup.

Type: string

Default

"admin"

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

`services.plausible.adminUser.passwordFile`

Path to the file which contains the password of the admin user.

Type: string or path

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

`services.plausible.database.clickhouse.setup`

Whether to enable creating a clickhouse instance. Type: boolean

Default

true

Example

true

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

`services.plausible.database.clickhouse.url`

The URL to be used to connect to clickhouse.

Type: string

Default

"http://localhost:8123/default"

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

`services.plausible.database.postgres.dbname`

Name of the database to use.

Type: string

Default

"plausible"

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

`services.plausible.database.postgres.setup`

Whether to enable creating a postgresql instance. Type: boolean

Default

true

Example

true

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

`services.plausible.database.postgres.socket`

Path to the UNIX domain-socket to communicate with postgres.

Type: string

Default

"/run/postgresql"

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

`services.plausible.enable`

Whether to enable plausible. Type: boolean

Default

false

Example

true

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

`services.plausible.mail.email`

The email id to use for as from address of all communications from Plausible.

Type: string

Default

"hello@plausible.local"

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

`services.plausible.mail.smtp.enableSSL`

Whether to enable SSL when connecting to the SMTP server. Type: boolean

Default

false

Example

true

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

`services.plausible.mail.smtp.hostAddr`

The host address of your smtp server.

Type: string

Default

"localhost"

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

`services.plausible.mail.smtp.hostPort`

The port of your smtp server.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

25

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

`services.plausible.mail.smtp.passwordFile`

The path to the file with the password in case SMTP auth is enabled.

Type: null or string or path

Default

null

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

`services.plausible.mail.smtp.retries`

Number of retries to make until mailer gives up.

Type: unsigned integer, meaning >=0

Default

2

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

`services.plausible.mail.smtp.user`

The username/email in case SMTP auth is enabled.

Type: null or string

Default

null

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

`services.plausible.package`

The plausible package to use. Type: package

Default

pkgs.plausible

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

`services.plausible.server.baseUrl`

Public URL where plausible is available.

Note that /path components are currently ignored: https://github.com/plausible/analytics/issues/1182 .

Type: string

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

`services.plausible.server.disableRegistration`

Whether to prohibit creating an account in plausible's UI or allow on invite_only.

Type: one of true, false, "invite_only"

Default

true

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

`services.plausible.server.listenAddress`

The IP address on which the server is listening.

Type: string

Default

"127.0.0.1"

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

`services.plausible.server.port`

Port where the service should be available.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

8000

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

`services.plausible.server.secretKeybaseFile`

Path to the secret used by the phoenix-framework. Instructions how to generate one are documented in the framework docs.

Type: path or string

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