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.

Warning: Setting this to any path, where the subpath is not owned by root, will fail! For example:

downloadsDir = /home/user/downloads

Is not supported, because /home/user is owned by user.

"/data/downloads"

"/data/downloads"

nixflix.globals¶

Global values to be used by nixflix services

{ }

nixflix.mediaDir¶

The location of the media directory for the services.

Warning: Setting this to any path, where the subpath is not owned by root, will fail! For example:

mediaDir = /home/user/data

Is not supported, because /home/user is owned by user.

"/data/media"

"/data/media"

nixflix.mediaUsers¶

Extra users to add to the media group.

[ ]

[
  "user"
]

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.

Warning: Setting this to any path, where the subpath is not owned by root, will fail! For example:

stateDir = /home/user/data/.state

Is not supported, because /home/user is owned by user.

"/data/.state"

"/data/.state"

nixflix.enable¶

Whether to enable Nixflix.

false

true