Skip to content

Configuration

You can configure the server, snarfd, through the NixOS module.

services.snarf.enable (bool)

Default: false

Enable the Snarf server.

Example:

services.snarf.enable = true;

services.snarf.listenAddress (string)

Default: "127.0.0.1"

The IP address the server listens on.

Example:

services.snarf.listenAddress = "0.0.0.0";

services.snarf.port (port)

Default: 9000

The port the management services listen on.

Example:

services.snarf.port = 4242;

services.snarf.openFirewall (bool)

Default: false

Whether NixOS should open the firewall on services.snarf.port.

Example:

services.snarf.openFirewall = true;

services.snarf.blob_service (null or string)

Default: null

The blob service address of the underlying Snix ca-store.

Example:

services.snarf.blob_service = "http://localhost:5000"

services.snarf.directory_service (null or string)

Default: null

The directory service address of the underlying Snix ca-store.

Example:

services.snarf.directory_service= "http://localhost:5000"

services.snarf.path_info_service (null or string)

Default: null

The path info service address of the underlying Snix store.

Example:

services.snarf.path_info_service = "http://localhost:5000"

services.snarf.cache_name (null or string)

Default: null

The name of the cache. Snarf uses this mainly for signing information.

Example:

services.snarf.cache_name = "frans";

services.snarf.state_directory (null or string)

Default: null (snarfd uses /var/lib/snarf/)

The directory where snarfd will save its state. This includes the cache data unless otherwise configured through the *_service options.

Example:

services.snarf.state_directory = "/mnt/data/snarf";

services.snarf.extraArgs (listOf str)

Default: []

A list of arguments that are passes to snarfd on startup. See snarfd --help for additional options.

Example:

services.snarf.extra_args = ["--listen-address 0.0.0.0:8080"];