services.zigduck
Enable the zigduck service, the CLI, the dashboard and the GNOME extension. 15 options.
General
Section titled “General”services.zigduck.broker
Section titled “services.zigduck.broker”MQTT broker hostname or IP address
Type: string
Default: "127.0.0.1"
Example: "0.0.0.0"
Declared in: options/service.nix
services.zigduck.cli.enable
Section titled “services.zigduck.cli.enable”Whether to install zigduck-cli package.
Type: boolean
Default: true
Example: false
Declared in: options/service.nix
services.zigduck.debug
Section titled “services.zigduck.debug”Enable debug logging (sets DEBUG=1)
Type: boolean
Default: false
Example: true
Declared in: options/service.nix
services.zigduck.enable
Section titled “services.zigduck.enable”Whether to enable Zigduck.
Type: boolean
Default: false
Example: true
Declared in: options/service.nix
services.zigduck.extraEnv
Section titled “services.zigduck.extraEnv”Extra environment variables to pass to the service
Type: attribute set of string
Default: { }
Declared in: options/service.nix
services.zigduck.gnomeExtension.enable
Section titled “services.zigduck.gnomeExtension.enable”Whether to install gnome-shell-extension zigduck package.
Type: boolean
Default: false
Example: true
Declared in: options/service.nix
services.zigduck.logFile
Section titled “services.zigduck.logFile”Location to store zigduck logfile.
Type: absolute path
Default: "/var/lib/zigduck/zigduck.log"
Example: "/path/to/example/zigduck.log"
Declared in: options/service.nix
services.zigduck.stateDir
Section titled “services.zigduck.stateDir”Directory for runtime state files
Type: absolute path
Default: "/var/lib/zigduck"
Example: "/path/to/example"
Declared in: options/service.nix
dashboard
Section titled “dashboard”services.zigduck.dashboard.enable
Section titled “services.zigduck.dashboard.enable”Whether to enable Zigduck dashboard service.
Type: boolean
Default: false
Example: true
Declared in: options/service.nix
services.zigduck.dashboard.host
Section titled “services.zigduck.dashboard.host”Host to bind the webserver to
Type: string
Default: "0.0.0.0"
Example: "127.0.0.1"
Declared in: options/service.nix
services.zigduck.dashboard.logFile
Section titled “services.zigduck.dashboard.logFile”Location to store zigduck API logfile.
Type: absolute path
Default: "/var/lib/zigduck/zigduck-api.log"
Example: "/path/to/example/zigduck-api.log"
Declared in: options/service.nix
services.zigduck.dashboard.openFirewall
Section titled “services.zigduck.dashboard.openFirewall”Whether to open the firewall for the specified port.
Type: boolean
Default: false
Example: true
Declared in: options/service.nix
services.zigduck.dashboard.passwordFile
Section titled “services.zigduck.dashboard.passwordFile”Path to password file for API authentication (API_PASSWORD_FILE)
Type: null or absolute path
Default: null
Declared in: options/service.nix
services.zigduck.dashboard.port
Section titled “services.zigduck.dashboard.port”Port for the dashboard
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default: 13336
Example: 13337
Declared in: options/service.nix
services.zigduck.dashboard.secure
Section titled “services.zigduck.dashboard.secure”Whether to set the Secure flag on authentication cookies. Set to false when serving over plain HTTP.
Type: boolean
Default: true
Example: false
Declared in: options/service.nix