diff mbox series

[bug#54561,2/4] doc: Add "Samba" chapter.

Message ID yguee2q8kxt.fsf@netpanic.org
State Accepted
Headers show
Series Add service declarations for Samba | expand

Commit Message

Simon Streit March 25, 2022, 9:01 a.m. UTC
---
 doc/guix.texi | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

Comments

fesoj000 March 27, 2022, 1:07 a.m. UTC | #1
> +@defvar{samba-service-type}
> +
> +The service type to enable the samba services @code{samba}, @code{nmbd},
> +@code{smbd} and @code{winbindd}.  By default this service type does not
> +run as an AD DC, hence @code{samba} remains disabled.  It is recommended
> +that Samba's package is added to the system profile to have the tool-set
> +available for modifications in Samba's runtime directories.
Maybe it is a good idea to provide the samba tool-set by default. You could
add the following to your samba-service-type:

(service-extension profile-service-type
                    (compose list samba-configuration-samba))

Some of the samba tools are broken though. I send a patch some time ago
which tries to address this issue. Maybe you want to take a look?
https://issues.guix.gnu.org/issue/54266
M March 27, 2022, 2:15 p.m. UTC | #2
Simon Streit schreef op vr 25-03-2022 om 10:01 [+0100]:
> +@item @code{config-file} (default: @code{#f})
> +The config file to use.  Please note: Setting this variable will disable
> +all config options that come after @code{enable-winbindd?}.

[...]

> +@item @code{enable-winbindd?} (default: @code{#f})
> +Manually enable the @code{winbindd} daemon.
> +
> +@end table
> +@end deftp

I don't see any configuration option after enable-winbindd?.  Also,
what does ‘manually enable’ mean here?  How can I determine if this
needs to be done?  Can it be done automatically instead of manually?

Greetings,
Maxime.
Simon Streit March 27, 2022, 6:51 p.m. UTC | #3
Maxime Devos <maximedevos@telenet.be> writes:

> Simon Streit schreef op vr 25-03-2022 om 10:01 [+0100]:
>> +@item @code{config-file} (default: @code{#f})
>> +The config file to use.  Please note: Setting this variable will disable
>> +all config options that come after @code{enable-winbindd?}.
>
> [...]
>
>> +@item @code{enable-winbindd?} (default: @code{#f})
>> +Manually enable the @code{winbindd} daemon.
>> +
>> +@end table
>> +@end deftp
>
> I don't see any configuration option after enable-winbindd?.  Also,
> what does ‘manually enable’ mean here?  How can I determine if this
> needs to be done?  Can it be done automatically instead of manually?

Oh, it looks like I was to quick at trimming my service definition
here.  There where config options that where removed, and had simply
removed the entries in the documentation too without rephrasing the
manual properly.  I should modify that patch then.
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index e8ef4286be..270f07d068 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -101,6 +101,7 @@  Copyright @copyright{} 2021 Andrew Tropin@*
 Copyright @copyright{} 2021 Sarah Morgensen@*
 Copyright @copyright{} 2021 Josselin Poiret@*
 Copyright @copyright{} 2022 Remco van 't Veer@*
+Copyright @copyright{} 2022 Simon Streit@*
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -368,6 +369,7 @@  Services
 * DNS Services::                DNS daemons.
 * VPN Services::                VPN daemons.
 * Network File System::         NFS related services.
+* Samba Services::              Samba services.
 * Continuous Integration::      Cuirass and Laminar services.
 * Power Management Services::   Extending battery life.
 * Audio Services::              The MPD.
@@ -29861,6 +29863,57 @@  The verbosity level of the daemon.
 @end table
 @end deftp
 
+@node Samba Services, Continuous Integration, Network File System, Services
+@subsection Samba Services
+
+@cindex samba
+@cindex smb
+The @code{(gnu services samba)} module provides Guix service definitions
+for Samba as well as additional helper services.  Currently it provides
+the following services:
+
+@subsubheading Samba
+
+Samba provides network shares for folder and printers, it can also be an
+AD DC for other samba hosts in an heterougenious network with different
+types of Computer systems.
+
+@defvar{samba-service-type}
+
+The service type to enable the samba services @code{samba}, @code{nmbd},
+@code{smbd} and @code{winbindd}.  By default this service type does not
+run as an AD DC, hence @code{samba} remains disabled.  It is recommended
+that Samba's package is added to the system profile to have the tool-set
+available for modifications in Samba's runtime directories.
+
+@end defvar
+
+@deftp{Data Type} samba-service-configuration
+Configuration record for the Samba suite.
+
+@table @asis
+@item @code{package} (default: @code{samba})
+The samba package to use.
+
+@item @code{config-file} (default: @code{#f})
+The config file to use.  Please note: Setting this variable will disable
+all config options that come after @code{enable-winbindd?}.
+
+@item @code{enable-samba?} (default: @code{#f})
+Manually enable the @code{samba} daemon.
+
+@item @code{enable-smbd?} (default: @code{#f})
+Manually enable the @code{smbd} daemon.
+
+@item @code{enable-nmbd?} (default: @code{#f})
+Manually enable the @code{nmbd} daemon.
+
+@item @code{enable-winbindd?} (default: @code{#f})
+Manually enable the @code{winbindd} daemon.
+
+@end table
+@end deftp
+
 @node Continuous Integration
 @subsection Continuous Integration