Skip to content

Keter

services.keter.bundle.appName

The name keter assigns to this bundle Type: string

Default

"myapp"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.bundle.domain

The domain keter will bind to Type: string

Default

"example.com"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.bundle.executable

The executable to be run Type: path

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.bundle.publicScript

Allows loading of public environment variables, these are emitted to the log so it shouldn't contain secrets.

Type: string

Default

""

Example

"ADMIN_EMAIL=hi@example.com"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.bundle.secretScript

Allows loading of private environment variables Type: string

Default

""

Example

"MY_AWS_KEY=$(cat /run/keys/AWS_ACCESS_KEY_ID)"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.enable

Whether to enable keter, a web app deployment manager. Note that this module only support loading of webapps: Keep an old app running and swap the ports when the new one is booted . Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.globalKeterConfig

Global config for keter, see https://github.com/snoyberg/keter/blob/master/etc/keter-config.yaml for reference Type: YAML value

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.globalKeterConfig.ip-from-header

You want that ip-from-header in the nginx setup case. It allows nginx setting the original ip address rather then it being localhost (due to reverse proxying) Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.globalKeterConfig.listeners

You want that ip-from-header in the nginx setup case. It allows nginx setting the original ip address rather then it being localhost (due to reverse proxying). However if you configure keter to accept connections directly you may want to set this to false. Type: list of (submodule)

Default

[{host = "*";port = 6981;}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.globalKeterConfig.listeners.*.host

host Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.globalKeterConfig.listeners.*.port

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

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.globalKeterConfig.rotate-logs

emits keter logs and it's applications to stderr. which allows journald to capture them. Set to true to let keter put the logs in files (useful on non systemd systems, this is the old approach where keter handled log management) Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.package

The keter package to be used Type: package

Default

pkgs.haskellPackages.keter

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter

services.keter.root

Mutable state folder for keter Type: string

Default

"/var/lib/keter"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-servers/keter