Sftpgo

`services.sftpgo.dataDir`

The directory where SFTPGo stores its data files.

Type: string

Default

"/var/lib/sftpgo"

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

`services.sftpgo.enable`

sftpgo Type: boolean

Default

false

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

`services.sftpgo.extraArgs`

Additional command line arguments to pass to the sftpgo daemon.

Type: list of string

Default

[ ]

Example

["--log-level""info"]

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

`services.sftpgo.group`

Group name under which SFTPGo runs.

Type: string

Default

"sftpgo"

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

`services.sftpgo.loadDataFile`

Path to a json file containing users and folders to load (or update) on startup. Check the documentation for the --loaddata-from command line argument for more info.

Type: null or path

Default

null

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

`services.sftpgo.package`

The sftpgo package to use. Type: package

Default

pkgs.sftpgo

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

`services.sftpgo.settings`

The primary sftpgo configuration. See the configuration reference for possible values.

Type: JSON value

Default

{ }

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

`services.sftpgo.settings.ftpd.bindings`

Configure listen addresses and ports for ftpd.

Type: list of (JSON value)

Default

[ ]

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

`services.sftpgo.settings.ftpd.bindings.*.address`

Network listen address. Leave blank to listen on all available network interfaces. On *NIX you can specify an absolute path to listen on a Unix-domain socket.

Type: string

Default

"127.0.0.1"

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

`services.sftpgo.settings.ftpd.bindings.*.port`

The port for serving FTP requests.

Setting the port to 0 disables listening on this interface binding.

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

Default

0

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

`services.sftpgo.settings.httpd.bindings`

Configure listen addresses and ports for httpd.

Type: list of (JSON value)

Default

[ ]

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

`services.sftpgo.settings.httpd.bindings.*.address`

Network listen address. Leave blank to listen on all available network interfaces. On *NIX you can specify an absolute path to listen on a Unix-domain socket.

Type: string

Default

"127.0.0.1"

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

`services.sftpgo.settings.httpd.bindings.*.enable_web_admin`

Enable the built-in web admin for this interface binding.

Type: boolean

Default

true

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

`services.sftpgo.settings.httpd.bindings.*.enable_web_client`

Enable the built-in web client for this interface binding.

Type: boolean

Default

true

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

`services.sftpgo.settings.httpd.bindings.*.port`

The port for serving HTTP(S) requests.

Setting the port to 0 disables listening on this interface binding.

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

Default

8080

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

`services.sftpgo.settings.sftpd.bindings`

Configure listen addresses and ports for sftpd.

Type: list of (JSON value)

Default

[ ]

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

`services.sftpgo.settings.sftpd.bindings.*.address`

Network listen address. Leave blank to listen on all available network interfaces. On *NIX you can specify an absolute path to listen on a Unix-domain socket.

Type: string

Default

"127.0.0.1"

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

`services.sftpgo.settings.sftpd.bindings.*.port`

The port for serving SFTP requests.

Setting the port to 0 disables listening on this interface binding.

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

Default

0

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

`services.sftpgo.settings.smtp`

SMTP configuration section.

Type: JSON value

Default

{ }

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

`services.sftpgo.settings.smtp.auth_type`

0: Plain
1: Login
2: CRAM-MD5

Type: one of 0, 1, 2

Default

0

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

`services.sftpgo.settings.smtp.encryption`

Encryption scheme: - 0: No encryption - 1: TLS - 2: STARTTLS

Type: one of 0, 1, 2

Default

1

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

`services.sftpgo.settings.smtp.from`

From address.

Type: string

Default

"SFTPGo <sftpgo@example.com>"

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

`services.sftpgo.settings.smtp.host`

Location of SMTP email server. Leave empty to disable email sending capabilities.

Type: string

Default

""

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

`services.sftpgo.settings.smtp.port`

Port of the SMTP Server. Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

465

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

`services.sftpgo.settings.smtp.user`

SMTP username. Type: string

Default

"sftpgo"

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

`services.sftpgo.settings.webdavd.bindings`

Configure listen addresses and ports for webdavd.

Type: list of (JSON value)

Default

[ ]

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

`services.sftpgo.settings.webdavd.bindings.*.address`

Network listen address. Leave blank to listen on all available network interfaces. On *NIX you can specify an absolute path to listen on a Unix-domain socket.

Type: string

Default

"127.0.0.1"

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

`services.sftpgo.settings.webdavd.bindings.*.port`

The port for serving WebDAV requests.

Setting the port to 0 disables listening on this interface binding.

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

Default

0

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

`services.sftpgo.user`

User account name under which SFTPGo runs.

Type: string

Default

"sftpgo"

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