samba module: add more description

Fixes #13281
This commit is contained in:
zimbatm 2016-02-21 19:37:05 +00:00
parent 93a0306e79
commit dc314aad12

View File

@ -79,6 +79,14 @@ in
description = '' description = ''
Whether to enable Samba, which provides file and print Whether to enable Samba, which provides file and print
services to Windows clients through the SMB/CIFS protocol. services to Windows clients through the SMB/CIFS protocol.
<note>
<para>If you use the firewall consider adding the following:</para>
<programlisting>
networking.firewall.allowedTCPPorts = [ 139 445 ];
networking.firewall.allowedUDPPorts = [ 137 138 ];
</programlisting>
</note>
''; '';
}; };
@ -86,7 +94,7 @@ in
type = types.package; type = types.package;
default = pkgs.samba; default = pkgs.samba;
defaultText = "pkgs.samba"; defaultText = "pkgs.samba";
example = literalExample "pkgs.samba4"; example = literalExample "pkgs.samba3";
description = '' description = ''
Defines which package should be used for the samba server. Defines which package should be used for the samba server.
''; '';
@ -118,6 +126,10 @@ in
description = '' description = ''
Additional global section and extra section lines go in here. Additional global section and extra section lines go in here.
''; '';
example = ''
guest account = nobody
map to guest = bad user
'';
}; };
configText = mkOption { configText = mkOption {
@ -154,9 +166,11 @@ in
''; '';
type = types.attrsOf (types.attrsOf types.unspecified); type = types.attrsOf (types.attrsOf types.unspecified);
example = example =
{ srv = { public =
{ path = "/srv"; { path = "/srv/public";
"read only" = true; "read only" = true;
browseable = "yes";
"guest ok" = "yes";
comment = "Public samba share."; comment = "Public samba share.";
}; };
}; };