Skip to content

Wiki js

services.wiki-js.enable

Whether to enable wiki-js. Type: boolean

Default

false

Example

true

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

services.wiki-js.environmentFile

Environment file to inject e.g. secrets into the configuration.

Type: null or path

Default

null

Example

"/root/wiki-js.env"

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

services.wiki-js.settings

Settings to configure wiki-js. This directly corresponds to the upstream configuration options.

Secrets can be injected via the environment by - specifying to contain secrets - and setting sensitive values to $(ENVIRONMENT_VAR) with this value defined in the environment-file.

Type: JSON value

Default

{ }

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

services.wiki-js.settings.bindIP

IPs the service should listen to.

Type: string

Default

"0.0.0.0"

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

services.wiki-js.settings.db.db

Name of the database to use.

Type: string

Default

"wiki"

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

services.wiki-js.settings.db.host

Hostname or socket-path to connect to.

Type: string

Example

"/run/postgresql"

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

services.wiki-js.settings.db.type

Database driver to use for persistence. Please note that sqlite is currently not supported as the build process for it is currently not implemented in pkgs.wiki-js and it's not recommended by upstream for production use.

Type: one of "postgres", "mysql", "mariadb", "mssql"

Default

"postgres"

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

services.wiki-js.settings.logLevel

Define how much detail is supposed to be logged at runtime.

Type: one of "error", "warn", "info", "verbose", "debug", "silly"

Default

"info"

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

services.wiki-js.settings.offline

Disable latest file updates and enable sideloading.

Type: boolean

Default

false

Example

true

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

services.wiki-js.settings.port

TCP port the process should listen to.

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/web-apps/wiki-js.nix

services.wiki-js.stateDirectoryName

Name of the directory in {file}/var/lib.

Type: string

Default

"wiki-js"

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