Skip to content

Unifi

services.unifi.enable

Whether or not to enable the unifi controller service.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/unifi.nix

services.unifi.extraJvmOptions

Set extra options to pass to the JVM.

Type: list of string

Default

[ ]

Example

["-Xlog:gc"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/unifi.nix

services.unifi.initialJavaHeapSize

Set the initial heap size for the JVM in MB. If this option isn't set, the JVM will decide this value at runtime.

Type: null or signed integer

Default

null

Example

1024

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/unifi.nix

services.unifi.jrePackage

The JRE package to use. Check the release notes to ensure it is supported.

Type: package

Default

if (lib.versionAtLeast (lib.getVersion cfg.unifiPackage) "7.5") then pkgs.jdk17_headless else if (lib.versionAtLeast (lib.getVersion cfg.unifiPackage) "7.3" then pkgs.jdk11 else pkgs.jre8

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/unifi.nix

services.unifi.maximumJavaHeapSize

Set the maximum heap size for the JVM in MB. If this option isn't set, the JVM will decide this value at runtime.

Type: null or signed integer

Default

null

Example

4096

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/unifi.nix

services.unifi.mongodbPackage

The mongodb package to use. ::: {.note} unifi7 officially only supports mongodb up until 4.4 but works with 5.0. :::

Type: package

Default

pkgs.mongodb-5_0

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/unifi.nix

services.unifi.openFirewall

Whether or not to open the minimum required ports on the firewall.

This is necessary to allow firmware upgrades and device discovery to work. For remote login, you should additionally open (or forward) port 8443.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/unifi.nix

services.unifi.unifiPackage

The unifi5 package to use. Type: package

Default

pkgs.unifi5

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/unifi.nix