Skip to content

Commit

Permalink
nixos/shoko: init
Browse files Browse the repository at this point in the history
  • Loading branch information
diniamo committed Jan 22, 2025
1 parent 855baa3 commit 4b8442d
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 0 deletions.
1 change: 1 addition & 0 deletions nixos/modules/module-list.nix
Original file line number Diff line number Diff line change
Expand Up @@ -867,6 +867,7 @@
./services/misc/safeeyes.nix
./services/misc/sdrplay.nix
./services/misc/serviio.nix
./services/misc/shoko.nix
./services/misc/sickbeard.nix
./services/misc/signald.nix
./services/misc/siproxd.nix
Expand Down
87 changes: 87 additions & 0 deletions nixos/modules/services/misc/shoko.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
{
lib,
config,
pkgs,
...
}:
let
inherit (lib)
mkOption
types
mkIf
mkEnableOption
mkPackageOption
getExe
optionalString
;

cfg = config.services.shoko;
in
{
options = {
services.shoko = {
enable = mkEnableOption "Shoko";

package = mkPackageOption pkgs "shoko" { };
webui = mkPackageOption pkgs "shoko-webui" { nullable = true; };
plugins = mkOption {
type = types.listOf types.package;
default = [ ];
description = ''
The plugins to install.
Note that if there are plugins installed imperatively when this
option is used, they will be deleted.
'';
};

openFirewall = mkOption {
type = types.bool;
default = false;
description = ''
Open ports in the firewall for the ShokoAnime api and web interface.
'';
};
};
};

config = mkIf cfg.enable {
networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ 8111 ];

systemd.services.shoko = {
description = "Shoko Server";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];

# Not that it should be done, but this makes it easier to override the
# StateDirectory option, if the user really wants to.
environment.SHOKO_HOME = "/var/lib/${config.systemd.services.shoko.serviceConfig.StateDirectory}";

# The rm calls are here, because it's pretty easy to get into a situation
# where those directories are created imperatively, in which case the ln
# calls (along with the service) would just fail.
preStart =
optionalString (cfg.webui != null) ''
rm -rf "$STATE_DIRECTORY/webui"
ln -s '${cfg.webui}' "$STATE_DIRECTORY/webui"
''
+ optionalString (cfg.plugins != [ ]) ''
rm -rf "$STATE_DIRECTORY/plugins"
ln -s '${pkgs.linkFarmFromDrvs cfg.plugins}' "$STATE_DIRECTORY/plugins"
'';

serviceConfig = {
Type = "simple";

DynamicUser = true;
StateDirectory = "shoko";
StateDirectoryMode = 750;

ExecStart = getExe cfg.package;
Restart = "on-failure";
};
};
};

meta.maintainers = [ lib.maintainers.diniamo ];
}
1 change: 1 addition & 0 deletions nixos/tests/all-tests.nix
Original file line number Diff line number Diff line change
Expand Up @@ -942,6 +942,7 @@ in {
shadow = handleTest ./shadow.nix {};
shadowsocks = handleTest ./shadowsocks {};
shattered-pixel-dungeon = handleTest ./shattered-pixel-dungeon.nix {};
shoko = handleTest ./shoko.nix {};
shiori = handleTest ./shiori.nix {};
signal-desktop = handleTest ./signal-desktop.nix {};
silverbullet = handleTest ./silverbullet.nix {};
Expand Down
18 changes: 18 additions & 0 deletions nixos/tests/shoko.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import ./make-test-python.nix (
{ lib, ... }:
{
name = "Shoko";

nodes.machine = {
services.shoko.enable = true;
};

testScript = ''
machine.wait_for_unit("shoko.service")
machine.wait_for_open_port(8111)
machine.succeed("curl --fail http://localhost:8111")
'';

meta.maintainers = [ lib.maintainers.diniamo ];
}
)

0 comments on commit 4b8442d

Please sign in to comment.