Skip to content

Suwayomi server

services.suwayomi-server.dataDir

The path to the data directory in which Suwayomi-Server will download scans.

Type: path

Default

"/var/lib/suwayomi-server"

Example

"/var/data/mangas"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.enable

Whether to enable Suwayomi, a free and open source manga reader server that runs extensions built for Tachiyomi. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.group

Group under which Suwayomi-Server runs.

Type: string

Default

"suwayomi"

Example

"medias"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.openFirewall

Whether to open the firewall for the port in {option}services.suwayomi-server.settings.server.port.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.package

The suwayomi-server package to use. Type: package

Default

pkgs.suwayomi-server

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings

Configuration to write to {file}server.conf. See https://github.com/Suwayomi/Suwayomi-Server/wiki/Configuring-Suwayomi-Server for more information.

Type: HOCON value

Default

{ }

Example

{server = {socksProxyEnabled = true;socksProxyHost = "yourproxyhost.com";socksProxyPort = "8080";};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings.server.basicAuthEnabled

Whether to enable basic access authentication for Suwayomi-Server. Enabling this option is useful when hosting on a public network/the Internet . Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings.server.basicAuthPasswordFile

The password file containing the value that you have to provide when authenticating.

Type: null or path

Default

null

Example

"/var/secrets/suwayomi-server-password"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings.server.basicAuthUsername

The username value that you have to provide when authenticating.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings.server.downloadAsCbz

Download chapters as .cbz files.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings.server.extensionRepos

URL of repositories from which the extensions can be installed.

Type: list of string

Default

[ ]

Example

["https://raw.githubusercontent.com/MY_ACCOUNT/MY_REPO/repo/index.min.json"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings.server.ip

The ip that Suwayomi will bind to.

Type: string

Default

"0.0.0.0"

Example

"127.0.0.1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings.server.localSourcePath

Path to the local source folder.

Type: path

Default

suwayomi-server.dataDir

Example

"/var/data/local_mangas"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings.server.port

The port that Suwayomi will listen to.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

8080

Example

4567

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.settings.server.systemTrayEnabled

Whether to enable a system tray icon, if possible.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix

services.suwayomi-server.user

User account under which Suwayomi-Server runs.

Type: string

Default

"suwayomi"

Example

"root"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/web-apps/suwayomi-server.nix