conversions were done using https://github.com/pennae/nix-doc-munge using (probably) rev f34e145 running nix-doc-munge nixos/**/*.nix nix-doc-munge --import nixos/**/*.nix the tool ensures that only changes that could affect the generated manual *but don't* are committed, other changes require manual review and are discarded.
153 lines
4.4 KiB
Nix
153 lines
4.4 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.dragonflydb;
|
|
dragonflydb = pkgs.dragonflydb;
|
|
|
|
settings =
|
|
{
|
|
port = cfg.port;
|
|
dir = "/var/lib/dragonflydb";
|
|
keys_output_limit = cfg.keysOutputLimit;
|
|
} //
|
|
(lib.optionalAttrs (cfg.bind != null) { bind = cfg.bind; }) //
|
|
(lib.optionalAttrs (cfg.requirePass != null) { requirepass = cfg.requirePass; }) //
|
|
(lib.optionalAttrs (cfg.maxMemory != null) { maxmemory = cfg.maxMemory; }) //
|
|
(lib.optionalAttrs (cfg.memcachePort != null) { memcache_port = cfg.memcachePort; }) //
|
|
(lib.optionalAttrs (cfg.dbNum != null) { dbnum = cfg.dbNum; }) //
|
|
(lib.optionalAttrs (cfg.cacheMode != null) { cache_mode = cfg.cacheMode; });
|
|
in
|
|
{
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
services.dragonflydb = {
|
|
enable = mkEnableOption (lib.mdDoc "DragonflyDB");
|
|
|
|
user = mkOption {
|
|
type = types.str;
|
|
default = "dragonfly";
|
|
description = lib.mdDoc "The user to run DragonflyDB as";
|
|
};
|
|
|
|
port = mkOption {
|
|
type = types.port;
|
|
default = 6379;
|
|
description = lib.mdDoc "The TCP port to accept connections.";
|
|
};
|
|
|
|
bind = mkOption {
|
|
type = with types; nullOr str;
|
|
default = "127.0.0.1";
|
|
description = lib.mdDoc ''
|
|
The IP interface to bind to.
|
|
`null` means "all interfaces".
|
|
'';
|
|
};
|
|
|
|
requirePass = mkOption {
|
|
type = with types; nullOr str;
|
|
default = null;
|
|
description = lib.mdDoc "Password for database";
|
|
example = "letmein!";
|
|
};
|
|
|
|
maxMemory = mkOption {
|
|
type = with types; nullOr ints.unsigned;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
The maximum amount of memory to use for storage (in bytes).
|
|
`null` means this will be automatically set.
|
|
'';
|
|
};
|
|
|
|
memcachePort = mkOption {
|
|
type = with types; nullOr port;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
To enable memcached compatible API on this port.
|
|
`null` means disabled.
|
|
'';
|
|
};
|
|
|
|
keysOutputLimit = mkOption {
|
|
type = types.ints.unsigned;
|
|
default = 8192;
|
|
description = lib.mdDoc ''
|
|
Maximum number of returned keys in keys command.
|
|
`keys` is a dangerous command.
|
|
We truncate its result to avoid blowup in memory when fetching too many keys.
|
|
'';
|
|
};
|
|
|
|
dbNum = mkOption {
|
|
type = with types; nullOr ints.unsigned;
|
|
default = null;
|
|
description = lib.mdDoc "Maximum number of supported databases for `select`";
|
|
};
|
|
|
|
cacheMode = mkOption {
|
|
type = with types; nullOr bool;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
Once this mode is on, Dragonfly will evict items least likely to be stumbled
|
|
upon in the future but only when it is near maxmemory limit.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
###### implementation
|
|
|
|
config = mkIf config.services.dragonflydb.enable {
|
|
|
|
users.users = optionalAttrs (cfg.user == "dragonfly") {
|
|
dragonfly.description = "DragonflyDB server user";
|
|
dragonfly.isSystemUser = true;
|
|
dragonfly.group = "dragonfly";
|
|
};
|
|
users.groups = optionalAttrs (cfg.user == "dragonfly") { dragonfly = { }; };
|
|
|
|
environment.systemPackages = [ dragonflydb ];
|
|
|
|
systemd.services.dragonflydb = {
|
|
description = "DragonflyDB server";
|
|
|
|
wantedBy = [ "multi-user.target" ];
|
|
after = [ "network.target" ];
|
|
|
|
serviceConfig = {
|
|
ExecStart = "${dragonflydb}/bin/dragonfly --alsologtostderr ${builtins.concatStringsSep " " (attrsets.mapAttrsToList (n: v: "--${n} ${strings.escapeShellArg v}") settings)}";
|
|
|
|
User = cfg.user;
|
|
|
|
# Filesystem access
|
|
ReadWritePaths = [ settings.dir ];
|
|
StateDirectory = "dragonflydb";
|
|
StateDirectoryMode = "0700";
|
|
# Process Properties
|
|
LimitMEMLOCK = "infinity";
|
|
# Caps
|
|
CapabilityBoundingSet = "";
|
|
NoNewPrivileges = true;
|
|
# Sandboxing
|
|
ProtectSystem = "strict";
|
|
ProtectHome = true;
|
|
PrivateTmp = true;
|
|
PrivateDevices = true;
|
|
ProtectKernelTunables = true;
|
|
ProtectKernelModules = true;
|
|
ProtectControlGroups = true;
|
|
LockPersonality = true;
|
|
RestrictAddressFamilies = [ "AF_INET" "AF_INET6" ];
|
|
RestrictRealtime = true;
|
|
PrivateMounts = true;
|
|
MemoryDenyWriteExecute = true;
|
|
};
|
|
};
|
|
};
|
|
}
|