nixos/modules/services/web-apps/suwayomi-server.md

   1 # Suwayomi-Server {#module-services-suwayomi-server}
   2
   3 A free and open source manga reader server that runs extensions built for Tachiyomi.
   4
   5 ## Basic usage {#module-services-suwayomi-server-basic-usage}
   6
   7 By default, the module will execute Suwayomi-Server backend and web UI:
   8
   9 ```nix
  10 { ... }:
  11
  12 {
  13   services.suwayomi-server = {
  14     enable = true;
  15   };
  16 }
  17 ```
  18
  19 It runs in the systemd service named `suwayomi-server` in the data directory `/var/lib/suwayomi-server`.
  20
  21 You can change the default parameters with some other parameters:
  22 ```nix
  23 { ... }:
  24
  25 {
  26   services.suwayomi-server = {
  27     enable = true;
  28
  29     dataDir = "/var/lib/suwayomi"; # Default is "/var/lib/suwayomi-server"
  30     openFirewall = true;
  31
  32     settings = {
  33       server.port = 4567;
  34     };
  35   };
  36 }
  37 ```
  38
  39 If you want to create a desktop icon, you can activate the system tray option:
  40
  41 ```nix
  42 { ... }:
  43
  44 {
  45   services.suwayomi-server = {
  46     enable = true;
  47
  48     dataDir = "/var/lib/suwayomi"; # Default is "/var/lib/suwayomi-server"
  49     openFirewall = true;
  50
  51     settings = {
  52       server.port = 4567;
  53       server.enableSystemTray = true;
  54     };
  55   };
  56 }
  57 ```
  58
  59 ## Basic authentication {#module-services-suwayomi-server-basic-auth}
  60
  61 You can configure a basic authentication to the web interface with:
  62
  63 ```nix
  64 { ... }:
  65
  66 {
  67   services.suwayomi-server = {
  68     enable = true;
  69
  70     openFirewall = true;
  71
  72     settings = {
  73       server.port = 4567;
  74       server = {
  75         basicAuthEnabled = true;
  76         basicAuthUsername = "username";
  77
  78         # NOTE: this is not a real upstream option
  79         basicAuthPasswordFile = ./path/to/the/password/file;
  80       };
  81     };
  82   };
  83 }
  84 ```
  85
  86 ## Extra configuration {#module-services-suwayomi-server-extra-config}
  87
  88 Not all the configuration options are available directly in this module, but you can add the other options of suwayomi-server with:
  89
  90 ```nix
  91 { ... }:
  92
  93 {
  94   services.suwayomi-server = {
  95     enable = true;
  96
  97     openFirewall = true;
  98
  99     settings = {
 100       server = {
 101         port = 4567;
 102         autoDownloadNewChapters = false;
 103         maxSourcesInParallel = 6;
 104         extensionRepos = [
 105           "https://raw.githubusercontent.com/MY_ACCOUNT/MY_REPO/repo/index.min.json"
 106         ];
 107       };
 108     };
 109   };
 110 }
 111 ```