Skip to content

Zammad

services.zammad.dataDir

Path to a folder that will contain Zammad working directory.

Type: path

Default

"/var/lib/zammad"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.database.createLocally

Whether to create a local database automatically. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.database.host

Database host address.

Type: null or string

Default

{PostgreSQL = "/run/postgresql";MySQL = "localhost";}.${config.services.zammad.database.type};

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.database.name

Database name.

Type: string

Default

"zammad"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.database.passwordFile

A file containing the password for {option}services.zammad.database.user.

Type: null or path

Default

null

Example

"/run/keys/zammad-dbpassword"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.database.port

Database port. Use null for default port. Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.database.settings

The {file}database.yml configuration file as key value set. See \<TODO> for list of configuration parameters.

Type: YAML value

Default

{ }

Example

{}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.database.type

Database engine to use. Type: one of "PostgreSQL", "MySQL"

Default

"PostgreSQL"

Example

"MySQL"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.database.user

Database user. Type: null or string

Default

"zammad"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.enable

Whether to enable Zammad, a web-based, open source user support/ticketing solution. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.host

Host address. Type: string

Default

"127.0.0.1"

Example

"192.168.23.42"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.openPorts

Whether to open firewall ports for Zammad Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.package

The zammad package to use. Type: package

Default

pkgs.zammad

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.port

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

Default

3000

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.redis.createLocally

Whether to create a local redis automatically. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.redis.host

Redis server address.

Type: string

Default

"localhost"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.redis.name

Name of the redis server. Only used if createLocally is set to true.

Type: string

Default

"zammad"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.redis.port

Port of the redis server. Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

6379

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.secretKeyBaseFile

The path to a file containing the secret_key_base secret.

Zammad uses secret_key_base to encrypt the cookie store, which contains session data, and to digest user auth tokens.

Needs to be a 64 byte long string of hexadecimal characters. You can generate one by running

openssl rand -hex 64 >/path/to/secret_key_base_file

This should be a string, not a nix path, since nix paths are copied into the world-readable nix store.

Type: null or path

Default

null

Example

"/run/keys/secret_key_base"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix

services.zammad.websocketPort

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

Default

6042

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/development/zammad.nix