gnu: Add documentation for wsdd.

* siguix/doc/samba.texi (documentation for wsdd).

1 files changed, 96 insertions, 0 deletions

diff --git a/siguix/doc/samba.texi b/siguix/doc/samba.texi
new file mode 100644
index 0000000..d236f1d
--- /dev/null
+++ b/siguix/doc/samba.texi
@@ -0,0 +1,96 @@
+\input texinfo
+
+@setfilename samba.info
+@documentencoding UTF-8
+@settitle Samba Service
+
+@node Samba Services
+@subsection Samba Services
+
+@cindex samba
+@cindex smb
+The @code{(gnu services samba)} module provides Guix service definitions
+for Samba as well as wsdd.  While Samba provides features such as shares
+for folder and printers, it can also be an active domain controler for
+other samba hosts in an heterougenious network with Windows computers.
+
+@c @sububheading wsdd
+
+wsdd implements a Web Service Discovery host daemon.  This daemon allows
+Samba hosts do be discovered by Web Service Discovery clients like
+Windows.  By default, SMB1 and thus the Netbios protocol has been
+disabled in Samba and Windows due to security reasons.  As such, Samba
+hosts itself will not advertise itself, nor can other hosts be
+discovererd anymore.  This is where wsdd comes into play.  wsdd can also
+be run in discovery mode to locate other WSD hosts.
+
+@deffn{Scheme Variable} wsdd-service-type Service type for the Web
+Service Discoery host daemon.  The value for this service type is a
+@code{wsdd-configuration} record.
+
+the details for the @code{wsdd-configuration} record type are given
+below.
+
+@end deffn
+
+@deffn{Data Type} wsdd-configuration
+This data type represents the configuration for the wsdd service.
+
+@table @asis
+@item @code{package} (default: @code{wsdd})
+The wsdd package to use.
+
+@item @code{ipv4only?} (default: @code{#f})
+Only listen to ipv4 addresses.
+
+
+@item @code{ipv6only} (default: @code{#f})
+Only listen to ipv6 addresses.  Please note: Activating both options
+is not possible, since there are no ip versions to listen to.
+
+@item @code{chroot} (default: @code{#f})
+Restrict service to a directory in case of vulnerabilities in wsdd.
+
+
+@item @code{hoplimit} (default: @code{1})
+Limit to the level of hops for multicast packets.
+
+@item @code{interface} (default: @code{#f})
+
+
+
+@item @code{uuid-device} (default: @code{#f})
+The WSD protocol requires a device to have a UUID.  Set this to manually
+assign the service a UUID.
+
+
+@item @code{domain} (default: @code{#f})
+Notify this host as a member of an Active Directory.
+
+
+@item @code{hostname} (default: @code{#f})
+Manually set the hostname rather than letting wsdd inherit this host's hostname.
+
+@c @item @code{no-host?} (default: @code{#f})
+@c Disable host discovery.  Set this when running wsdd in discovery mode.
+
+@item @code{preserve-case?} (default: @code{#f})
+By default wsdd will convert the hostname in workgroup to all uppercase.
+The opposite is true for hostnames in domains.  Setting this parameter
+will preserve case.
+
+@c @item @code{no-http?} (default: @code{#f})
+@c Disable responses to HTTP requests.  This is for debugging processes or
+
+@item @code{workgroup} (default: @code{"WORKGROUP"})
+Change the name of the workgroup.  By default wsdd reports this host
+being member of a workgroup.
+
+
+@end table
+@end deffn
+
+
+@c Local Variables:
+@c ispell-local-dictionary: "american";
+@c End: