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.
267 lines
8.4 KiB
Nix
267 lines
8.4 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
name = "mpd";
|
|
|
|
uid = config.ids.uids.mpd;
|
|
gid = config.ids.gids.mpd;
|
|
cfg = config.services.mpd;
|
|
|
|
credentialsPlaceholder = (creds:
|
|
let
|
|
placeholders = (imap0
|
|
(i: c: ''password "{{password-${toString i}}}@${concatStringsSep "," c.permissions}"'')
|
|
creds);
|
|
in
|
|
concatStringsSep "\n" placeholders);
|
|
|
|
mpdConf = pkgs.writeText "mpd.conf" ''
|
|
# This file was automatically generated by NixOS. Edit mpd's configuration
|
|
# via NixOS' configuration.nix, as this file will be rewritten upon mpd's
|
|
# restart.
|
|
|
|
music_directory "${cfg.musicDirectory}"
|
|
playlist_directory "${cfg.playlistDirectory}"
|
|
${lib.optionalString (cfg.dbFile != null) ''
|
|
db_file "${cfg.dbFile}"
|
|
''}
|
|
state_file "${cfg.dataDir}/state"
|
|
sticker_file "${cfg.dataDir}/sticker.sql"
|
|
|
|
${optionalString (cfg.network.listenAddress != "any") ''bind_to_address "${cfg.network.listenAddress}"''}
|
|
${optionalString (cfg.network.port != 6600) ''port "${toString cfg.network.port}"''}
|
|
${optionalString (cfg.fluidsynth) ''
|
|
decoder {
|
|
plugin "fluidsynth"
|
|
soundfont "${pkgs.soundfont-fluid}/share/soundfonts/FluidR3_GM2-2.sf2"
|
|
}
|
|
''}
|
|
|
|
${optionalString (cfg.credentials != []) (credentialsPlaceholder cfg.credentials)}
|
|
|
|
${cfg.extraConfig}
|
|
'';
|
|
|
|
in {
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
|
|
services.mpd = {
|
|
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Whether to enable MPD, the music player daemon.
|
|
'';
|
|
};
|
|
|
|
startWhenNeeded = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
If set, {command}`mpd` is socket-activated; that
|
|
is, instead of having it permanently running as a daemon,
|
|
systemd will start it on the first incoming connection.
|
|
'';
|
|
};
|
|
|
|
musicDirectory = mkOption {
|
|
type = with types; either path (strMatching "(http|https|nfs|smb)://.+");
|
|
default = "${cfg.dataDir}/music";
|
|
defaultText = literalExpression ''"''${dataDir}/music"'';
|
|
description = lib.mdDoc ''
|
|
The directory or NFS/SMB network share where MPD reads music from. If left
|
|
as the default value this directory will automatically be created before
|
|
the MPD server starts, otherwise the sysadmin is responsible for ensuring
|
|
the directory exists with appropriate ownership and permissions.
|
|
'';
|
|
};
|
|
|
|
playlistDirectory = mkOption {
|
|
type = types.path;
|
|
default = "${cfg.dataDir}/playlists";
|
|
defaultText = literalExpression ''"''${dataDir}/playlists"'';
|
|
description = lib.mdDoc ''
|
|
The directory where MPD stores playlists. If left as the default value
|
|
this directory will automatically be created before the MPD server starts,
|
|
otherwise the sysadmin is responsible for ensuring the directory exists
|
|
with appropriate ownership and permissions.
|
|
'';
|
|
};
|
|
|
|
extraConfig = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
description = lib.mdDoc ''
|
|
Extra directives added to to the end of MPD's configuration file,
|
|
mpd.conf. Basic configuration like file location and uid/gid
|
|
is added automatically to the beginning of the file. For available
|
|
options see `man 5 mpd.conf`'.
|
|
'';
|
|
};
|
|
|
|
dataDir = mkOption {
|
|
type = types.path;
|
|
default = "/var/lib/${name}";
|
|
description = lib.mdDoc ''
|
|
The directory where MPD stores its state, tag cache, playlists etc. If
|
|
left as the default value this directory will automatically be created
|
|
before the MPD server starts, otherwise the sysadmin is responsible for
|
|
ensuring the directory exists with appropriate ownership and permissions.
|
|
'';
|
|
};
|
|
|
|
user = mkOption {
|
|
type = types.str;
|
|
default = name;
|
|
description = lib.mdDoc "User account under which MPD runs.";
|
|
};
|
|
|
|
group = mkOption {
|
|
type = types.str;
|
|
default = name;
|
|
description = lib.mdDoc "Group account under which MPD runs.";
|
|
};
|
|
|
|
network = {
|
|
|
|
listenAddress = mkOption {
|
|
type = types.str;
|
|
default = "127.0.0.1";
|
|
example = "any";
|
|
description = lib.mdDoc ''
|
|
The address for the daemon to listen on.
|
|
Use `any` to listen on all addresses.
|
|
'';
|
|
};
|
|
|
|
port = mkOption {
|
|
type = types.int;
|
|
default = 6600;
|
|
description = lib.mdDoc ''
|
|
This setting is the TCP port that is desired for the daemon to get assigned
|
|
to.
|
|
'';
|
|
};
|
|
|
|
};
|
|
|
|
dbFile = mkOption {
|
|
type = types.nullOr types.str;
|
|
default = "${cfg.dataDir}/tag_cache";
|
|
defaultText = literalExpression ''"''${dataDir}/tag_cache"'';
|
|
description = lib.mdDoc ''
|
|
The path to MPD's database. If set to `null` the
|
|
parameter is omitted from the configuration.
|
|
'';
|
|
};
|
|
|
|
credentials = mkOption {
|
|
type = types.listOf (types.submodule {
|
|
options = {
|
|
passwordFile = mkOption {
|
|
type = types.path;
|
|
description = lib.mdDoc ''
|
|
Path to file containing the password.
|
|
'';
|
|
};
|
|
permissions = let
|
|
perms = ["read" "add" "control" "admin"];
|
|
in mkOption {
|
|
type = types.listOf (types.enum perms);
|
|
default = [ "read" ];
|
|
description = lib.mdDoc ''
|
|
List of permissions that are granted with this password.
|
|
Permissions can be "${concatStringsSep "\", \"" perms}".
|
|
'';
|
|
};
|
|
};
|
|
});
|
|
description = lib.mdDoc ''
|
|
Credentials and permissions for accessing the mpd server.
|
|
'';
|
|
default = [];
|
|
example = [
|
|
{passwordFile = "/var/lib/secrets/mpd_readonly_password"; permissions = [ "read" ];}
|
|
{passwordFile = "/var/lib/secrets/mpd_admin_password"; permissions = ["read" "add" "control" "admin"];}
|
|
];
|
|
};
|
|
|
|
fluidsynth = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
If set, add fluidsynth soundfont and configure the plugin.
|
|
'';
|
|
};
|
|
};
|
|
|
|
};
|
|
|
|
|
|
###### implementation
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
# install mpd units
|
|
systemd.packages = [ pkgs.mpd ];
|
|
|
|
systemd.sockets.mpd = mkIf cfg.startWhenNeeded {
|
|
wantedBy = [ "sockets.target" ];
|
|
listenStreams = [
|
|
"" # Note: this is needed to override the upstream unit
|
|
(if pkgs.lib.hasPrefix "/" cfg.network.listenAddress
|
|
then cfg.network.listenAddress
|
|
else "${optionalString (cfg.network.listenAddress != "any") "${cfg.network.listenAddress}:"}${toString cfg.network.port}")
|
|
];
|
|
};
|
|
|
|
systemd.services.mpd = {
|
|
wantedBy = optional (!cfg.startWhenNeeded) "multi-user.target";
|
|
|
|
preStart =
|
|
''
|
|
set -euo pipefail
|
|
install -m 600 ${mpdConf} /run/mpd/mpd.conf
|
|
'' + optionalString (cfg.credentials != [])
|
|
(concatStringsSep "\n"
|
|
(imap0
|
|
(i: c: ''${pkgs.replace-secret}/bin/replace-secret '{{password-${toString i}}}' '${c.passwordFile}' /run/mpd/mpd.conf'')
|
|
cfg.credentials));
|
|
|
|
serviceConfig =
|
|
{
|
|
User = "${cfg.user}";
|
|
# Note: the first "" overrides the ExecStart from the upstream unit
|
|
ExecStart = [ "" "${pkgs.mpd}/bin/mpd --systemd /run/mpd/mpd.conf" ];
|
|
RuntimeDirectory = "mpd";
|
|
StateDirectory = []
|
|
++ optionals (cfg.dataDir == "/var/lib/${name}") [ name ]
|
|
++ optionals (cfg.playlistDirectory == "/var/lib/${name}/playlists") [ name "${name}/playlists" ]
|
|
++ optionals (cfg.musicDirectory == "/var/lib/${name}/music") [ name "${name}/music" ];
|
|
};
|
|
};
|
|
|
|
users.users = optionalAttrs (cfg.user == name) {
|
|
${name} = {
|
|
inherit uid;
|
|
group = cfg.group;
|
|
extraGroups = [ "audio" ];
|
|
description = "Music Player Daemon user";
|
|
home = "${cfg.dataDir}";
|
|
};
|
|
};
|
|
|
|
users.groups = optionalAttrs (cfg.group == name) {
|
|
${name}.gid = gid;
|
|
};
|
|
};
|
|
|
|
}
|