2021-12-19 01:06:50 +00:00
|
|
|
{ config, options, lib, pkgs, utils, ... }:
|
2020-04-24 23:36:52 +00:00
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
cfg = config.services.unifi;
|
|
|
|
stateDir = "/var/lib/unifi";
|
|
|
|
cmd = ''
|
|
|
|
@${cfg.jrePackage}/bin/java java \
|
|
|
|
${optionalString (cfg.initialJavaHeapSize != null) "-Xms${(toString cfg.initialJavaHeapSize)}m"} \
|
|
|
|
${optionalString (cfg.maximumJavaHeapSize != null) "-Xmx${(toString cfg.maximumJavaHeapSize)}m"} \
|
|
|
|
-jar ${stateDir}/lib/ace.jar
|
|
|
|
'';
|
|
|
|
in
|
|
|
|
{
|
|
|
|
|
|
|
|
options = {
|
|
|
|
|
|
|
|
services.unifi.enable = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
Whether or not to enable the unifi controller service.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
services.unifi.jrePackage = mkOption {
|
|
|
|
type = types.package;
|
2022-12-17 10:02:37 +00:00
|
|
|
default = if (lib.versionAtLeast (lib.getVersion cfg.unifiPackage) "7.3") then pkgs.jdk11 else pkgs.jre8;
|
|
|
|
defaultText = literalExpression ''if (lib.versionAtLeast (lib.getVersion cfg.unifiPackage) "7.3" then pkgs.jdk11 else pkgs.jre8'';
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
The JRE package to use. Check the release notes to ensure it is supported.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
services.unifi.unifiPackage = mkOption {
|
|
|
|
type = types.package;
|
|
|
|
default = pkgs.unifiLTS;
|
2021-10-06 13:57:05 +00:00
|
|
|
defaultText = literalExpression "pkgs.unifiLTS";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
The unifi package to use.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
services.unifi.mongodbPackage = mkOption {
|
|
|
|
type = types.package;
|
|
|
|
default = pkgs.mongodb;
|
2021-10-06 13:57:05 +00:00
|
|
|
defaultText = literalExpression "pkgs.mongodb";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
The mongodb package to use.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2021-12-19 01:06:50 +00:00
|
|
|
services.unifi.openFirewall = mkOption {
|
2020-04-24 23:36:52 +00:00
|
|
|
type = types.bool;
|
2022-06-16 17:23:12 +00:00
|
|
|
default = false;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
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.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
services.unifi.initialJavaHeapSize = mkOption {
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
default = null;
|
|
|
|
example = 1024;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
Set the initial heap size for the JVM in MB. If this option isn't set, the
|
|
|
|
JVM will decide this value at runtime.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
services.unifi.maximumJavaHeapSize = mkOption {
|
|
|
|
type = types.nullOr types.int;
|
|
|
|
default = null;
|
|
|
|
example = 4096;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
Set the maximimum heap size for the JVM in MB. If this option isn't set, the
|
|
|
|
JVM will decide this value at runtime.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
|
|
|
|
users.users.unifi = {
|
2021-09-22 15:38:15 +00:00
|
|
|
isSystemUser = true;
|
|
|
|
group = "unifi";
|
2020-04-24 23:36:52 +00:00
|
|
|
description = "UniFi controller daemon user";
|
|
|
|
home = "${stateDir}";
|
|
|
|
};
|
2021-09-22 15:38:15 +00:00
|
|
|
users.groups.unifi = {};
|
2020-04-24 23:36:52 +00:00
|
|
|
|
2021-12-19 01:06:50 +00:00
|
|
|
networking.firewall = mkIf cfg.openFirewall {
|
2020-04-24 23:36:52 +00:00
|
|
|
# https://help.ubnt.com/hc/en-us/articles/218506997
|
|
|
|
allowedTCPPorts = [
|
|
|
|
8080 # Port for UAP to inform controller.
|
|
|
|
8880 # Port for HTTP portal redirect, if guest portal is enabled.
|
|
|
|
8843 # Port for HTTPS portal redirect, ditto.
|
|
|
|
6789 # Port for UniFi mobile speed test.
|
|
|
|
];
|
|
|
|
allowedUDPPorts = [
|
|
|
|
3478 # UDP port used for STUN.
|
|
|
|
10001 # UDP port used for device discovery.
|
|
|
|
];
|
|
|
|
};
|
|
|
|
|
|
|
|
systemd.services.unifi = {
|
|
|
|
description = "UniFi controller daemon";
|
|
|
|
wantedBy = [ "multi-user.target" ];
|
2021-12-06 16:07:01 +00:00
|
|
|
after = [ "network.target" ];
|
|
|
|
|
2020-04-24 23:36:52 +00:00
|
|
|
# This a HACK to fix missing dependencies of dynamic libs extracted from jars
|
|
|
|
environment.LD_LIBRARY_PATH = with pkgs.stdenv; "${cc.cc.lib}/lib";
|
2020-07-18 16:06:22 +00:00
|
|
|
# Make sure package upgrades trigger a service restart
|
|
|
|
restartTriggers = [ cfg.unifiPackage cfg.mongodbPackage ];
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
serviceConfig = {
|
|
|
|
Type = "simple";
|
|
|
|
ExecStart = "${(removeSuffix "\n" cmd)} start";
|
|
|
|
ExecStop = "${(removeSuffix "\n" cmd)} stop";
|
|
|
|
Restart = "on-failure";
|
2021-10-17 02:12:59 +00:00
|
|
|
TimeoutSec = "5min";
|
2020-04-24 23:36:52 +00:00
|
|
|
User = "unifi";
|
|
|
|
UMask = "0077";
|
|
|
|
WorkingDirectory = "${stateDir}";
|
2021-10-17 02:12:59 +00:00
|
|
|
# the stop command exits while the main process is still running, and unifi
|
|
|
|
# wants to manage its own child processes. this means we have to set KillSignal
|
|
|
|
# to something the main process ignores, otherwise every stop will have unifi.service
|
|
|
|
# fail with SIGTERM status.
|
|
|
|
KillSignal = "SIGCONT";
|
2021-08-08 23:34:03 +00:00
|
|
|
|
|
|
|
# Hardening
|
|
|
|
AmbientCapabilities = "";
|
|
|
|
CapabilityBoundingSet = "";
|
|
|
|
# ProtectClock= adds DeviceAllow=char-rtc r
|
|
|
|
DeviceAllow = "";
|
|
|
|
DevicePolicy = "closed";
|
|
|
|
LockPersonality = true;
|
|
|
|
NoNewPrivileges = true;
|
|
|
|
PrivateDevices = true;
|
|
|
|
PrivateMounts = true;
|
|
|
|
PrivateTmp = true;
|
|
|
|
PrivateUsers = true;
|
|
|
|
ProtectClock = true;
|
|
|
|
ProtectControlGroups = true;
|
|
|
|
ProtectHome = true;
|
|
|
|
ProtectHostname = true;
|
|
|
|
ProtectKernelLogs = true;
|
|
|
|
ProtectKernelModules = true;
|
|
|
|
ProtectKernelTunables = true;
|
|
|
|
ProtectSystem = "strict";
|
|
|
|
RemoveIPC = true;
|
|
|
|
RestrictNamespaces = true;
|
|
|
|
RestrictRealtime = true;
|
|
|
|
RestrictSUIDSGID = true;
|
|
|
|
SystemCallErrorNumber = "EPERM";
|
|
|
|
SystemCallFilter = [ "@system-service" ];
|
|
|
|
|
2021-12-06 16:07:01 +00:00
|
|
|
StateDirectory = "unifi";
|
|
|
|
RuntimeDirectory = "unifi";
|
|
|
|
LogsDirectory = "unifi";
|
|
|
|
CacheDirectory= "unifi";
|
|
|
|
|
|
|
|
TemporaryFileSystem = [
|
|
|
|
# required as we want to create bind mounts below
|
|
|
|
"${stateDir}/webapps:rw"
|
|
|
|
];
|
|
|
|
|
|
|
|
# We must create the binary directories as bind mounts instead of symlinks
|
|
|
|
# This is because the controller resolves all symlinks to absolute paths
|
|
|
|
# to be used as the working directory.
|
|
|
|
BindPaths = [
|
|
|
|
"/var/log/unifi:${stateDir}/logs"
|
|
|
|
"/run/unifi:${stateDir}/run"
|
|
|
|
"${cfg.unifiPackage}/dl:${stateDir}/dl"
|
|
|
|
"${cfg.unifiPackage}/lib:${stateDir}/lib"
|
|
|
|
"${cfg.mongodbPackage}/bin:${stateDir}/bin"
|
|
|
|
"${cfg.unifiPackage}/webapps/ROOT:${stateDir}/webapps/ROOT"
|
|
|
|
];
|
2021-08-08 23:34:03 +00:00
|
|
|
|
|
|
|
# Needs network access
|
|
|
|
PrivateNetwork = false;
|
|
|
|
# Cannot be true due to OpenJDK
|
|
|
|
MemoryDenyWriteExecute = false;
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
};
|
2021-12-06 16:07:01 +00:00
|
|
|
imports = [
|
|
|
|
(mkRemovedOptionModule [ "services" "unifi" "dataDir" ] "You should move contents of dataDir to /var/lib/unifi/data" )
|
2021-12-19 01:06:50 +00:00
|
|
|
(mkRenamedOptionModule [ "services" "unifi" "openPorts" ] [ "services" "unifi" "openFirewall" ])
|
2021-12-06 16:07:01 +00:00
|
|
|
];
|
2020-04-24 23:36:52 +00:00
|
|
|
|
2021-10-17 02:12:59 +00:00
|
|
|
meta.maintainers = with lib.maintainers; [ erictapen pennae ];
|
2020-04-24 23:36:52 +00:00
|
|
|
}
|