blob: d67d9fe120b6de6cd47434b1233e882949bfb4db (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
{
config,
lib,
pkgs,
utils,
...
}:
let
cfg = config.services.livekit.ingress;
format = pkgs.formats.yaml { };
settings = lib.filterAttrsRecursive (_: v: v != null) cfg.settings;
optionalPort = (lib.types.ints.between (-1) 65535);
normalisePort =
defaultPort: configValue:
if configValue == -1 then
null
else if configValue == 0 then
defaultPort
else
configValue;
actualRTMPPort = normalisePort 1935 cfg.settings.rtmp_port;
actualWHIPPort = normalisePort 8080 cfg.settings.whip_port;
isLocallyDistributed = config.services.livekit.enable;
in
{
meta.maintainers = with lib.maintainers; [ k900 ];
options.services.livekit.ingress = {
enable = lib.mkEnableOption "the livekit ingress service";
package = lib.mkPackageOption pkgs "livekit-ingress" { };
openFirewall = {
rtc = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Open WebRTC ports in the firewall.";
};
rtmp = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Open RTMP port in the firewall.";
};
whip = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Open WHIP port in the firewall.";
};
};
settings = lib.mkOption {
type = lib.types.submodule {
freeformType = format.type;
options = {
rtmp_port = lib.mkOption {
type = optionalPort;
default = 1935;
description = "TCP port for RTMP connections. -1 to disable";
};
whip_port = lib.mkOption {
type = optionalPort;
default = 8080;
description = "TCP port for WHIP connections. -1 to disable";
};
redis = {
address = lib.mkOption {
type = with lib.types; nullOr str;
default =
if isLocallyDistributed then
"${config.services.livekit.redis.host}:${toString config.services.livekit.redis.port}"
else
null;
example = "redis.example.com:6379";
defaultText = "Host and port of the local livekit redis instance, if enabled, or null";
description = "Address or hostname and port for redis connection";
};
};
rtc_config = {
port_range_start = lib.mkOption {
type = lib.types.port;
default = 50000;
description = "Start of UDP port range for WebRTC";
};
port_range_end = lib.mkOption {
type = lib.types.port;
default = 51000;
description = "End of UDP port range for WebRTC";
};
use_external_ip = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
When set to true, attempts to discover the host's public IP via STUN.
This is useful for cloud environments such as AWS & Google where hosts have an internal IP that maps to an external one.
'';
};
};
};
};
default = { };
description = ''
LiveKit Ingress configuration.
See <https://github.com/livekit/ingress?tab=readme-ov-file#config> for possible options.
'';
example = {
prometheus_port = 9039;
cpu_cost = {
rtmp_cpu_cost = 3.0;
whip_cpu_cost = 1.0;
};
};
};
environmentFile = lib.mkOption {
type = lib.types.nullOr lib.types.path;
default = null;
description = ''
Environment file as defined in {manpage}`systemd.exec(5)` passed to the service.
Use this to specify `LIVEKIT_API_KEY` and `LIVEKIT_API_SECRET`.
'';
};
};
config = lib.mkIf cfg.enable {
assertions = [
{
assertion = cfg.openFirewall.rtmp -> actualRTMPPort != null;
message = "services.livekit-ingress: configured to open RTMP port, but the RTMP service is disabled";
}
{
assertion = cfg.openFirewall.whip -> actualWHIPPort != null;
message = "services.livekit-ingress: configured to open WHIP port, but the WHIP service is disabled";
}
];
networking.firewall = {
allowedTCPPorts = lib.mkMerge [
(lib.mkIf cfg.openFirewall.rtmp [ actualRTMPPort ])
(lib.mkIf cfg.openFirewall.whip [ actualWHIPPort ])
];
allowedUDPPortRanges = lib.mkIf cfg.openFirewall.rtc [
{
from = cfg.settings.rtc_config.port_range_start;
to = cfg.settings.rtc_config.port_range_end;
}
];
};
systemd.services.livekit-ingress = {
description = "LiveKit Ingress server";
documentation = [ "https://docs.livekit.io/home/self-hosting/ingress/" ];
wantedBy = [ "multi-user.target" ];
wants = [ "network-online.target" ];
after = [ "network-online.target" ];
serviceConfig = {
ExecStart = utils.escapeSystemdExecArgs [
(lib.getExe cfg.package)
"--config=${format.generate "ingress.yaml" settings}"
];
EnvironmentFile = lib.mkIf (cfg.environmentFile != null) cfg.environmentFile;
DynamicUser = true;
LockPersonality = true;
MemoryDenyWriteExecute = true;
ProtectClock = true;
ProtectControlGroups = true;
ProtectHostname = true;
ProtectKernelLogs = true;
ProtectKernelModules = true;
ProtectKernelTunables = true;
PrivateDevices = true;
PrivateMounts = true;
PrivateUsers = true;
RestrictAddressFamilies = [
"AF_INET"
"AF_INET6"
"AF_NETLINK"
];
RestrictNamespaces = true;
RestrictRealtime = true;
ProtectHome = true;
SystemCallArchitectures = "native";
SystemCallFilter = [
"@system-service"
"~@privileged"
"~@resources"
];
Restart = "on-failure";
RestartSec = 5;
UMask = "077";
};
};
};
}
|
