1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-08-01 18:18:31 +00:00

Generate documentation

This commit is contained in:
Github Actions 2025-01-04 07:34:10 +00:00
parent 21ec383a3b
commit 991e518299

View file

@ -176,7 +176,6 @@ with the WSGI server</a></li>
<li class="level4"><a href="#server" id="toc-server">server</a></li>
<li class="level4"><a href="#encoding" id="toc-encoding">encoding</a></li>
<li class="level4"><a href="#auth" id="toc-auth">auth</a></li>
<li class="level4"><a href="#ldap_user_attribute" id="toc-ldap_user_attribute">ldap_user_attribute</a></li>
<li class="level4"><a href="#rights" id="toc-rights">rights</a></li>
<li class="level4"><a href="#storage-1" id="toc-storage-1">storage</a></li>
<li class="level4"><a href="#web" id="toc-web">web</a></li>
@ -1031,27 +1030,32 @@ auth type is ldap.</p>
username. User '{0}' as placeholder for the user name.</p>
<p>Default: <code>(cn={0})</code></p>
</section>
</section>
<section class="level4" id="ldap_user_attribute">
<h4>ldap_user_attribute <a class="headerlink" href="#ldap_user_attribute">&para;</a></h4>
<section class="level5" id="ldap_user_attribute">
<h5>ldap_user_attribute <a class="headerlink" href="#ldap_user_attribute">&para;</a></h5>
<p>The LDAP attribute whose value shall be used as the user name after
successful authentication</p>
<p>Default: not set, i.e. the login name given is used directly.</p>
<section class="level5" id="ldap_load_groups">
<h5>ldap_load_groups <a class="headerlink" href="#ldap_load_groups">&para;</a></h5>
<p>Load the ldap groups of the authenticated user. These groups can be
used later on to define rights. This also gives you access to the group
calendars, if they exist.</p>
</section>
<section class="level5" id="ldap_groups_attribute">
<h5>ldap_groups_attribute <a class="headerlink" href="#ldap_groups_attribute">&para;</a></h5>
<p>The LDAP attribute to read the group memberships from in the
authenticated user's LDAP entry.</p>
<p>If set, load the LDAP group memberships from the attribute given
These memberships can be used later on to define rights. This also gives
you access to the group calendars, if they exist.</p>
<ul>
<li>The group calendar will be placed under
collection_root_folder/GROUPS</li>
<li>The name of the calendar directory is the base64 encoded group
name.</li>
<li>The group calendar folders will not be created automaticaly. This
must be created manually. <a href="https://github.com/Kozea/Radicale/wiki/LDAP-authentication">Here</a>
you can find a script to create group calendar folders <a href="https://github.com/Kozea/Radicale/wiki/LDAP-authentication">https://github.com/Kozea/Radicale/wiki/LDAP-authentication</a></li>
<li>The group calendar folders will not be created automatically. This
must be done manually. In the <a href="https://github.com/Kozea/Radicale/wiki/LDAP-authentication">LDAP-authentication
section of Radicale's wiki</a> you can find a script to create a group
calendar.</li>
</ul>
<p>Default: False</p>
<p>Use 'memberOf' if you want to load groups on Active Directory and
alikes, 'groupMembership' on Novell eDirectory, ...</p>
<p>Default: unset</p>
</section>
<section class="level5" id="ldap_use_ssl">
<h5>ldap_use_ssl <a class="headerlink" href="#ldap_use_ssl">&para;</a></h5>