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.
80 lines
2.2 KiB
Nix
80 lines
2.2 KiB
Nix
{ config, pkgs, lib, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.n8n;
|
|
format = pkgs.formats.json {};
|
|
configFile = format.generate "n8n.json" cfg.settings;
|
|
in
|
|
{
|
|
options.services.n8n = {
|
|
|
|
enable = mkEnableOption "n8n server";
|
|
|
|
openFirewall = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc "Open ports in the firewall for the n8n web interface.";
|
|
};
|
|
|
|
settings = mkOption {
|
|
type = format.type;
|
|
default = {};
|
|
description = lib.mdDoc ''
|
|
Configuration for n8n, see <https://docs.n8n.io/reference/configuration.html>
|
|
for supported values.
|
|
'';
|
|
};
|
|
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
services.n8n.settings = {
|
|
# We use this to open the firewall, so we need to know about the default at eval time
|
|
port = lib.mkDefault 5678;
|
|
};
|
|
|
|
systemd.services.n8n = {
|
|
description = "N8N service";
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
environment = {
|
|
# This folder must be writeable as the application is storing
|
|
# its data in it, so the StateDirectory is a good choice
|
|
N8N_USER_FOLDER = "/var/lib/n8n";
|
|
HOME = "/var/lib/n8n";
|
|
N8N_CONFIG_FILES = "${configFile}";
|
|
};
|
|
serviceConfig = {
|
|
Type = "simple";
|
|
ExecStart = "${pkgs.n8n}/bin/n8n";
|
|
Restart = "on-failure";
|
|
StateDirectory = "n8n";
|
|
|
|
# Basic Hardening
|
|
NoNewPrivileges = "yes";
|
|
PrivateTmp = "yes";
|
|
PrivateDevices = "yes";
|
|
DevicePolicy = "closed";
|
|
DynamicUser = "true";
|
|
ProtectSystem = "strict";
|
|
ProtectHome = "read-only";
|
|
ProtectControlGroups = "yes";
|
|
ProtectKernelModules = "yes";
|
|
ProtectKernelTunables = "yes";
|
|
RestrictAddressFamilies = "AF_UNIX AF_INET AF_INET6 AF_NETLINK";
|
|
RestrictNamespaces = "yes";
|
|
RestrictRealtime = "yes";
|
|
RestrictSUIDSGID = "yes";
|
|
MemoryDenyWriteExecute = "no"; # v8 JIT requires memory segments to be Writable-Executable.
|
|
LockPersonality = "yes";
|
|
};
|
|
};
|
|
|
|
networking.firewall = mkIf cfg.openFirewall {
|
|
allowedTCPPorts = [ cfg.settings.port ];
|
|
};
|
|
};
|
|
}
|