oss/Radicale
oss/Radicale
1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-09-15 20:36:55 +00:00
Code Wiki Activity

Generate documentation

Browse source
This commit is contained in:
Github Actions 2025-09-09 17:49:00 +00:00
parent fec1f1c3f1
commit c40add18e2
1 changed files with 102 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

191
master.html
View file

@ -1280,6 +1280,19 @@ access to the socket.</p>
<p>Port of via network exposed dovecot socket</p> <p>Port of via network exposed dovecot socket</p>
<p>Default: <code>12345</code></p> <p>Default: <code>12345</code></p>
</section> </section>
<section class="level5" id="dovecot_rip_x_remote_addr">
<h5>dovecot_rip_x_remote_addr <a class="headerlink" href="#dovecot_rip_x_remote_addr">&para;</a></h5>
<p><em>(&gt;= 3.5.6)</em></p>
<p>Use the <code>X-Remote-Addr</code> value for the remote IP (rip)
parameter in the dovecot authentication protocol.</p>
<p>If set, Radicale must be running behind a proxy that you control and
that sets/overwrites the <code>X-Remote-Addr</code> header (doesn't pass
it) so that the value passed to dovecot is reliable. For example, for
nginx, add</p>
<pre><code> proxy_set_header X-Remote-Addr $remote_addr;</code></pre>
<p>to the configuration sample.</p>
<p>Default: <code>False</code></p>
</section>
<section class="level5" id="imap_host"> <section class="level5" id="imap_host">
<h5>imap_host <a class="headerlink" href="#imap_host">&para;</a></h5> <h5>imap_host <a class="headerlink" href="#imap_host">&para;</a></h5>
<p><em>(&gt;= 3.4.1)</em></p> <p><em>(&gt;= 3.4.1)</em></p>
@ -1614,7 +1627,7 @@ books and calendars.</p>
<p>In this section additional HTTP headers that are sent to clients can <p>In this section additional HTTP headers that are sent to clients can
be specified.</p> be specified.</p>
<p>An example to relax the same-origin policy:</p> <p>An example to relax the same-origin policy:</p>
<div class="sourceCode" id="cb43"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb43-1"><a aria-hidden="true" href="#cb43-1" tabindex="-1"></a><span class="dt">Access-Control-Allow-Origin </span><span class="ot">=</span><span class="st"> *</span></span></code></pre></div> <div class="sourceCode" id="cb44"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb44-1"><a aria-hidden="true" href="#cb44-1" tabindex="-1"></a><span class="dt">Access-Control-Allow-Origin </span><span class="ot">=</span><span class="st"> *</span></span></code></pre></div>
</section> </section>
<section class="level4" id="hook-1"> <section class="level4" id="hook-1">
<h4>hook <a class="headerlink" href="#hook-1">&para;</a></h4> <h4>hook <a class="headerlink" href="#hook-1">&para;</a></h4>
@ -1924,47 +1937,47 @@ InfCloud</a>.</p>
calendars and address books. Use Radicale's web interface or a client calendars and address books. Use Radicale's web interface or a client
with support for it (e.g. <strong>DAVx⁵</strong>).</p> with support for it (e.g. <strong>DAVx⁵</strong>).</p>
<p>To create a new calendar run something like:</p> <p>To create a new calendar run something like:</p>
<div class="sourceCode" id="cb47"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb47-1"><a aria-hidden="true" href="#cb47-1" tabindex="-1"></a><span class="ex">$</span> curl <span class="at">-u</span> user <span class="at">-X</span> MKCOL <span class="st">'http://localhost:5232/user/calendar'</span> <span class="at">--data</span> <span class="dt">\</span></span> <div class="sourceCode" id="cb48"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb48-1"><a aria-hidden="true" href="#cb48-1" tabindex="-1"></a><span class="ex">$</span> curl <span class="at">-u</span> user <span class="at">-X</span> MKCOL <span class="st">'http://localhost:5232/user/calendar'</span> <span class="at">--data</span> <span class="dt">\</span></span>
<span id="cb47-2"><a aria-hidden="true" href="#cb47-2" tabindex="-1"></a><span class="st">'&lt;?xml version="1.0" encoding="UTF-8" ?&gt;</span></span>
<span id="cb47-3"><a aria-hidden="true" href="#cb47-3" tabindex="-1"></a><span class="st">&lt;create xmlns="DAV:" xmlns:C="urn:ietf:params:xml:ns:caldav" xmlns:I="http://apple.com/ns/ical/"&gt;</span></span>
<span id="cb47-4"><a aria-hidden="true" href="#cb47-4" tabindex="-1"></a><span class="st"> &lt;set&gt;</span></span>
<span id="cb47-5"><a aria-hidden="true" href="#cb47-5" tabindex="-1"></a><span class="st"> &lt;prop&gt;</span></span>
<span id="cb47-6"><a aria-hidden="true" href="#cb47-6" tabindex="-1"></a><span class="st"> &lt;resourcetype&gt;</span></span>
<span id="cb47-7"><a aria-hidden="true" href="#cb47-7" tabindex="-1"></a><span class="st"> &lt;collection /&gt;</span></span>
<span id="cb47-8"><a aria-hidden="true" href="#cb47-8" tabindex="-1"></a><span class="st"> &lt;C:calendar /&gt;</span></span>
<span id="cb47-9"><a aria-hidden="true" href="#cb47-9" tabindex="-1"></a><span class="st"> &lt;/resourcetype&gt;</span></span>
<span id="cb47-10"><a aria-hidden="true" href="#cb47-10" tabindex="-1"></a><span class="st"> &lt;C:supported-calendar-component-set&gt;</span></span>
<span id="cb47-11"><a aria-hidden="true" href="#cb47-11" tabindex="-1"></a><span class="st"> &lt;C:comp name="VEVENT" /&gt;</span></span>
<span id="cb47-12"><a aria-hidden="true" href="#cb47-12" tabindex="-1"></a><span class="st"> &lt;C:comp name="VJOURNAL" /&gt;</span></span>
<span id="cb47-13"><a aria-hidden="true" href="#cb47-13" tabindex="-1"></a><span class="st"> &lt;C:comp name="VTODO" /&gt;</span></span>
<span id="cb47-14"><a aria-hidden="true" href="#cb47-14" tabindex="-1"></a><span class="st"> &lt;/C:supported-calendar-component-set&gt;</span></span>
<span id="cb47-15"><a aria-hidden="true" href="#cb47-15" tabindex="-1"></a><span class="st"> &lt;displayname&gt;Calendar&lt;/displayname&gt;</span></span>
<span id="cb47-16"><a aria-hidden="true" href="#cb47-16" tabindex="-1"></a><span class="st"> &lt;C:calendar-description&gt;Example calendar&lt;/C:calendar-description&gt;</span></span>
<span id="cb47-17"><a aria-hidden="true" href="#cb47-17" tabindex="-1"></a><span class="st"> &lt;I:calendar-color&gt;#ff0000ff&lt;/I:calendar-color&gt;</span></span>
<span id="cb47-18"><a aria-hidden="true" href="#cb47-18" tabindex="-1"></a><span class="st"> &lt;/prop&gt;</span></span>
<span id="cb47-19"><a aria-hidden="true" href="#cb47-19" tabindex="-1"></a><span class="st"> &lt;/set&gt;</span></span>
<span id="cb47-20"><a aria-hidden="true" href="#cb47-20" tabindex="-1"></a><span class="st">&lt;/create&gt;'</span></span></code></pre></div>
<p>To create a new address book run something like:</p>
<div class="sourceCode" id="cb48"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb48-1"><a aria-hidden="true" href="#cb48-1" tabindex="-1"></a><span class="ex">$</span> curl <span class="at">-u</span> user <span class="at">-X</span> MKCOL <span class="st">'http://localhost:5232/user/addressbook'</span> <span class="at">--data</span> <span class="dt">\</span></span>
<span id="cb48-2"><a aria-hidden="true" href="#cb48-2" tabindex="-1"></a><span class="st">'&lt;?xml version="1.0" encoding="UTF-8" ?&gt;</span></span> <span id="cb48-2"><a aria-hidden="true" href="#cb48-2" tabindex="-1"></a><span class="st">'&lt;?xml version="1.0" encoding="UTF-8" ?&gt;</span></span>
<span id="cb48-3"><a aria-hidden="true" href="#cb48-3" tabindex="-1"></a><span class="st">&lt;create xmlns="DAV:" xmlns:CR="urn:ietf:params:xml:ns:carddav"&gt;</span></span> <span id="cb48-3"><a aria-hidden="true" href="#cb48-3" tabindex="-1"></a><span class="st">&lt;create xmlns="DAV:" xmlns:C="urn:ietf:params:xml:ns:caldav" xmlns:I="http://apple.com/ns/ical/"&gt;</span></span>
<span id="cb48-4"><a aria-hidden="true" href="#cb48-4" tabindex="-1"></a><span class="st"> &lt;set&gt;</span></span> <span id="cb48-4"><a aria-hidden="true" href="#cb48-4" tabindex="-1"></a><span class="st"> &lt;set&gt;</span></span>
<span id="cb48-5"><a aria-hidden="true" href="#cb48-5" tabindex="-1"></a><span class="st"> &lt;prop&gt;</span></span> <span id="cb48-5"><a aria-hidden="true" href="#cb48-5" tabindex="-1"></a><span class="st"> &lt;prop&gt;</span></span>
<span id="cb48-6"><a aria-hidden="true" href="#cb48-6" tabindex="-1"></a><span class="st"> &lt;resourcetype&gt;</span></span> <span id="cb48-6"><a aria-hidden="true" href="#cb48-6" tabindex="-1"></a><span class="st"> &lt;resourcetype&gt;</span></span>
<span id="cb48-7"><a aria-hidden="true" href="#cb48-7" tabindex="-1"></a><span class="st"> &lt;collection /&gt;</span></span> <span id="cb48-7"><a aria-hidden="true" href="#cb48-7" tabindex="-1"></a><span class="st"> &lt;collection /&gt;</span></span>
<span id="cb48-8"><a aria-hidden="true" href="#cb48-8" tabindex="-1"></a><span class="st"> &lt;CR:addressbook /&gt;</span></span> <span id="cb48-8"><a aria-hidden="true" href="#cb48-8" tabindex="-1"></a><span class="st"> &lt;C:calendar /&gt;</span></span>
<span id="cb48-9"><a aria-hidden="true" href="#cb48-9" tabindex="-1"></a><span class="st"> &lt;/resourcetype&gt;</span></span> <span id="cb48-9"><a aria-hidden="true" href="#cb48-9" tabindex="-1"></a><span class="st"> &lt;/resourcetype&gt;</span></span>
<span id="cb48-10"><a aria-hidden="true" href="#cb48-10" tabindex="-1"></a><span class="st"> &lt;displayname&gt;Address book&lt;/displayname&gt;</span></span> <span id="cb48-10"><a aria-hidden="true" href="#cb48-10" tabindex="-1"></a><span class="st"> &lt;C:supported-calendar-component-set&gt;</span></span>
<span id="cb48-11"><a aria-hidden="true" href="#cb48-11" tabindex="-1"></a><span class="st"> &lt;CR:addressbook-description&gt;Example address book&lt;/CR:addressbook-description&gt;</span></span> <span id="cb48-11"><a aria-hidden="true" href="#cb48-11" tabindex="-1"></a><span class="st"> &lt;C:comp name="VEVENT" /&gt;</span></span>
<span id="cb48-12"><a aria-hidden="true" href="#cb48-12" tabindex="-1"></a><span class="st"> &lt;/prop&gt;</span></span> <span id="cb48-12"><a aria-hidden="true" href="#cb48-12" tabindex="-1"></a><span class="st"> &lt;C:comp name="VJOURNAL" /&gt;</span></span>
<span id="cb48-13"><a aria-hidden="true" href="#cb48-13" tabindex="-1"></a><span class="st"> &lt;/set&gt;</span></span> <span id="cb48-13"><a aria-hidden="true" href="#cb48-13" tabindex="-1"></a><span class="st"> &lt;C:comp name="VTODO" /&gt;</span></span>
<span id="cb48-14"><a aria-hidden="true" href="#cb48-14" tabindex="-1"></a><span class="st">&lt;/create&gt;'</span></span></code></pre></div> <span id="cb48-14"><a aria-hidden="true" href="#cb48-14" tabindex="-1"></a><span class="st"> &lt;/C:supported-calendar-component-set&gt;</span></span>
<span id="cb48-15"><a aria-hidden="true" href="#cb48-15" tabindex="-1"></a><span class="st"> &lt;displayname&gt;Calendar&lt;/displayname&gt;</span></span>
<span id="cb48-16"><a aria-hidden="true" href="#cb48-16" tabindex="-1"></a><span class="st"> &lt;C:calendar-description&gt;Example calendar&lt;/C:calendar-description&gt;</span></span>
<span id="cb48-17"><a aria-hidden="true" href="#cb48-17" tabindex="-1"></a><span class="st"> &lt;I:calendar-color&gt;#ff0000ff&lt;/I:calendar-color&gt;</span></span>
<span id="cb48-18"><a aria-hidden="true" href="#cb48-18" tabindex="-1"></a><span class="st"> &lt;/prop&gt;</span></span>
<span id="cb48-19"><a aria-hidden="true" href="#cb48-19" tabindex="-1"></a><span class="st"> &lt;/set&gt;</span></span>
<span id="cb48-20"><a aria-hidden="true" href="#cb48-20" tabindex="-1"></a><span class="st">&lt;/create&gt;'</span></span></code></pre></div>
<p>To create a new address book run something like:</p>
<div class="sourceCode" id="cb49"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb49-1"><a aria-hidden="true" href="#cb49-1" tabindex="-1"></a><span class="ex">$</span> curl <span class="at">-u</span> user <span class="at">-X</span> MKCOL <span class="st">'http://localhost:5232/user/addressbook'</span> <span class="at">--data</span> <span class="dt">\</span></span>
<span id="cb49-2"><a aria-hidden="true" href="#cb49-2" tabindex="-1"></a><span class="st">'&lt;?xml version="1.0" encoding="UTF-8" ?&gt;</span></span>
<span id="cb49-3"><a aria-hidden="true" href="#cb49-3" tabindex="-1"></a><span class="st">&lt;create xmlns="DAV:" xmlns:CR="urn:ietf:params:xml:ns:carddav"&gt;</span></span>
<span id="cb49-4"><a aria-hidden="true" href="#cb49-4" tabindex="-1"></a><span class="st"> &lt;set&gt;</span></span>
<span id="cb49-5"><a aria-hidden="true" href="#cb49-5" tabindex="-1"></a><span class="st"> &lt;prop&gt;</span></span>
<span id="cb49-6"><a aria-hidden="true" href="#cb49-6" tabindex="-1"></a><span class="st"> &lt;resourcetype&gt;</span></span>
<span id="cb49-7"><a aria-hidden="true" href="#cb49-7" tabindex="-1"></a><span class="st"> &lt;collection /&gt;</span></span>
<span id="cb49-8"><a aria-hidden="true" href="#cb49-8" tabindex="-1"></a><span class="st"> &lt;CR:addressbook /&gt;</span></span>
<span id="cb49-9"><a aria-hidden="true" href="#cb49-9" tabindex="-1"></a><span class="st"> &lt;/resourcetype&gt;</span></span>
<span id="cb49-10"><a aria-hidden="true" href="#cb49-10" tabindex="-1"></a><span class="st"> &lt;displayname&gt;Address book&lt;/displayname&gt;</span></span>
<span id="cb49-11"><a aria-hidden="true" href="#cb49-11" tabindex="-1"></a><span class="st"> &lt;CR:addressbook-description&gt;Example address book&lt;/CR:addressbook-description&gt;</span></span>
<span id="cb49-12"><a aria-hidden="true" href="#cb49-12" tabindex="-1"></a><span class="st"> &lt;/prop&gt;</span></span>
<span id="cb49-13"><a aria-hidden="true" href="#cb49-13" tabindex="-1"></a><span class="st"> &lt;/set&gt;</span></span>
<span id="cb49-14"><a aria-hidden="true" href="#cb49-14" tabindex="-1"></a><span class="st">&lt;/create&gt;'</span></span></code></pre></div>
<p>The collection <code>/USERNAME</code> will be created automatically, <p>The collection <code>/USERNAME</code> will be created automatically,
when the user authenticates to Radicale for the first time. Clients with when the user authenticates to Radicale for the first time. Clients with
automatic discovery of collections will only show calendars and address automatic discovery of collections will only show calendars and address
books that are direct children of the path <code>/USERNAME/</code>.</p> books that are direct children of the path <code>/USERNAME/</code>.</p>
<p>Delete the collections by running something like:</p> <p>Delete the collections by running something like:</p>
<div class="sourceCode" id="cb49"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb49-1"><a aria-hidden="true" href="#cb49-1" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-u</span> user <span class="at">-X</span> DELETE <span class="st">'http://localhost:5232/user/calendar'</span></span></code></pre></div> <div class="sourceCode" id="cb50"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb50-1"><a aria-hidden="true" href="#cb50-1" tabindex="-1"></a><span class="ex">curl</span> <span class="at">-u</span> user <span class="at">-X</span> DELETE <span class="st">'http://localhost:5232/user/calendar'</span></span></code></pre></div>
<p>Note: requires config/option <p>Note: requires config/option
<code>permit_delete_collection = True</code></p> <code>permit_delete_collection = True</code></p>
</section> </section>
@ -1980,24 +1993,24 @@ to calendars and address books outside the home directory of users
collections and will not show them to the user. This is only useful if collections and will not show them to the user. This is only useful if
you access calendars and address books directly via URL.</p> you access calendars and address books directly via URL.</p>
<p>An example rights file:</p> <p>An example rights file:</p>
<div class="sourceCode" id="cb50"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb50-1"><a aria-hidden="true" href="#cb50-1" tabindex="-1"></a><span class="co"># Allow reading root collection for authenticated users</span></span> <div class="sourceCode" id="cb51"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb51-1"><a aria-hidden="true" href="#cb51-1" tabindex="-1"></a><span class="co"># Allow reading root collection for authenticated users</span></span>
<span id="cb50-2"><a aria-hidden="true" href="#cb50-2" tabindex="-1"></a><span class="kw">[root]</span></span> <span id="cb51-2"><a aria-hidden="true" href="#cb51-2" tabindex="-1"></a><span class="kw">[root]</span></span>
<span id="cb50-3"><a aria-hidden="true" href="#cb50-3" tabindex="-1"></a><span class="dt">user: .+</span></span> <span id="cb51-3"><a aria-hidden="true" href="#cb51-3" tabindex="-1"></a><span class="dt">user: .+</span></span>
<span id="cb50-4"><a aria-hidden="true" href="#cb50-4" tabindex="-1"></a><span class="dt">collection:</span></span> <span id="cb51-4"><a aria-hidden="true" href="#cb51-4" tabindex="-1"></a><span class="dt">collection:</span></span>
<span id="cb50-5"><a aria-hidden="true" href="#cb50-5" tabindex="-1"></a><span class="dt">permissions: R</span></span> <span id="cb51-5"><a aria-hidden="true" href="#cb51-5" tabindex="-1"></a><span class="dt">permissions: R</span></span>
<span id="cb50-6"><a aria-hidden="true" href="#cb50-6" tabindex="-1"></a></span> <span id="cb51-6"><a aria-hidden="true" href="#cb51-6" tabindex="-1"></a></span>
<span id="cb50-7"><a aria-hidden="true" href="#cb50-7" tabindex="-1"></a><span class="co"># Allow reading and writing principal collection (same as username)</span></span> <span id="cb51-7"><a aria-hidden="true" href="#cb51-7" tabindex="-1"></a><span class="co"># Allow reading and writing principal collection (same as username)</span></span>
<span id="cb50-8"><a aria-hidden="true" href="#cb50-8" tabindex="-1"></a><span class="kw">[principal]</span></span> <span id="cb51-8"><a aria-hidden="true" href="#cb51-8" tabindex="-1"></a><span class="kw">[principal]</span></span>
<span id="cb50-9"><a aria-hidden="true" href="#cb50-9" tabindex="-1"></a><span class="dt">user: .+</span></span> <span id="cb51-9"><a aria-hidden="true" href="#cb51-9" tabindex="-1"></a><span class="dt">user: .+</span></span>
<span id="cb50-10"><a aria-hidden="true" href="#cb50-10" tabindex="-1"></a><span class="dt">collection: {user}</span></span> <span id="cb51-10"><a aria-hidden="true" href="#cb51-10" tabindex="-1"></a><span class="dt">collection: {user}</span></span>
<span id="cb50-11"><a aria-hidden="true" href="#cb50-11" tabindex="-1"></a><span class="dt">permissions: RW</span></span> <span id="cb51-11"><a aria-hidden="true" href="#cb51-11" tabindex="-1"></a><span class="dt">permissions: RW</span></span>
<span id="cb50-12"><a aria-hidden="true" href="#cb50-12" tabindex="-1"></a></span> <span id="cb51-12"><a aria-hidden="true" href="#cb51-12" tabindex="-1"></a></span>
<span id="cb50-13"><a aria-hidden="true" href="#cb50-13" tabindex="-1"></a><span class="co"># Allow reading and writing calendars and address books that are direct</span></span> <span id="cb51-13"><a aria-hidden="true" href="#cb51-13" tabindex="-1"></a><span class="co"># Allow reading and writing calendars and address books that are direct</span></span>
<span id="cb50-14"><a aria-hidden="true" href="#cb50-14" tabindex="-1"></a><span class="co"># children of the principal collection</span></span> <span id="cb51-14"><a aria-hidden="true" href="#cb51-14" tabindex="-1"></a><span class="co"># children of the principal collection</span></span>
<span id="cb50-15"><a aria-hidden="true" href="#cb50-15" tabindex="-1"></a><span class="kw">[calendars]</span></span> <span id="cb51-15"><a aria-hidden="true" href="#cb51-15" tabindex="-1"></a><span class="kw">[calendars]</span></span>
<span id="cb50-16"><a aria-hidden="true" href="#cb50-16" tabindex="-1"></a><span class="dt">user: .+</span></span> <span id="cb51-16"><a aria-hidden="true" href="#cb51-16" tabindex="-1"></a><span class="dt">user: .+</span></span>
<span id="cb50-17"><a aria-hidden="true" href="#cb50-17" tabindex="-1"></a><span class="dt">collection: {user}/</span><span class="kw">[^/]</span><span class="dt">+</span></span> <span id="cb51-17"><a aria-hidden="true" href="#cb51-17" tabindex="-1"></a><span class="dt">collection: {user}/</span><span class="kw">[^/]</span><span class="dt">+</span></span>
<span id="cb50-18"><a aria-hidden="true" href="#cb50-18" tabindex="-1"></a><span class="dt">permissions: rw</span></span></code></pre></div> <span id="cb51-18"><a aria-hidden="true" href="#cb51-18" tabindex="-1"></a><span class="dt">permissions: rw</span></span></code></pre></div>
<p>The titles of the sections are ignored (but must be unique). The keys <p>The titles of the sections are ignored (but must be unique). The keys
<code>user</code> and <code>collection</code> contain regular <code>user</code> and <code>collection</code> contain regular
expressions, that are matched against the username and the path of the expressions, that are matched against the username and the path of the
@ -2084,10 +2097,10 @@ system. The storage is locked with exclusive access while the
<h5>Linux shell scripts <a class="headerlink" href="#linux-shell-scripts">&para;</a></h5> <h5>Linux shell scripts <a class="headerlink" href="#linux-shell-scripts">&para;</a></h5>
<p>Use the <a href="https://manpages.debian.org/unstable/util-linux/flock.1.en.html">flock</a> <p>Use the <a href="https://manpages.debian.org/unstable/util-linux/flock.1.en.html">flock</a>
utility.</p> utility.</p>
<div class="sourceCode" id="cb51"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb51-1"><a aria-hidden="true" href="#cb51-1" tabindex="-1"></a><span class="co"># Exclusive</span></span> <div class="sourceCode" id="cb52"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb52-1"><a aria-hidden="true" href="#cb52-1" tabindex="-1"></a><span class="co"># Exclusive</span></span>
<span id="cb51-2"><a aria-hidden="true" href="#cb51-2" tabindex="-1"></a><span class="ex">$</span> flock <span class="at">--exclusive</span> /path/to/storage/.Radicale.lock COMMAND</span> <span id="cb52-2"><a aria-hidden="true" href="#cb52-2" tabindex="-1"></a><span class="ex">$</span> flock <span class="at">--exclusive</span> /path/to/storage/.Radicale.lock COMMAND</span>
<span id="cb51-3"><a aria-hidden="true" href="#cb51-3" tabindex="-1"></a><span class="co"># Shared</span></span> <span id="cb52-3"><a aria-hidden="true" href="#cb52-3" tabindex="-1"></a><span class="co"># Shared</span></span>
<span id="cb51-4"><a aria-hidden="true" href="#cb51-4" tabindex="-1"></a><span class="ex">$</span> flock <span class="at">--shared</span> /path/to/storage/.Radicale.lock COMMAND</span></code></pre></div> <span id="cb52-4"><a aria-hidden="true" href="#cb52-4" tabindex="-1"></a><span class="ex">$</span> flock <span class="at">--shared</span> /path/to/storage/.Radicale.lock COMMAND</span></code></pre></div>
</section> </section>
<section class="level5" id="linux-and-macos"> <section class="level5" id="linux-and-macos">
<h5>Linux and MacOS <a class="headerlink" href="#linux-and-macos">&para;</a></h5> <h5>Linux and MacOS <a class="headerlink" href="#linux-and-macos">&para;</a></h5>
@ -2112,11 +2125,11 @@ folder in the file system storage (e.g.
clients that the collection is a calendar, you have to create the file clients that the collection is a calendar, you have to create the file
<code>.Radicale.props</code> with the following content in the <code>.Radicale.props</code> with the following content in the
folder:</p> folder:</p>
<div class="sourceCode" id="cb52"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb52-1"><a aria-hidden="true" href="#cb52-1" tabindex="-1"></a><span class="fu">{</span><span class="dt">"tag"</span><span class="fu">:</span> <span class="st">"VCALENDAR"</span><span class="fu">}</span></span></code></pre></div> <div class="sourceCode" id="cb53"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb53-1"><a aria-hidden="true" href="#cb53-1" tabindex="-1"></a><span class="fu">{</span><span class="dt">"tag"</span><span class="fu">:</span> <span class="st">"VCALENDAR"</span><span class="fu">}</span></span></code></pre></div>
<p>The calendar is now available at the URL path <p>The calendar is now available at the URL path
<code>/user/calendar</code>. For address books the file must <code>/user/calendar</code>. For address books the file must
contain:</p> contain:</p>
<div class="sourceCode" id="cb53"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb53-1"><a aria-hidden="true" href="#cb53-1" tabindex="-1"></a><span class="fu">{</span><span class="dt">"tag"</span><span class="fu">:</span> <span class="st">"VADDRESSBOOK"</span><span class="fu">}</span></span></code></pre></div> <div class="sourceCode" id="cb54"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb54-1"><a aria-hidden="true" href="#cb54-1" tabindex="-1"></a><span class="fu">{</span><span class="dt">"tag"</span><span class="fu">:</span> <span class="st">"VADDRESSBOOK"</span><span class="fu">}</span></span></code></pre></div>
<p>Calendar and address book collections must not have any child <p>Calendar and address book collections must not have any child
collections. Clients with automatic discovery of collections will only collections. Clients with automatic discovery of collections will only
show calendars and address books that are direct children of the path show calendars and address books that are direct children of the path
@ -2246,49 +2259,49 @@ password.</p>
modules is <a href="https://docs.python.org/3/distutils/setupscript.html">Distutils</a>. modules is <a href="https://docs.python.org/3/distutils/setupscript.html">Distutils</a>.
For a minimal setup create the file <code>setup.py</code> with the For a minimal setup create the file <code>setup.py</code> with the
following content in an empty folder:</p> following content in an empty folder:</p>
<div class="sourceCode" id="cb54"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb54-1"><a aria-hidden="true" href="#cb54-1" tabindex="-1"></a><span class="co">#!/usr/bin/env python3</span></span> <div class="sourceCode" id="cb55"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb55-1"><a aria-hidden="true" href="#cb55-1" tabindex="-1"></a><span class="co">#!/usr/bin/env python3</span></span>
<span id="cb54-2"><a aria-hidden="true" href="#cb54-2" tabindex="-1"></a></span> <span id="cb55-2"><a aria-hidden="true" href="#cb55-2" tabindex="-1"></a></span>
<span id="cb54-3"><a aria-hidden="true" href="#cb54-3" tabindex="-1"></a><span class="im">from</span> distutils.core <span class="im">import</span> setup</span> <span id="cb55-3"><a aria-hidden="true" href="#cb55-3" tabindex="-1"></a><span class="im">from</span> distutils.core <span class="im">import</span> setup</span>
<span id="cb54-4"><a aria-hidden="true" href="#cb54-4" tabindex="-1"></a></span> <span id="cb55-4"><a aria-hidden="true" href="#cb55-4" tabindex="-1"></a></span>
<span id="cb54-5"><a aria-hidden="true" href="#cb54-5" tabindex="-1"></a>setup(name<span class="op">=</span><span class="st">"radicale_static_password_auth"</span>,</span> <span id="cb55-5"><a aria-hidden="true" href="#cb55-5" tabindex="-1"></a>setup(name<span class="op">=</span><span class="st">"radicale_static_password_auth"</span>,</span>
<span id="cb54-6"><a aria-hidden="true" href="#cb54-6" tabindex="-1"></a> packages<span class="op">=</span>[<span class="st">"radicale_static_password_auth"</span>])</span></code></pre></div> <span id="cb55-6"><a aria-hidden="true" href="#cb55-6" tabindex="-1"></a> packages<span class="op">=</span>[<span class="st">"radicale_static_password_auth"</span>])</span></code></pre></div>
<p>In the same folder create the sub-folder <p>In the same folder create the sub-folder
<code>radicale_static_password_auth</code>. The folder must have the <code>radicale_static_password_auth</code>. The folder must have the
same name as specified in <code>packages</code> above.</p> same name as specified in <code>packages</code> above.</p>
<p>Create the file <code>__init__.py</code> in the <p>Create the file <code>__init__.py</code> in the
<code>radicale_static_password_auth</code> folder with the following <code>radicale_static_password_auth</code> folder with the following
content:</p> content:</p>
<div class="sourceCode" id="cb55"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb55-1"><a aria-hidden="true" href="#cb55-1" tabindex="-1"></a><span class="im">from</span> radicale.auth <span class="im">import</span> BaseAuth</span> <div class="sourceCode" id="cb56"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb56-1"><a aria-hidden="true" href="#cb56-1" tabindex="-1"></a><span class="im">from</span> radicale.auth <span class="im">import</span> BaseAuth</span>
<span id="cb55-2"><a aria-hidden="true" href="#cb55-2" tabindex="-1"></a><span class="im">from</span> radicale.log <span class="im">import</span> logger</span> <span id="cb56-2"><a aria-hidden="true" href="#cb56-2" tabindex="-1"></a><span class="im">from</span> radicale.log <span class="im">import</span> logger</span>
<span id="cb55-3"><a aria-hidden="true" href="#cb55-3" tabindex="-1"></a></span> <span id="cb56-3"><a aria-hidden="true" href="#cb56-3" tabindex="-1"></a></span>
<span id="cb55-4"><a aria-hidden="true" href="#cb55-4" tabindex="-1"></a>PLUGIN_CONFIG_SCHEMA <span class="op">=</span> {<span class="st">"auth"</span>: {</span> <span id="cb56-4"><a aria-hidden="true" href="#cb56-4" tabindex="-1"></a>PLUGIN_CONFIG_SCHEMA <span class="op">=</span> {<span class="st">"auth"</span>: {</span>
<span id="cb55-5"><a aria-hidden="true" href="#cb55-5" tabindex="-1"></a> <span class="st">"password"</span>: {<span class="st">"value"</span>: <span class="st">""</span>, <span class="st">"type"</span>: <span class="bu">str</span>}}}</span> <span id="cb56-5"><a aria-hidden="true" href="#cb56-5" tabindex="-1"></a> <span class="st">"password"</span>: {<span class="st">"value"</span>: <span class="st">""</span>, <span class="st">"type"</span>: <span class="bu">str</span>}}}</span>
<span id="cb55-6"><a aria-hidden="true" href="#cb55-6" tabindex="-1"></a></span> <span id="cb56-6"><a aria-hidden="true" href="#cb56-6" tabindex="-1"></a></span>
<span id="cb55-7"><a aria-hidden="true" href="#cb55-7" tabindex="-1"></a></span> <span id="cb56-7"><a aria-hidden="true" href="#cb56-7" tabindex="-1"></a></span>
<span id="cb55-8"><a aria-hidden="true" href="#cb55-8" tabindex="-1"></a><span class="kw">class</span> Auth(BaseAuth):</span> <span id="cb56-8"><a aria-hidden="true" href="#cb56-8" tabindex="-1"></a><span class="kw">class</span> Auth(BaseAuth):</span>
<span id="cb55-9"><a aria-hidden="true" href="#cb55-9" tabindex="-1"></a> <span class="kw">def</span> <span class="fu">__init__</span>(<span class="va">self</span>, configuration):</span> <span id="cb56-9"><a aria-hidden="true" href="#cb56-9" tabindex="-1"></a> <span class="kw">def</span> <span class="fu">__init__</span>(<span class="va">self</span>, configuration):</span>
<span id="cb55-10"><a aria-hidden="true" href="#cb55-10" tabindex="-1"></a> <span class="bu">super</span>().<span class="fu">__init__</span>(configuration.copy(PLUGIN_CONFIG_SCHEMA))</span> <span id="cb56-10"><a aria-hidden="true" href="#cb56-10" tabindex="-1"></a> <span class="bu">super</span>().<span class="fu">__init__</span>(configuration.copy(PLUGIN_CONFIG_SCHEMA))</span>
<span id="cb55-11"><a aria-hidden="true" href="#cb55-11" tabindex="-1"></a></span> <span id="cb56-11"><a aria-hidden="true" href="#cb56-11" tabindex="-1"></a></span>
<span id="cb55-12"><a aria-hidden="true" href="#cb55-12" tabindex="-1"></a> <span class="kw">def</span> _login(<span class="va">self</span>, login, password):</span> <span id="cb56-12"><a aria-hidden="true" href="#cb56-12" tabindex="-1"></a> <span class="kw">def</span> _login(<span class="va">self</span>, login, password):</span>
<span id="cb55-13"><a aria-hidden="true" href="#cb55-13" tabindex="-1"></a> <span class="co"># Get password from configuration option</span></span> <span id="cb56-13"><a aria-hidden="true" href="#cb56-13" tabindex="-1"></a> <span class="co"># Get password from configuration option</span></span>
<span id="cb55-14"><a aria-hidden="true" href="#cb55-14" tabindex="-1"></a> static_password <span class="op">=</span> <span class="va">self</span>.configuration.get(<span class="st">"auth"</span>, <span class="st">"password"</span>)</span> <span id="cb56-14"><a aria-hidden="true" href="#cb56-14" tabindex="-1"></a> static_password <span class="op">=</span> <span class="va">self</span>.configuration.get(<span class="st">"auth"</span>, <span class="st">"password"</span>)</span>
<span id="cb55-15"><a aria-hidden="true" href="#cb55-15" tabindex="-1"></a> <span class="co"># Check authentication</span></span> <span id="cb56-15"><a aria-hidden="true" href="#cb56-15" tabindex="-1"></a> <span class="co"># Check authentication</span></span>
<span id="cb55-16"><a aria-hidden="true" href="#cb55-16" tabindex="-1"></a> logger.info(<span class="st">"Login attempt by </span><span class="sc">%r</span><span class="st"> with password </span><span class="sc">%r</span><span class="st">"</span>,</span> <span id="cb56-16"><a aria-hidden="true" href="#cb56-16" tabindex="-1"></a> logger.info(<span class="st">"Login attempt by </span><span class="sc">%r</span><span class="st"> with password </span><span class="sc">%r</span><span class="st">"</span>,</span>
<span id="cb55-17"><a aria-hidden="true" href="#cb55-17" tabindex="-1"></a> login, password)</span> <span id="cb56-17"><a aria-hidden="true" href="#cb56-17" tabindex="-1"></a> login, password)</span>
<span id="cb55-18"><a aria-hidden="true" href="#cb55-18" tabindex="-1"></a> <span class="cf">if</span> password <span class="op">==</span> static_password:</span> <span id="cb56-18"><a aria-hidden="true" href="#cb56-18" tabindex="-1"></a> <span class="cf">if</span> password <span class="op">==</span> static_password:</span>
<span id="cb55-19"><a aria-hidden="true" href="#cb55-19" tabindex="-1"></a> <span class="cf">return</span> login</span> <span id="cb56-19"><a aria-hidden="true" href="#cb56-19" tabindex="-1"></a> <span class="cf">return</span> login</span>
<span id="cb55-20"><a aria-hidden="true" href="#cb55-20" tabindex="-1"></a> <span class="cf">return</span> <span class="st">""</span></span></code></pre></div> <span id="cb56-20"><a aria-hidden="true" href="#cb56-20" tabindex="-1"></a> <span class="cf">return</span> <span class="st">""</span></span></code></pre></div>
<p>Install the python module by running the following command in the <p>Install the python module by running the following command in the
same folder as <code>setup.py</code>:</p> same folder as <code>setup.py</code>:</p>
<div class="sourceCode" id="cb56"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb56-1"><a aria-hidden="true" href="#cb56-1" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> pip install .</span></code></pre></div> <div class="sourceCode" id="cb57"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb57-1"><a aria-hidden="true" href="#cb57-1" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> pip install .</span></code></pre></div>
<p>To make use this great creation in Radicale, set the configuration <p>To make use this great creation in Radicale, set the configuration
option <code>type</code> in the <code>auth</code> section to option <code>type</code> in the <code>auth</code> section to
<code>radicale_static_password_auth</code>:</p> <code>radicale_static_password_auth</code>:</p>
<div class="sourceCode" id="cb57"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb57-1"><a aria-hidden="true" href="#cb57-1" tabindex="-1"></a><span class="kw">[auth]</span></span> <div class="sourceCode" id="cb58"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb58-1"><a aria-hidden="true" href="#cb58-1" tabindex="-1"></a><span class="kw">[auth]</span></span>
<span id="cb57-2"><a aria-hidden="true" href="#cb57-2" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> radicale_static_password_auth</span></span> <span id="cb58-2"><a aria-hidden="true" href="#cb58-2" tabindex="-1"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> radicale_static_password_auth</span></span>
<span id="cb57-3"><a aria-hidden="true" href="#cb57-3" tabindex="-1"></a><span class="dt">password </span><span class="ot">=</span><span class="st"> secret</span></span></code></pre></div> <span id="cb58-3"><a aria-hidden="true" href="#cb58-3" tabindex="-1"></a><span class="dt">password </span><span class="ot">=</span><span class="st"> secret</span></span></code></pre></div>
<p>You can uninstall the module with:</p> <p>You can uninstall the module with:</p>
<div class="sourceCode" id="cb58"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb58-1"><a aria-hidden="true" href="#cb58-1" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> pip uninstall radicale_static_password_auth</span></code></pre></div> <div class="sourceCode" id="cb59"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb59-1"><a aria-hidden="true" href="#cb59-1" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> pip uninstall radicale_static_password_auth</span></code></pre></div>
</section> </section>
<section class="level4" id="authentication-plugins"> <section class="level4" id="authentication-plugins">
<h4>Authentication plugins <a class="headerlink" href="#authentication-plugins">&para;</a></h4> <h4>Authentication plugins <a class="headerlink" href="#authentication-plugins">&para;</a></h4>
@ -2347,14 +2360,14 @@ you want to add new features, fix bugs or update the documentation.</p>
<h4>PyPI <a class="headerlink" href="#pypi">&para;</a></h4> <h4>PyPI <a class="headerlink" href="#pypi">&para;</a></h4>
<p>Radicale is <a href="https://pypi.python.org/pypi/Radicale/">available on PyPI</a>. To <p>Radicale is <a href="https://pypi.python.org/pypi/Radicale/">available on PyPI</a>. To
install, just type as superuser:</p> install, just type as superuser:</p>
<div class="sourceCode" id="cb59"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb59-1"><a aria-hidden="true" href="#cb59-1" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> pip install <span class="at">--upgrade</span> radicale</span></code></pre></div> <div class="sourceCode" id="cb60"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb60-1"><a aria-hidden="true" href="#cb60-1" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> pip install <span class="at">--upgrade</span> radicale</span></code></pre></div>
</section> </section>
<section class="level4" id="git-repository"> <section class="level4" id="git-repository">
<h4>Git Repository <a class="headerlink" href="#git-repository">&para;</a></h4> <h4>Git Repository <a class="headerlink" href="#git-repository">&para;</a></h4>
<p>If you want the development version of Radicale, take a look at the <p>If you want the development version of Radicale, take a look at the
<a href="https://github.com/Kozea/Radicale/">git repository on <a href="https://github.com/Kozea/Radicale/">git repository on
GitHub</a>, or install it directly with:</p> GitHub</a>, or install it directly with:</p>
<div class="sourceCode" id="cb60"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb60-1"><a aria-hidden="true" href="#cb60-1" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> pip install <span class="at">--upgrade</span> https://github.com/Kozea/Radicale/archive/master.tar.gz</span></code></pre></div> <div class="sourceCode" id="cb61"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb61-1"><a aria-hidden="true" href="#cb61-1" tabindex="-1"></a><span class="ex">python3</span> <span class="at">-m</span> pip install <span class="at">--upgrade</span> https://github.com/Kozea/Radicale/archive/master.tar.gz</span></code></pre></div>
<p>You can also download the content of the repository as an <a href="https://github.com/Kozea/Radicale/tarball/master">archive</a>.</p> <p>You can also download the content of the repository as an <a href="https://github.com/Kozea/Radicale/tarball/master">archive</a>.</p>
</section> </section>
<section class="level4" id="source-packages"> <section class="level4" id="source-packages">
@ -2366,7 +2379,7 @@ GitHub</a>, or install it directly with:</p>
<p>Radicale is available as a <a href="https://github.com/Kozea/Radicale/pkgs/container/radicale">Docker <p>Radicale is available as a <a href="https://github.com/Kozea/Radicale/pkgs/container/radicale">Docker
image</a> for platforms <code>linux/amd64</code> and image</a> for platforms <code>linux/amd64</code> and
<code>linux/arm64</code>. To install the latest version, run:</p> <code>linux/arm64</code>. To install the latest version, run:</p>
<div class="sourceCode" id="cb61"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb61-1"><a aria-hidden="true" href="#cb61-1" tabindex="-1"></a><span class="ex">docker</span> pull ghcr.io/kozea/radicale:latest</span></code></pre></div> <div class="sourceCode" id="cb62"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb62-1"><a aria-hidden="true" href="#cb62-1" tabindex="-1"></a><span class="ex">docker</span> pull ghcr.io/kozea/radicale:latest</span></code></pre></div>
<p>An example <code>docker-compose.yml</code> and detailed instructions <p>An example <code>docker-compose.yml</code> and detailed instructions
will soon be updated.</p> will soon be updated.</p>
</section> </section>