Core Options¶

Top-level nixflix configuration options that apply to the entire system.

nixflix.downloadarr¶

Downloadarr is a service that is responsible for configuring Starr services with download clients. When you enable the service for that client to run, Downloadarr integrates it automatically with each Starr service.

The list is small right now. However, Downloadarr itself supports supports more integrations than Nixflix supports. It just has less magic built in.

Each module is currently only a subset of the options available. You can add more options reqresented in the UI if you know their keys.

{ }

nixflix.downloadsDir¶

The location of the downloads directory for download clients.

downloadsDir = /home/user/data

"/data/downloads"

"/data/downloads"

nixflix.enable¶

Whether to enable Nixflix.

false

true

nixflix.globals¶

Global values to be used by nixflix services

{ }

nixflix.mediaDir¶

The location of the media directory for the services.

mediaDir = /home/user/data

"/data/media"

"/data/media"

nixflix.mediaUsers¶

Extra users to add to the media group.

[ ]

[
  "user"
]

nixflix.navidrome¶

This option has no description.

nixflix.notif¶

Notif is a service that is responsible for configuring Starr services with "Connect" notifications. When you enable the service for a target that it applies to, Notif integrates it automatically with each applicable Starr service.

Unlike Downloadarr, not every notification type applies to every Starr service. Each notification type declares a services list controlling which Starr services it gets configured on.

Each module is currently only a subset of the options available. You can add more options represented in the UI if you know their keys, or add an entirely new type via extraNotifications.

{ }

nixflix.serviceDependencies¶

List of systemd services that nixflix services should wait for before starting. Useful for mounting encrypted drives, starting VPNs, or other prerequisites.

[ ]

[
  "unlock-raid.service"
  "tailscale.service"
]

nixflix.stateDir¶

The location of the state directory for the services.

stateDir = /home/user/data

"/var/lib"

"/data/.state"