slskd¶
slskd is a web based client for Soulseek.
Available Options
This page documents 13 configuration options.
Additional Options¶
This page has the following additional configuration options:
nixflix.slskd.enable¶
Whether to enable slskd Soulseek client.
| Type | boolean |
| Default | |
| Example | |
| Declared in | modules/slskd |
nixflix.slskd.apiKey¶
API key securing slskd's own REST API. Consumed by clients such as DroppedNeedle.
Can be created with the following:
Warning
Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.
Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.
| Type | null or string or (submodule) |
| Default | |
| Example | |
| Declared in | modules/slskd |
nixflix.slskd.dataDir¶
Directory holding slskd's generated credentials file. slskd's own application state lives under /var/lib/slskd (managed by the upstream systemd StateDirectory).
| Type | absolute path |
| Default | |
| Declared in | modules/slskd |
nixflix.slskd.downloadsDir¶
Directory where completed Soulseek downloads are stored.
| Type | absolute path |
| Default | |
| Declared in | modules/slskd |
nixflix.slskd.group¶
Group under which slskd runs.
| Type | string |
| Default | |
| Declared in | modules/slskd |
nixflix.slskd.openFirewall¶
Open the Soulseek peer listen port (settings.soulseek.listen_port) in the firewall.
| Type | boolean |
| Default | |
| Declared in | modules/slskd |
nixflix.slskd.password¶
Web UI password. Required when nixflix.slskd.enable = true.
Warning
Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.
Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.
| Type | null or string or (submodule) |
| Default | |
| Example | |
| Declared in | modules/slskd |
nixflix.slskd.reverseProxy.expose¶
Whether to expose the slskd web UI via the reverse proxy.
| Type | boolean |
| Default | |
| Declared in | modules/slskd |
nixflix.slskd.subdomain¶
Subdomain prefix for reverse proxy routing.
| Type | string |
| Default | |
| Declared in | modules/slskd |
nixflix.slskd.user¶
User under which slskd runs.
| Type | string |
| Default | |
| Declared in | modules/slskd |
nixflix.slskd.username¶
Web UI username. Required when nixflix.slskd.enable = true.
Warning
Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.
Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.
| Type | null or string or (submodule) |
| Default | |
| Example | |
| Declared in | modules/slskd |
nixflix.slskd.vpn.enable¶
Whether to route slskd traffic through the VPN.
When true, slskd is confined to the WireGuard network namespace (requires nixflix.vpn.enable = true).
| Type | boolean |
| Default | |
| Declared in | modules/slskd |
nixflix.slskd.vpn.namespace¶
Name of the VPN network namespace to confine slskd to when vpn.enable = true.
| Type | string |
| Default | |
| Declared in | modules/slskd |