nixpkgs/nixos/modules/services/misc/subsonic.nix
pennae ef176dcf7e nixos/*: automatically convert option descriptions
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.
2022-08-31 16:32:53 +02:00

170 lines
5.4 KiB
Nix

{ config, lib, options, pkgs, ... }:
with lib;
let
cfg = config.services.subsonic;
opt = options.services.subsonic;
in {
options = {
services.subsonic = {
enable = mkEnableOption (lib.mdDoc "Subsonic daemon");
home = mkOption {
type = types.path;
default = "/var/lib/subsonic";
description = lib.mdDoc ''
The directory where Subsonic will create files.
Make sure it is writable.
'';
};
listenAddress = mkOption {
type = types.str;
default = "0.0.0.0";
description = lib.mdDoc ''
The host name or IP address on which to bind Subsonic.
Only relevant if you have multiple network interfaces and want
to make Subsonic available on only one of them. The default value
will bind Subsonic to all available network interfaces.
'';
};
port = mkOption {
type = types.port;
default = 4040;
description = lib.mdDoc ''
The port on which Subsonic will listen for
incoming HTTP traffic. Set to 0 to disable.
'';
};
httpsPort = mkOption {
type = types.port;
default = 0;
description = lib.mdDoc ''
The port on which Subsonic will listen for
incoming HTTPS traffic. Set to 0 to disable.
'';
};
contextPath = mkOption {
type = types.path;
default = "/";
description = lib.mdDoc ''
The context path, i.e., the last part of the Subsonic
URL. Typically '/' or '/subsonic'. Default '/'
'';
};
maxMemory = mkOption {
type = types.int;
default = 100;
description = lib.mdDoc ''
The memory limit (max Java heap size) in megabytes.
Default: 100
'';
};
defaultMusicFolder = mkOption {
type = types.path;
default = "/var/music";
description = lib.mdDoc ''
Configure Subsonic to use this folder for music. This option
only has effect the first time Subsonic is started.
'';
};
defaultPodcastFolder = mkOption {
type = types.path;
default = "/var/music/Podcast";
description = lib.mdDoc ''
Configure Subsonic to use this folder for Podcasts. This option
only has effect the first time Subsonic is started.
'';
};
defaultPlaylistFolder = mkOption {
type = types.path;
default = "/var/playlists";
description = lib.mdDoc ''
Configure Subsonic to use this folder for playlists. This option
only has effect the first time Subsonic is started.
'';
};
transcoders = mkOption {
type = types.listOf types.path;
default = [ "${pkgs.ffmpeg.bin}/bin/ffmpeg" ];
defaultText = literalExpression ''[ "''${pkgs.ffmpeg.bin}/bin/ffmpeg" ]'';
description = lib.mdDoc ''
List of paths to transcoder executables that should be accessible
from Subsonic. Symlinks will be created to each executable inside
''${config.${opt.home}}/transcoders.
'';
};
};
};
config = mkIf cfg.enable {
systemd.services.subsonic = {
description = "Personal media streamer";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
script = ''
${pkgs.jre8}/bin/java -Xmx${toString cfg.maxMemory}m \
-Dsubsonic.home=${cfg.home} \
-Dsubsonic.host=${cfg.listenAddress} \
-Dsubsonic.port=${toString cfg.port} \
-Dsubsonic.httpsPort=${toString cfg.httpsPort} \
-Dsubsonic.contextPath=${cfg.contextPath} \
-Dsubsonic.defaultMusicFolder=${cfg.defaultMusicFolder} \
-Dsubsonic.defaultPodcastFolder=${cfg.defaultPodcastFolder} \
-Dsubsonic.defaultPlaylistFolder=${cfg.defaultPlaylistFolder} \
-Djava.awt.headless=true \
-verbose:gc \
-jar ${pkgs.subsonic}/subsonic-booter-jar-with-dependencies.jar
'';
preStart = ''
# Formerly this module set cfg.home to /var/subsonic. Try to move
# /var/subsonic to cfg.home.
oldHome="/var/subsonic"
if [ "${cfg.home}" != "$oldHome" ] &&
! [ -e "${cfg.home}" ] &&
[ -d "$oldHome" ] &&
[ $(${pkgs.coreutils}/bin/stat -c %u "$oldHome") -eq \
${toString config.users.users.subsonic.uid} ]; then
logger Moving "$oldHome" to "${cfg.home}"
${pkgs.coreutils}/bin/mv -T "$oldHome" "${cfg.home}"
fi
# Install transcoders.
${pkgs.coreutils}/bin/rm -rf ${cfg.home}/transcode ; \
${pkgs.coreutils}/bin/mkdir -p ${cfg.home}/transcode ; \
${pkgs.bash}/bin/bash -c ' \
for exe in "$@"; do \
${pkgs.coreutils}/bin/ln -sf "$exe" ${cfg.home}/transcode; \
done' IGNORED_FIRST_ARG ${toString cfg.transcoders}
'';
serviceConfig = {
# Needed for Subsonic to find subsonic.war.
WorkingDirectory = "${pkgs.subsonic}";
Restart = "always";
User = "subsonic";
UMask = "0022";
};
};
users.users.subsonic = {
description = "Subsonic daemon user";
home = cfg.home;
createHome = true;
group = "subsonic";
uid = config.ids.uids.subsonic;
};
users.groups.subsonic.gid = config.ids.gids.subsonic;
};
}