mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-12-25 23:23:07 +00:00
ef176dcf7e
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.
106 lines
3.0 KiB
Nix
106 lines
3.0 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
let
|
|
cfg = config.services.webdav;
|
|
format = pkgs.formats.yaml { };
|
|
in
|
|
{
|
|
options = {
|
|
services.webdav = {
|
|
enable = mkEnableOption (lib.mdDoc "WebDAV server");
|
|
|
|
user = mkOption {
|
|
type = types.str;
|
|
default = "webdav";
|
|
description = lib.mdDoc "User account under which WebDAV runs.";
|
|
};
|
|
|
|
group = mkOption {
|
|
type = types.str;
|
|
default = "webdav";
|
|
description = lib.mdDoc "Group under which WebDAV runs.";
|
|
};
|
|
|
|
settings = mkOption {
|
|
type = format.type;
|
|
default = { };
|
|
description = lib.mdDoc ''
|
|
Attrset that is converted and passed as config file. Available options
|
|
can be found at
|
|
[here](https://github.com/hacdias/webdav).
|
|
|
|
This program supports reading username and password configuration
|
|
from environment variables, so it's strongly recommended to store
|
|
username and password in a separate
|
|
[EnvironmentFile](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#EnvironmentFile=).
|
|
This prevents adding secrets to the world-readable Nix store.
|
|
'';
|
|
example = literalExpression ''
|
|
{
|
|
address = "0.0.0.0";
|
|
port = 8080;
|
|
scope = "/srv/public";
|
|
modify = true;
|
|
auth = true;
|
|
users = [
|
|
{
|
|
username = "{env}ENV_USERNAME";
|
|
password = "{env}ENV_PASSWORD";
|
|
}
|
|
];
|
|
}
|
|
'';
|
|
};
|
|
|
|
configFile = mkOption {
|
|
type = types.path;
|
|
default = format.generate "webdav.yaml" cfg.settings;
|
|
defaultText = "Config file generated from services.webdav.settings";
|
|
description = lib.mdDoc ''
|
|
Path to config file. If this option is set, it will override any
|
|
configuration done in options.services.webdav.settings.
|
|
'';
|
|
example = "/etc/webdav/config.yaml";
|
|
};
|
|
|
|
environmentFile = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
Environment file as defined in {manpage}`systemd.exec(5)`.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
users.users = mkIf (cfg.user == "webdav") {
|
|
webdav = {
|
|
description = "WebDAV daemon user";
|
|
group = cfg.group;
|
|
uid = config.ids.uids.webdav;
|
|
};
|
|
};
|
|
|
|
users.groups = mkIf (cfg.group == "webdav") {
|
|
webdav.gid = config.ids.gids.webdav;
|
|
};
|
|
|
|
systemd.services.webdav = {
|
|
description = "WebDAV server";
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.webdav}/bin/webdav -c ${cfg.configFile}";
|
|
Restart = "on-failure";
|
|
User = cfg.user;
|
|
Group = cfg.group;
|
|
EnvironmentFile = mkIf (cfg.environmentFile != null) [ cfg.environmentFile ];
|
|
};
|
|
};
|
|
};
|
|
|
|
meta.maintainers = with maintainers; [ pmy ];
|
|
}
|