mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-01-07 21:43:32 +00:00
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.
108 lines
3.1 KiB
Nix
108 lines
3.1 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
let
|
|
cfg = config.services.webdav;
|
|
format = pkgs.formats.yaml { };
|
|
in
|
|
{
|
|
options = {
|
|
services.webdav = {
|
|
enable = mkEnableOption "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 = ''
|
|
Environment file as defined in <citerefentry>
|
|
<refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum>
|
|
</citerefentry>.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
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 ];
|
|
}
|