Generate documentation

v3.html

@@ -192,6 +192,7 @@ with the WSGI server</a></li>
 Clients</a>
 <ul>
 <li class="level4"><a href="#davx⁵" id="toc-davx⁵">DAVx⁵</a></li>
+<li class="level4"><a href="#onecalendar" id="toc-onecalendar">OneCalendar</a></li>
 <li class="level4"><a href="#gnome-calendar-contacts" id="toc-gnome-calendar-contacts">GNOME Calendar, Contacts</a></li>
 <li class="level4"><a href="#evolution" id="toc-evolution">Evolution</a></li>
 <li class="level4"><a href="#thunderbird" id="toc-thunderbird">Thunderbird</a></li>
@@ -307,7 +308,7 @@ for <a href="#basic-configuration">some basic configuration</a>.</p>
 system.</p>
 <section class="level4" id="linux--bsd">
 <h4>Linux / *BSD <a class="headerlink" href="#linux--bsd">&para;</a></h4>
-<p>First, make sure that <strong>python</strong> 3.8 or later and
+<p>First, make sure that <strong>python</strong> 3.9 or later and
 <strong>pip</strong> are installed. On most distributions it should be
 enough to install the package <code>python3-pip</code>.</p>
 <p>Then open a console and type:</p>
@@ -934,6 +935,22 @@ users.</p>
 users.</p>
 <p>Default: <code>none</code></p>
 </section>
+<section class="level5" id="cache_logins">
+<h5>cache_logins <a class="headerlink" href="#cache_logins">&para;</a></h5>
+<p>Cache successful/failed logins until expiration time. Enable this to
+avoid overload of authentication backends.</p>
+<p>Default: <code>false</code></p>
+</section>
+<section class="level5" id="cache_successful_logins_expiry">
+<h5>cache_successful_logins_expiry <a class="headerlink" href="#cache_successful_logins_expiry">&para;</a></h5>
+<p>Expiration time of caching successful logins in seconds</p>
+<p>Default: <code>15</code></p>
+</section>
+<section class="level5" id="cache_failed_logins_expiry">
+<h5>cache_failed_logins_expiry <a class="headerlink" href="#cache_failed_logins_expiry">&para;</a></h5>
+<p>Expiration time of caching failed logins in seconds</p>
+<p>Default: <code>90</code></p>
+</section>
 <section class="level5" id="htpasswd_filename">
 <h5>htpasswd_filename <a class="headerlink" href="#htpasswd_filename">&para;</a></h5>
 <p>Path to the htpasswd file.</p>
@@ -962,6 +979,11 @@ password with a salt.</p>
 entry.</p>
 <p>Default: <code>autodetect</code></p>
 </section>
+<section class="level5" id="htpasswd_cache">
+<h5>htpasswd_cache <a class="headerlink" href="#htpasswd_cache">&para;</a></h5>
+<p>Enable caching of htpasswd file based on size and mtime_ns</p>
+<p>Default: <code>False</code></p>
+</section>
 <section class="level5" id="delay">
 <h5>delay <a class="headerlink" href="#delay">&para;</a></h5>
 <p>Average delay after failed login attempts in seconds.</p>
@@ -1008,21 +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 class="level5" id="ldap_load_groups">
+<section class="level5" id="ldap_user_attribute">
-<h5>ldap_load_groups <a class="headerlink" href="#ldap_load_groups">&para;</a></h5>
+<h5>ldap_user_attribute <a class="headerlink" href="#ldap_user_attribute">&para;</a></h5>
-<p>Load the ldap groups of the authenticated user. These groups can be
+<p>The LDAP attribute whose value shall be used as the user name after
-used later on to define rights. This also gives you access to the group
+successful authentication</p>
-calendars, if they exist.</p>
+<p>Default: not set, i.e. the login name given is used directly.</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
+<li>The group calendar folders will not be created automatically. This
-must be created manually. <a href="https://github.com/Kozea/Radicale/wiki/LDAP-authentication">Here</a>
+must be done manually. In the <a href="https://github.com/Kozea/Radicale/wiki/LDAP-authentication">LDAP-authentication
-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>
+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>
@@ -1341,7 +1374,8 @@ instead of returning the results.</p>
 <h2>Supported Clients <a class="headerlink" href="#supported-clients">&para;</a></h2>
 <p>Radicale has been tested with:</p>
 <ul>
-<li><a href="https://android.com/">Android</a> with <a href="https://www.davx5.com/">DAVx⁵</a> (formerly DAVdroid)</li>
+<li><a href="https://android.com/">Android</a> with <a href="https://www.davx5.com/">DAVx⁵</a> (formerly DAVdroid),</li>
+<li><a href="https://www.onecalendar.nl/">OneCalendar</a></li>
 <li><a href="https://wiki.gnome.org/Apps/Calendar">GNOME Calendar</a>,
 <a href="https://wiki.gnome.org/Apps/Contacts">Contacts</a> and <a href="https://wiki.gnome.org/Apps/Evolution">Evolution</a></li>
 <li><a href="https://www.mozilla.org/thunderbird/">Mozilla
@@ -1368,6 +1402,15 @@ Radicale server is <a href="#ssl">accessible over HTTPS</a>.</p>
 <code>http://localhost:5232</code>) and your username. DAVx⁵ will show
 all existing calendars and address books and you can create new.</p>
 </section>
+<section class="level4" id="onecalendar">
+<h4>OneCalendar <a class="headerlink" href="#onecalendar">&para;</a></h4>
+<p>When adding account, select CalDAV account type, then enter user
+name, password and the Radicale server (e.g.
+<code>https://yourdomain:5232</code>). OneCalendar will show all
+existing calendars and (FIXME: address books), you need to select which
+ones you want to see. OneCalendar supports many other server types
+too.</p>
+</section>
 <section class="level4" id="gnome-calendar-contacts">
 <h4>GNOME Calendar, Contacts <a class="headerlink" href="#gnome-calendar-contacts">&para;</a></h4>
 <p>GNOME 46 added CalDAV and CardDAV support to <em>GNOME Online