diff options
author | Simon Streit <simon@netpanic.org> | 2022-01-19 14:02:49 +0100 |
---|---|---|
committer | Simon Streit <simon@netpanic.org> | 2022-01-19 14:02:49 +0100 |
commit | e730619840ef43bef96228ed282942535c448a63 (patch) | |
tree | dc5a1ddc6e9ef41d3c4326883992ef0a8f6b858d | |
parent | 39eb4934024545e4fe9ae124b2d08bd1c5646482 (diff) |
Finish documentation for wsdd.wip-wsdd
modified: siguix/doc/samba.texi
modified: siguix/services/wsdd.scm
-rw-r--r-- | siguix/doc/samba.texi | 75 | ||||
-rw-r--r-- | siguix/services/wsdd.scm | 2 |
2 files changed, 34 insertions, 43 deletions
diff --git a/siguix/doc/samba.texi b/siguix/doc/samba.texi index d236f1d..f6707ad 100644 --- a/siguix/doc/samba.texi +++ b/siguix/doc/samba.texi @@ -14,81 +14,72 @@ 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 +@cindex wsdd +@subsubheading Web Service Discovery Daemon -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. +Web Service Discovery Daemon implements the WSD protocoll. It is a +drop-in replacement for host discovery that lack support for the SMBv1 +protocoll. -@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. +@defvr{Scheme Variable} wsdd-service-type -the details for the @code{wsdd-configuration} record type are given -below. +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 defvr -@end deffn - -@deffn{Data Type} wsdd-configuration +@deftp{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. +Only listen to ipv6 addresses. Please note: Activating both options is +not possible, since there would be no ip versions to listen to. @item @code{chroot} (default: @code{#f}) -Restrict service to a directory in case of vulnerabilities in wsdd. - +Chroot into a sperate directory to prevent access to other directories. +This is to increase security in case there is a vulnerability in +@command{wsdd}. @item @code{hoplimit} (default: @code{1}) -Limit to the level of hops for multicast packets. - -@item @code{interface} (default: @code{#f}) - +Limit to the level of hops for multicast packets. The default is +@var{1} which should prevent packets from leaving the local network. +@item @code{interface} (default: @code{'()}) +Limit to the given list of interfaces to listen to. By default wsdd +will listen to all interfaces. Except the loopback interface is never +used. @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. - +Notify this host is 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. +Manually set the hostname rather than letting @command{wsdd} inherit +this host's hostname. @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 +By default @command{wsdd} will convert the hostname in workgroup to all +uppercase. The opposite is true for hostnames in domains. Setting this +parameter will preserve case. -@item @code{workgroup} (default: @code{"WORKGROUP"}) -Change the name of the workgroup. By default wsdd reports this host -being member of a workgroup. +@item @code{workgroup} (default: @var{"WORKGROUP"}) +Change the name of the workgroup. By default @command{wsdd} reports +this host being member of a workgroup. @end table -@end deffn +@end deftp @c Local Variables: diff --git a/siguix/services/wsdd.scm b/siguix/services/wsdd.scm index ef0c08e..00a69d8 100644 --- a/siguix/services/wsdd.scm +++ b/siguix/services/wsdd.scm @@ -75,7 +75,7 @@ (hoplimit wsdd-configuration-hoplimit (default 1)) (interface wsdd-configuration-interface - (default #f)) + (default '())) (uuid-device wsdd-configuration-uuid-device (default #f)) (domain wsdd-configuration-domain |