nixarr/hugo/content/nixos/index.md

title, author, date

title	author	date
Options Documentation	Rasmus Kirk	2023-12-07

kirk.nixosScripts.configDir

Path to the nixos configuration.

Type: path

Default

"/etc/nixos"

kirk.nixosScripts.enable

Whether to enable Nixos scripts

Required options:

• machine .

Type: boolean

Default

false

Example

true

kirk.nixosScripts.machine

REQUIRED! The machine to run on.

Type: null or string

Default

null

kirk.servarr.acmeMail

REQUIRED! The ACME mail.

Type: null or string

Default

null

kirk.servarr.domainName

REQUIRED! The domain name to host jellyfin on.

Type: null or string

Default

null

kirk.servarr.enable

Whether to enable My servarr setup. Hosts Jellyfin on the given domain (remember domain records/port forwarding) and hosts the following services on localhost through a mullvad VPN:

• Prowlarr
• Sonarr
• Radarr
• Flood/Rtorrnet

Required options for this module:

• domainName
• acmeMail
• mullvadAcc

Remember to read the options.

NOTE: The docker service to manage this executes the command docker container prune -f on startup for reproducibility, may cause issues depending on your setup.

NOTE: This nixos module only supports the mullvad VPN, if you need another VPN, create a PR or fork this repo! .

Type: boolean

Default

false

Example

true

kirk.servarr.gluetun.extraConfig

Extra config for the service.

Type: attribute set

Default

{}

kirk.servarr.jellyfin.extraConfig

Extra config for the service.

Type: attribute set

Default

{}

kirk.servarr.jellyfin.port

Port of Jellyfin.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

8096

kirk.servarr.mediaDir

The location of the media directory for the services.

Type: path

Default

"~/servarr"

kirk.servarr.mullvadAcc

REQUIRED! The location the file containing your mullvad account key.

Type: null or path

Default

null

kirk.servarr.prowlarr.extraConfig

Extra config for the service.

Type: attribute set

Default

{}

kirk.servarr.prowlarr.port

Port of prowlarr.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

6002

kirk.servarr.radarr.extraConfig

Extra config for the service.

Type: attribute set

Default

{}

kirk.servarr.radarr.port

Port of radarr.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

6004

kirk.servarr.rflood.extraConfig

Extra config for the service.

Type: attribute set

Default

{}

kirk.servarr.rflood.port

Port of rflood.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

6001

kirk.servarr.rflood.ulimits.enable

Whether to enable Enable rtorrent ulimits. I had a bug that caused rtorrent to fail and log std::bad_alloc. Setting ulimits for this service fixed the issue. You probably don't want to set this unless you have similar issues.See link below for more info:

https://stackoverflow.com/questions/75536471/rtorrent-docker-container-failing-to-start-saying-stdbad-alloc .

Type: boolean

Default

false

Example

true

kirk.servarr.rflood.ulimits.hard

The hard limit.

Type: unsigned integer, meaning >=0

Default

1024

kirk.servarr.rflood.ulimits.soft

The soft limit.

Type: unsigned integer, meaning >=0

Default

1024

kirk.servarr.sonarr.extraConfig

Extra config for the service.

Type: attribute set

Default

{}

kirk.servarr.sonarr.port

Port of sonarr.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

6003

kirk.servarr.stateDir

The location of the state directory for the services.

Type: path

Default

"~/.local/state"

kirk.servarr.timezone

Your timezone, used for logging purposes.

Type: string

Default

"Etc/UTC"