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.
165 lines
4.7 KiB
Nix
165 lines
4.7 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
let
|
|
cfg = config.services.calibre-web;
|
|
|
|
inherit (lib) concatStringsSep mkEnableOption mkIf mkOption optional optionalString types;
|
|
in
|
|
{
|
|
options = {
|
|
services.calibre-web = {
|
|
enable = mkEnableOption "Calibre-Web";
|
|
|
|
listen = {
|
|
ip = mkOption {
|
|
type = types.str;
|
|
default = "::1";
|
|
description = lib.mdDoc ''
|
|
IP address that Calibre-Web should listen on.
|
|
'';
|
|
};
|
|
|
|
port = mkOption {
|
|
type = types.port;
|
|
default = 8083;
|
|
description = lib.mdDoc ''
|
|
Listen port for Calibre-Web.
|
|
'';
|
|
};
|
|
};
|
|
|
|
dataDir = mkOption {
|
|
type = types.str;
|
|
default = "calibre-web";
|
|
description = lib.mdDoc ''
|
|
The directory below {file}`/var/lib` where Calibre-Web stores its data.
|
|
'';
|
|
};
|
|
|
|
user = mkOption {
|
|
type = types.str;
|
|
default = "calibre-web";
|
|
description = lib.mdDoc "User account under which Calibre-Web runs.";
|
|
};
|
|
|
|
group = mkOption {
|
|
type = types.str;
|
|
default = "calibre-web";
|
|
description = lib.mdDoc "Group account under which Calibre-Web runs.";
|
|
};
|
|
|
|
openFirewall = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Open ports in the firewall for the server.
|
|
'';
|
|
};
|
|
|
|
options = {
|
|
calibreLibrary = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
Path to Calibre library.
|
|
'';
|
|
};
|
|
|
|
enableBookConversion = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Configure path to the Calibre's ebook-convert in the DB.
|
|
'';
|
|
};
|
|
|
|
enableBookUploading = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Allow books to be uploaded via Calibre-Web UI.
|
|
'';
|
|
};
|
|
|
|
reverseProxyAuth = {
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Enable authorization using auth proxy.
|
|
'';
|
|
};
|
|
|
|
header = mkOption {
|
|
type = types.str;
|
|
default = "";
|
|
description = lib.mdDoc ''
|
|
Auth proxy header name.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
systemd.services.calibre-web = let
|
|
appDb = "/var/lib/${cfg.dataDir}/app.db";
|
|
gdriveDb = "/var/lib/${cfg.dataDir}/gdrive.db";
|
|
calibreWebCmd = "${pkgs.calibre-web}/bin/calibre-web -p ${appDb} -g ${gdriveDb}";
|
|
|
|
settings = concatStringsSep ", " (
|
|
[
|
|
"config_port = ${toString cfg.listen.port}"
|
|
"config_uploading = ${if cfg.options.enableBookUploading then "1" else "0"}"
|
|
"config_allow_reverse_proxy_header_login = ${if cfg.options.reverseProxyAuth.enable then "1" else "0"}"
|
|
"config_reverse_proxy_login_header_name = '${cfg.options.reverseProxyAuth.header}'"
|
|
]
|
|
++ optional (cfg.options.calibreLibrary != null) "config_calibre_dir = '${cfg.options.calibreLibrary}'"
|
|
++ optional cfg.options.enableBookConversion "config_converterpath = '${pkgs.calibre}/bin/ebook-convert'"
|
|
);
|
|
in
|
|
{
|
|
description = "Web app for browsing, reading and downloading eBooks stored in a Calibre database";
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
serviceConfig = {
|
|
Type = "simple";
|
|
User = cfg.user;
|
|
Group = cfg.group;
|
|
|
|
StateDirectory = cfg.dataDir;
|
|
ExecStartPre = pkgs.writeShellScript "calibre-web-pre-start" (
|
|
''
|
|
__RUN_MIGRATIONS_AND_EXIT=1 ${calibreWebCmd}
|
|
|
|
${pkgs.sqlite}/bin/sqlite3 ${appDb} "update settings set ${settings}"
|
|
'' + optionalString (cfg.options.calibreLibrary != null) ''
|
|
test -f "${cfg.options.calibreLibrary}/metadata.db" || { echo "Invalid Calibre library"; exit 1; }
|
|
''
|
|
);
|
|
|
|
ExecStart = "${calibreWebCmd} -i ${cfg.listen.ip}";
|
|
Restart = "on-failure";
|
|
};
|
|
};
|
|
|
|
networking.firewall = mkIf cfg.openFirewall {
|
|
allowedTCPPorts = [ cfg.listen.port ];
|
|
};
|
|
|
|
users.users = mkIf (cfg.user == "calibre-web") {
|
|
calibre-web = {
|
|
isSystemUser = true;
|
|
group = cfg.group;
|
|
};
|
|
};
|
|
|
|
users.groups = mkIf (cfg.group == "calibre-web") {
|
|
calibre-web = {};
|
|
};
|
|
};
|
|
|
|
meta.maintainers = with lib.maintainers; [ pborzenkov ];
|
|
}
|