Skip to content

Samba

services.samba.configText

Verbatim contents of smb.conf. If null (default), use the autogenerated file from NixOS instead.

Type: null or strings concatenated with "\n"

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.enable

Whether to enable Samba, which provides file and print services to Windows clients through the SMB/CIFS protocol.

::: {.note} If you use the firewall consider adding the following:

services.samba.openFirewall = true;

:::

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.enableNmbd

Whether to enable Samba's nmbd, which replies to NetBIOS over IP name service requests. It also participates in the browsing protocols which make up the Windows "Network Neighborhood" view.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.enableWinbindd

Whether to enable Samba's winbindd, which provides a number of services to the Name Service Switch capability found in most modern C libraries, to arbitrary applications via PAM and ntlm_auth and to Samba itself.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.extraConfig

Additional global section and extra section lines go in here.

Type: strings concatenated with "\n"

Default

""

Example

'' guest account = nobody map to guest = bad user''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.invalidUsers

List of users who are denied to login via Samba.

Type: list of string

Default

["root"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.nsswins

Whether to enable the WINS NSS (Name Service Switch) plug-in. Enabling it allows applications to resolve WINS/NetBIOS names (a.k.a. Windows machine names) by transparently querying the winbindd daemon.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.openFirewall

Whether to automatically open the necessary ports in the firewall.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.package

The samba package to use. Type: package

Default

pkgs.samba

Example

samba4Full

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.securityType

Samba security type Type: one of "auto", "user", "domain", "ads"

Default

"user"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix

services.samba.shares

A set describing shared resources. See {command}man smb.conf for options.

Type: attribute set of attribute set of unspecified value

Default

{ }

Example

{ public ={ path = "/srv/public";"read only" = true;browseable = "yes";"guest ok" = "yes";comment = "Public samba share.";};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/samba.nix