From: Michael Adam Date: Fri, 22 Jun 2007 22:44:13 +0000 (+0000) Subject: Add an initial amount of documentation of registry based X-Git-Tag: samba-3.3.0pre1~1616 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=2195dc476f4946ff062b62cf29d1b330263507bc;p=thirdparty%2Fsamba.git Add an initial amount of documentation of registry based configuration to smb.conf(5). This explains registry shares and registry global options and mentions "net conf". This will be in 3.0.26, but Jerry told me to commit this anyways. The plan is to branch the doc for 3.0.25b from r1126 (say). I could not check the result since I could not get the manpages built correctly on any system I tried. So the output needs to be checked - sorry, I will fix my environment later... Michael --- diff --git a/docs/manpages-3/smb.conf.5.xml b/docs/manpages-3/smb.conf.5.xml index 83fff41f809..ff527c1f53c 100644 --- a/docs/manpages-3/smb.conf.5.xml +++ b/docs/manpages-3/smb.conf.5.xml @@ -711,6 +711,84 @@ chmod 1770 /usr/local/samba/lib/usershares + + REGISTRY-BASED CONFIGURATION + + + 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. + + + + Share definitions stored in registry are used. + This is triggered by setting the global parameter + registry shares to + yes in smb.conf. + + Note: Shares defined in smb.conf always take priority over + shares of the same name defined in registry. + + + Global smb.conf options stored in + registry are used. This + is triggered by a new special meaning of the + parameter include = registry in + the [global] section of smb.conf. + 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. + + + + + Even when global registry options are used, the initial source of + configuration is still the smb.conf file. + It is this possible though, to produce a registry-only configuration + with a minimal configuration file like this: + + + registry + + This is also currently the only supported configuration with global + registry options activated. More precisely, it is only supported to + specify options in smb.conf before the + occurrence of include = registry. + + + + Caveat: To make registry-based configurations foolprof at least to a + certain extent, the use of lock directory + and include inside the registry + configuration has been disabled. Especially, by changing the + lock directory 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 + lock directory after the + include = registry directive. This is why + this type of configuration is classified "unsupported" above. + + + + The registry configuration can be accessed with + tools like regedit or net rpc + registry in the key + HKLM\Software\Samba\smbconf. + + More conveniently, the conf subcommand of the + net + 7 utility + offers a dedicated interface to read and write the + registry based configuration locally, i.e. directly + on the server. + + + + EXPLANATION OF EACH PARAMETER diff --git a/docs/smbdotconf/misc/include.xml b/docs/smbdotconf/misc/include.xml index 17ccea33c02..84e20dff89a 100644 --- a/docs/smbdotconf/misc/include.xml +++ b/docs/smbdotconf/misc/include.xml @@ -1,6 +1,6 @@ @@ -13,6 +13,16 @@ It takes the standard substitutions, except %u, %P and %S. + + + The parameter include = registry has + a special meaning: It does not include + a file named registry from the current working + directory, but instead reads the global configuration options + from the registry. See the section on registry-based + configuration for details. Note that this option + automatically activates registry shares. + diff --git a/docs/smbdotconf/misc/registryshares.xml b/docs/smbdotconf/misc/registryshares.xml new file mode 100644 index 00000000000..5557661998b --- /dev/null +++ b/docs/smbdotconf/misc/registryshares.xml @@ -0,0 +1,16 @@ + + + + This turns on or off support for share definitions read from + registry. Shares in defined in smb.conf take + precedence over shares with the same name defined in + registry. See the section on registry-based configuration + for details. + + +/usr/local/samba/lib/smb.conf.%m +