summaryrefslogtreecommitdiff
path: root/docs/manpages-3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages-3')
-rw-r--r--docs/manpages-3/smb.conf.5.xml78
1 files changed, 78 insertions, 0 deletions
diff --git a/docs/manpages-3/smb.conf.5.xml b/docs/manpages-3/smb.conf.5.xml
index 83fff41f80..ff527c1f53 100644
--- a/docs/manpages-3/smb.conf.5.xml
+++ b/docs/manpages-3/smb.conf.5.xml
@@ -712,6 +712,84 @@ chmod 1770 /usr/local/samba/lib/usershares
</refsect1>
<refsect1>
+ <title>REGISTRY-BASED CONFIGURATION</title>
+
+ <para>
+ Starting with Samba version 3.0.26, the capability to
+ store Samba configuration in the registry is available.
+ There are two levels of registry configuration.
+ </para>
+
+ <orderedlist continuation="restarts" inheritnum="ignore" numeration="arabic">
+ <listitem><para>Share definitions stored in registry are used.
+ This is triggered by setting the global parameter
+ <parameter>registry shares</parameter> to
+ <term>yes</term> in <term>smb.conf</term>.
+ </para>
+ <para>Note: Shares defined in <term>smb.conf</term> always take priority over
+ shares of the same name defined in registry.
+ </para></listitem>
+
+ <listitem><para>Global <term>smb.conf</term> options stored in
+ registry are used. This
+ is triggered by a new special meaning of the
+ parameter <parameter>include = registry</parameter> in
+ the [global] section of <term>smb.conf</term>.
+ This reads the content of
+ the global configuration section from the regsitry
+ and includes the result with the same priorities as
+ an include of a text file. Activation of global
+ registry options automatically activates registry
+ shares.
+ </para></listitem>
+ </orderedlist>
+
+ <para>
+ Even when global registry options are used, the initial source of
+ configuration is still the <term>smb.conf</term> file.
+ It is this possible though, to produce a registry-only configuration
+ with a minimal configuration file like this:
+<programlisting>
+ <smbconfsection name="[global]"/>
+ <smbconfoption name="include">registry</smbconfoption>
+</programlisting>
+ This is also currently the only supported configuration with global
+ registry options activated. More precisely, it is only supported to
+ specify options in <term>smb.conf</term> <emph>before</emph> the
+ occurrence of <parameter>include = registry</parameter>.
+ </para>
+
+ <para>
+ Caveat: To make registry-based configurations foolprof at least to a
+ certain extent, the use of <parameter>lock directory</parameter>
+ and <parameter>include</parameter> inside the registry
+ configuration has been disabled. Especially, by changing the
+ <parameter>lock directory</parameter> inside the registry
+ configuration, one would create a broken setup where the daemons
+ do not see the configuration they loaded once it is active. This
+ phenomenon can of course also be triggered by specifying
+ <parameter>lock directory</parameter> after the
+ <parameter>include = registry</parameter> directive. This is why
+ this type of configuration is classified "unsupported" above.
+ </para>
+
+ <para>
+ The registry configuration can be accessed with
+ tools like <term>regedit</term> or <term>net rpc
+ registry</term> in the key
+ <term>HKLM\Software\Samba\smbconf</term>.
+
+ More conveniently, the <term>conf</term> subcommand of the
+ <citerefentry><refentrytitle>net</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry> utility
+ offers a dedicated interface to read and write the
+ registry based configuration locally, i.e. directly
+ on the server.
+ </para>
+
+</refsect1>
+
+<refsect1>
<title>EXPLANATION OF EACH PARAMETER</title>
<samba:parameterlist>