mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-01-16 01:45:11 +00:00
0a6e6cf7e6
this converts meta.doc into an md pointer, not an xml pointer. since we no longer need xml for manual chapters we can also remove support for manual chapters from md-to-db.sh since pandoc converts smart quotes to docbook quote elements and our nixos-render-docs does not we lose this distinction in the rendered output. that's probably not that bad, our stylesheet didn't make use of this anyway (and pre-23.05 versions of the chapters didn't use quote elements either). also updates the nixpkgs manual to clarify that option docs support all extensions (although it doesn't support headings at all, so heading anchors don't work by extension).
100 lines
2.8 KiB
Nix
100 lines
2.8 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.litestream;
|
|
settingsFormat = pkgs.formats.yaml {};
|
|
in
|
|
{
|
|
options.services.litestream = {
|
|
enable = mkEnableOption (lib.mdDoc "litestream");
|
|
|
|
package = mkOption {
|
|
description = lib.mdDoc "Package to use.";
|
|
default = pkgs.litestream;
|
|
defaultText = literalExpression "pkgs.litestream";
|
|
type = types.package;
|
|
};
|
|
|
|
settings = mkOption {
|
|
description = lib.mdDoc ''
|
|
See the [documentation](https://litestream.io/reference/config/).
|
|
'';
|
|
type = settingsFormat.type;
|
|
example = {
|
|
dbs = [
|
|
{
|
|
path = "/var/lib/db1";
|
|
replicas = [
|
|
{
|
|
url = "s3://mybkt.litestream.io/db1";
|
|
}
|
|
];
|
|
}
|
|
];
|
|
};
|
|
};
|
|
|
|
environmentFile = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = null;
|
|
example = "/run/secrets/litestream";
|
|
description = lib.mdDoc ''
|
|
Environment file as defined in {manpage}`systemd.exec(5)`.
|
|
|
|
Secrets may be passed to the service without adding them to the
|
|
world-readable Nix store, by specifying placeholder variables as
|
|
the option value in Nix and setting these variables accordingly in the
|
|
environment file.
|
|
|
|
By default, Litestream will perform environment variable expansion
|
|
within the config file before reading it. Any references to ''$VAR or
|
|
''${VAR} formatted variables will be replaced with their environment
|
|
variable values. If no value is set then it will be replaced with an
|
|
empty string.
|
|
|
|
```
|
|
# Content of the environment file
|
|
LITESTREAM_ACCESS_KEY_ID=AKIAxxxxxxxxxxxxxxxx
|
|
LITESTREAM_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxx
|
|
```
|
|
|
|
Note that this file needs to be available on the host on which
|
|
this exporter is running.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
environment.systemPackages = [ cfg.package ];
|
|
environment.etc = {
|
|
"litestream.yml" = {
|
|
source = settingsFormat.generate "litestream-config.yaml" cfg.settings;
|
|
};
|
|
};
|
|
|
|
systemd.services.litestream = {
|
|
description = "Litestream";
|
|
wantedBy = [ "multi-user.target" ];
|
|
after = [ "networking.target" ];
|
|
serviceConfig = {
|
|
EnvironmentFile = mkIf (cfg.environmentFile != null) cfg.environmentFile;
|
|
ExecStart = "${cfg.package}/bin/litestream replicate";
|
|
Restart = "always";
|
|
User = "litestream";
|
|
Group = "litestream";
|
|
};
|
|
};
|
|
|
|
users.users.litestream = {
|
|
description = "Litestream user";
|
|
group = "litestream";
|
|
isSystemUser = true;
|
|
};
|
|
users.groups.litestream = {};
|
|
};
|
|
|
|
meta.doc = ./default.md;
|
|
}
|