forked from mirrors/nixpkgs
2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
215 lines
6.7 KiB
Nix
215 lines
6.7 KiB
Nix
{ config, lib, options, pkgs, ... }:
|
|
|
|
with lib;
|
|
let
|
|
cfg = config.services.galene;
|
|
opt = options.services.galene;
|
|
defaultstateDir = "/var/lib/galene";
|
|
defaultrecordingsDir = "${cfg.stateDir}/recordings";
|
|
defaultgroupsDir = "${cfg.stateDir}/groups";
|
|
defaultdataDir = "${cfg.stateDir}/data";
|
|
in
|
|
{
|
|
options = {
|
|
services.galene = {
|
|
enable = mkEnableOption "Galene Service.";
|
|
|
|
stateDir = mkOption {
|
|
default = defaultstateDir;
|
|
type = types.str;
|
|
description = lib.mdDoc ''
|
|
The directory where Galene stores its internal state. If left as the default
|
|
value this directory will automatically be created before the Galene server
|
|
starts, otherwise the sysadmin is responsible for ensuring the directory
|
|
exists with appropriate ownership and permissions.
|
|
'';
|
|
};
|
|
|
|
user = mkOption {
|
|
type = types.str;
|
|
default = "galene";
|
|
description = lib.mdDoc "User account under which galene runs.";
|
|
};
|
|
|
|
group = mkOption {
|
|
type = types.str;
|
|
default = "galene";
|
|
description = lib.mdDoc "Group under which galene runs.";
|
|
};
|
|
|
|
insecure = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Whether Galene should listen in http or in https. If left as the default
|
|
value (false), Galene needs to be fed a private key and a certificate.
|
|
'';
|
|
};
|
|
|
|
certFile = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
example = "/path/to/your/cert.pem";
|
|
description = lib.mdDoc ''
|
|
Path to the server's certificate. The file is copied at runtime to
|
|
Galene's data directory where it needs to reside.
|
|
'';
|
|
};
|
|
|
|
keyFile = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null;
|
|
example = "/path/to/your/key.pem";
|
|
description = lib.mdDoc ''
|
|
Path to the server's private key. The file is copied at runtime to
|
|
Galene's data directory where it needs to reside.
|
|
'';
|
|
};
|
|
|
|
httpAddress = mkOption {
|
|
type = types.str;
|
|
default = "";
|
|
description = lib.mdDoc "HTTP listen address for galene.";
|
|
};
|
|
|
|
httpPort = mkOption {
|
|
type = types.port;
|
|
default = 8443;
|
|
description = lib.mdDoc "HTTP listen port.";
|
|
};
|
|
|
|
staticDir = mkOption {
|
|
type = types.str;
|
|
default = "${cfg.package.static}/static";
|
|
defaultText = literalExpression ''"''${package.static}/static"'';
|
|
example = "/var/lib/galene/static";
|
|
description = lib.mdDoc "Web server directory.";
|
|
};
|
|
|
|
recordingsDir = mkOption {
|
|
type = types.str;
|
|
default = defaultrecordingsDir;
|
|
defaultText = literalExpression ''"''${config.${opt.stateDir}}/recordings"'';
|
|
example = "/var/lib/galene/recordings";
|
|
description = lib.mdDoc "Recordings directory.";
|
|
};
|
|
|
|
dataDir = mkOption {
|
|
type = types.str;
|
|
default = defaultdataDir;
|
|
defaultText = literalExpression ''"''${config.${opt.stateDir}}/data"'';
|
|
example = "/var/lib/galene/data";
|
|
description = lib.mdDoc "Data directory.";
|
|
};
|
|
|
|
groupsDir = mkOption {
|
|
type = types.str;
|
|
default = defaultgroupsDir;
|
|
defaultText = literalExpression ''"''${config.${opt.stateDir}}/groups"'';
|
|
example = "/var/lib/galene/groups";
|
|
description = lib.mdDoc "Web server directory.";
|
|
};
|
|
|
|
package = mkOption {
|
|
default = pkgs.galene;
|
|
defaultText = literalExpression "pkgs.galene";
|
|
type = types.package;
|
|
description = lib.mdDoc ''
|
|
Package for running Galene.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
assertions = [
|
|
{
|
|
assertion = cfg.insecure || (cfg.certFile != null && cfg.keyFile != null);
|
|
message = ''
|
|
Galene needs both certFile and keyFile defined for encryption, or
|
|
the insecure flag.
|
|
'';
|
|
}
|
|
];
|
|
|
|
systemd.services.galene = {
|
|
description = "galene";
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
preStart = ''
|
|
${optionalString (cfg.insecure != true) ''
|
|
install -m 700 -o '${cfg.user}' -g '${cfg.group}' ${cfg.certFile} ${cfg.dataDir}/cert.pem
|
|
install -m 700 -o '${cfg.user}' -g '${cfg.group}' ${cfg.keyFile} ${cfg.dataDir}/key.pem
|
|
''}
|
|
'';
|
|
|
|
serviceConfig = mkMerge [
|
|
{
|
|
Type = "simple";
|
|
User = cfg.user;
|
|
Group = cfg.group;
|
|
WorkingDirectory = cfg.stateDir;
|
|
ExecStart = ''${cfg.package}/bin/galene \
|
|
${optionalString (cfg.insecure) "-insecure"} \
|
|
-data ${cfg.dataDir} \
|
|
-groups ${cfg.groupsDir} \
|
|
-recordings ${cfg.recordingsDir} \
|
|
-static ${cfg.staticDir}'';
|
|
Restart = "always";
|
|
# Upstream Requirements
|
|
LimitNOFILE = 65536;
|
|
StateDirectory = [ ] ++
|
|
optional (cfg.stateDir == defaultstateDir) "galene" ++
|
|
optional (cfg.dataDir == defaultdataDir) "galene/data" ++
|
|
optional (cfg.groupsDir == defaultgroupsDir) "galene/groups" ++
|
|
optional (cfg.recordingsDir == defaultrecordingsDir) "galene/recordings";
|
|
|
|
# Hardening
|
|
CapabilityBoundingSet = [ "" ];
|
|
DeviceAllow = [ "" ];
|
|
LockPersonality = true;
|
|
MemoryDenyWriteExecute = true;
|
|
NoNewPrivileges = true;
|
|
PrivateDevices = true;
|
|
PrivateTmp = true;
|
|
PrivateUsers = true;
|
|
ProcSubset = "pid";
|
|
ProtectClock = true;
|
|
ProtectControlGroups = true;
|
|
ProtectHome = true;
|
|
ProtectHostname = true;
|
|
ProtectKernelLogs = true;
|
|
ProtectKernelModules = true;
|
|
ProtectKernelTunables = true;
|
|
ProtectProc = "invisible";
|
|
ProtectSystem = "strict";
|
|
ReadWritePaths = cfg.recordingsDir;
|
|
RemoveIPC = true;
|
|
RestrictAddressFamilies = [ "AF_INET" "AF_INET6" ];
|
|
RestrictNamespaces = true;
|
|
RestrictRealtime = true;
|
|
RestrictSUIDSGID = true;
|
|
SystemCallArchitectures = "native";
|
|
SystemCallFilter = [ "@system-service" "~@privileged" "~@resources" ];
|
|
UMask = "0077";
|
|
}
|
|
];
|
|
};
|
|
|
|
users.users = mkIf (cfg.user == "galene")
|
|
{
|
|
galene = {
|
|
description = "galene Service";
|
|
group = cfg.group;
|
|
isSystemUser = true;
|
|
};
|
|
};
|
|
|
|
users.groups = mkIf (cfg.group == "galene") {
|
|
galene = { };
|
|
};
|
|
};
|
|
meta.maintainers = with lib.maintainers; [ rgrunbla ];
|
|
}
|