e65131e69c
This process was automated by [my fork of `nix-doc-munge`]; thanks
to @pennae for writing this tool! It automatically checks that the
resulting documentation doesn't change, although my fork loosens
this a little to ignore some irrelevant whitespace and typographical
differences.
As of this commit there is no DocBook remaining in the options
documentation.
You can play along at home if you want to reproduce this commit:
$ NIX_PATH=nixpkgs=flake:nixpkgs/c1bca7fe84c646cfd4ebf3482c0e6317a0b13f22 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run github:emilazy/nix-doc-munge/0a7190f600027bf7baf6cb7139e4d69ac2f51062 \
{} +
[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge
82 lines
2.3 KiB
Nix
82 lines
2.3 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.redis;
|
|
in
|
|
|
|
{
|
|
options = {
|
|
services.redis.enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc "Whether to enable the redis database service.";
|
|
};
|
|
|
|
services.redis.package = mkOption {
|
|
type = types.path;
|
|
default = pkgs.redis;
|
|
defaultText = "pkgs.redis";
|
|
description = lib.mdDoc "This option specifies the redis package to use";
|
|
};
|
|
|
|
services.redis.dataDir = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = "/var/lib/redis";
|
|
description = lib.mdDoc "Data directory for the redis database.";
|
|
};
|
|
|
|
services.redis.port = mkOption {
|
|
type = types.int;
|
|
default = 6379;
|
|
description = lib.mdDoc "The port for Redis to listen to.";
|
|
};
|
|
|
|
services.redis.bind = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = null; # All interfaces
|
|
description = lib.mdDoc "The IP interface to bind to.";
|
|
example = "127.0.0.1";
|
|
};
|
|
|
|
services.redis.unixSocket = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = null;
|
|
description = lib.mdDoc "The path to the socket to bind to.";
|
|
example = "/var/run/redis.sock";
|
|
};
|
|
|
|
services.redis.appendOnly = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc "By default data is only periodically persisted to disk, enable this option to use an append-only file for improved persistence.";
|
|
};
|
|
|
|
services.redis.extraConfig = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
description = lib.mdDoc "Additional text to be appended to {file}`redis.conf`.";
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
environment.systemPackages = [ cfg.package ];
|
|
|
|
launchd.user.agents.redis = {
|
|
command = "${cfg.package}/bin/redis-server /etc/redis.conf";
|
|
serviceConfig.KeepAlive = true;
|
|
};
|
|
|
|
environment.etc."redis.conf".text = ''
|
|
port ${toString cfg.port}
|
|
${optionalString (cfg.bind != null) "bind ${cfg.bind}"}
|
|
${optionalString (cfg.unixSocket != null) "unixsocket ${cfg.unixSocket}"}
|
|
${optionalString (cfg.dataDir != null) "dir ${cfg.dataDir}"}
|
|
appendOnly ${if cfg.appendOnly then "yes" else "no"}
|
|
${cfg.extraConfig}
|
|
'';
|
|
|
|
};
|
|
}
|