mirror of
https://github.com/Kozea/Radicale.git
synced 2025-06-26 16:45:52 +00:00
1318 lines
119 KiB
HTML
1318 lines
119 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
|
||
|
|
<html lang="en">
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta content="pandoc" name="generator">
|
||
|
|
<meta content="width=device-width, initial-scale=1" name="viewport">
|
||
|
|
<style>
|
||
|
|
code{white-space: pre-wrap;}
|
||
|
|
span.smallcaps{font-variant: small-caps;}
|
||
|
|
span.underline{text-decoration: underline;}
|
||
|
|
div.column{display: inline-block; vertical-align: top; width: 50%;}
|
||
|
|
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
|
||
|
|
ul.task-list{list-style: none;}
|
||
|
|
pre > code.sourceCode { white-space: pre; position: relative; }
|
||
|
|
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
|
||
|
|
pre > code.sourceCode > span:empty { height: 1.2em; }
|
||
|
|
code.sourceCode > span { color: inherit; text-decoration: inherit; }
|
||
|
|
div.sourceCode { margin: 1em 0; }
|
||
|
|
pre.sourceCode { margin: 0; }
|
||
|
|
@media screen {
|
||
|
|
div.sourceCode { overflow: auto; }
|
||
|
|
}
|
||
|
|
@media print {
|
||
|
|
pre > code.sourceCode { white-space: pre-wrap; }
|
||
|
|
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
|
||
|
|
}
|
||
|
|
pre.numberSource code
|
||
|
|
{ counter-reset: source-line 0; }
|
||
|
|
pre.numberSource code > span
|
||
|
|
{ position: relative; left: -4em; counter-increment: source-line; }
|
||
|
|
pre.numberSource code > span > a:first-child::before
|
||
|
|
{ content: counter(source-line);
|
||
|
|
position: relative; left: -1em; text-align: right; vertical-align: baseline;
|
||
|
|
border: none; display: inline-block;
|
||
|
|
-webkit-touch-callout: none; -webkit-user-select: none;
|
||
|
|
-khtml-user-select: none; -moz-user-select: none;
|
||
|
|
-ms-user-select: none; user-select: none;
|
||
|
|
padding: 0 4px; width: 4em;
|
||
|
|
color: #aaaaaa;
|
||
|
|
}
|
||
|
|
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
|
||
|
|
div.sourceCode
|
||
|
|
{ }
|
||
|
|
@media screen {
|
||
|
|
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
|
||
|
|
}
|
||
|
|
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
|
||
|
|
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
|
||
|
|
code span.at { color: #7d9029; } /* Attribute */
|
||
|
|
code span.bn { color: #40a070; } /* BaseN */
|
||
|
|
code span.bu { } /* BuiltIn */
|
||
|
|
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
|
||
|
|
code span.ch { color: #4070a0; } /* Char */
|
||
|
|
code span.cn { color: #880000; } /* Constant */
|
||
|
|
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
|
||
|
|
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
|
||
|
|
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
|
||
|
|
code span.dt { color: #902000; } /* DataType */
|
||
|
|
code span.dv { color: #40a070; } /* DecVal */
|
||
|
|
code span.er { color: #ff0000; font-weight: bold; } /* Error */
|
||
|
|
code span.ex { } /* Extension */
|
||
|
|
code span.fl { color: #40a070; } /* Float */
|
||
|
|
code span.fu { color: #06287e; } /* Function */
|
||
|
|
code span.im { } /* Import */
|
||
|
|
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
|
||
|
|
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
|
||
|
|
code span.op { color: #666666; } /* Operator */
|
||
|
|
code span.ot { color: #007020; } /* Other */
|
||
|
|
code span.pp { color: #bc7a00; } /* Preprocessor */
|
||
|
|
code span.sc { color: #4070a0; } /* SpecialChar */
|
||
|
|
code span.ss { color: #bb6688; } /* SpecialString */
|
||
|
|
code span.st { color: #4070a0; } /* String */
|
||
|
|
code span.va { color: #19177c; } /* Variable */
|
||
|
|
code span.vs { color: #4070a0; } /* VerbatimString */
|
||
|
|
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
|
||
|
|
</style>
|
||
|
|
<link href="assets/default.css" media="all" rel="stylesheet">
|
||
|
|
<link href="assets/screen.css" media="screen" rel="stylesheet">
|
||
|
|
<link href="assets/screen-narrow.css" media="screen and (max-width: 50em)" rel="stylesheet">
|
||
|
|
<noscript><link href="assets/screen-noscript.css" media="screen" rel="stylesheet"></noscript>
|
||
|
|
<link href="https://github.com/Kozea/Radicale/releases.atom" rel="alternate" title="Radicale Releases" type="application/atom+xml">
|
||
|
|
<link href="assets/icon.png" rel="icon" type="image/png">
|
||
|
|
<title>Radicale - Free and Open-Source CalDAV and CardDAV Server</title>
|
||
|
|
<meta content="Free and Open-Source CalDAV and CardDAV Server" name="description">
|
||
|
|
<script src="assets/navigation.js"></script>
|
||
|
|
<script src="assets/document-branches.js"></script>
|
||
|
|
<script src="assets/narrow-menu.js"></script>
|
||
|
|
<script>
|
||
|
|
const documentBranch = "master";
|
||
|
|
const documentBranches = ["1.1", "2.1", "master"];
|
||
|
|
</script>
|
||
|
|
<header>
|
||
|
|
<div class="logoContainer">
|
||
|
|
<h1>
|
||
|
|
Radicale
|
||
|
|
<span class="documentBranch">master</span>
|
||
|
|
<select class="documentBranch"></select>
|
||
|
|
</h1>
|
||
|
|
<p>Free and Open-Source CalDAV and CardDAV Server</p>
|
||
|
|
</div>
|
||
|
|
<div class="linkContainer">
|
||
|
|
<ul>
|
||
|
|
<li><a href="https://community.kozea.fr">Made with ❤ by Kozea Community</a></li>
|
||
|
|
<li><a href="https://github.com/Kozea/Radicale">Fork me on GitHub</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</header>
|
||
|
|
<main>
|
||
|
|
<div class="navButtonContainer">
|
||
|
|
<button data-name="nav-open">Contents</button>
|
||
|
|
</div>
|
||
|
|
<nav>
|
||
|
|
<div class="navContainer">
|
||
|
|
<div class="navButtonContainer">
|
||
|
|
<button data-name="nav-close">Close</button>
|
||
|
|
</div>
|
||
|
|
<h2>Contents</h2>
|
||
|
|
<ul>
|
||
|
|
<li class="level2"><a href="#getting-started">Getting started</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#getting-started//about-radicale">About Radicale</a></li>
|
||
|
|
<li class="level4"><a href="#getting-started//installation">Installation</a></li>
|
||
|
|
<li class="level4"><a href="#getting-started//whats-new">What's New?</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level2"><a href="#documentation">Documentation</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation//install-and-set-up">Install and Set Up</a></li>
|
||
|
|
<li class="level4"><a href="#documentation//use">Use</a></li>
|
||
|
|
<li class="level4"><a href="#documentation//configure">Configure</a></li>
|
||
|
|
<li class="level4"><a href="#documentation//hack">Hack</a></li>
|
||
|
|
<li class="level3"><a href="#documentation/tutorial">Tutorial</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/tutorial/linux--bsd">Linux / *BSD</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/tutorial/windows">Windows</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/tutorial/macos">MacOS</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level3"><a href="#documentation/basic-setup">Basic Setup</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/basic-setup/configuration">Configuration</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/basic-setup/authentication">Authentication</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/basic-setup/addresses">Addresses</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/basic-setup/storage">Storage</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/basic-setup/limits">Limits</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/basic-setup/running-as-a-service">Running as a service</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/basic-setup/macos-with-launchd">MacOS with launchd</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/basic-setup/classic-daemonization">Classic daemonization</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/basic-setup/windows-with-nssm---the-non-sucking-service-manager">Windows with "NSSM - the Non-Sucking Service Manager"</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level3"><a href="#documentation/reverse-proxy">Reverse Proxy</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/reverse-proxy/manage-user-accounts-with-the-reverse-proxy">Manage user accounts with the reverse proxy</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/reverse-proxy/secure-connection-between-radicale-and-the-reverse-proxy">Secure connection between Radicale and the reverse proxy</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level3"><a href="#documentation/wsgi">WSGI</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/wsgi/manage-user-accounts-with-the-wsgi-server">Manage user accounts with the WSGI server</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level3"><a href="#documentation/versioning">Versioning</a></li>
|
||
|
|
<li class="level3"><a href="#documentation/clients">Clients</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/clients/davx⁵">DAVx⁵</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/clients/gnome-calendar-contacts-and-evolution">GNOME Calendar, Contacts and Evolution</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/clients/thunderbird">Thunderbird</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/clients/infcloud-caldavzap-and-carddavmate">InfCloud, CalDavZAP and CardDavMATE</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/clients/manual-creation-of-calendars-and-address-books">Manual creation of calendars and address books</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level3"><a href="#documentation/configuration">Configuration</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/configuration/server">server</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/configuration/encoding">encoding</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/configuration/auth">auth</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/configuration/rights">rights</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/configuration/storage">storage</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/configuration/web">web</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/configuration/logging">logging</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/configuration/headers">headers</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level3"><a href="#documentation/authentication-and-rights">Authentication and Rights</a></li>
|
||
|
|
<li class="level3"><a href="#documentation/storage">Storage</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/storage/layout">Layout</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/storage/locking">Locking</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level3"><a href="#documentation/logging">Logging</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/logging/logging-to-a-file">Logging to a file</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level3"><a href="#documentation/architecture">Architecture</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/architecture/general-architecture">General Architecture</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/architecture/code-architecture">Code Architecture</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level3"><a href="#documentation/plugins">Plugins</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#documentation/plugins/getting-started">Getting started</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/plugins/authentication-plugins">Authentication plugins</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/plugins/rights-management-plugins">Rights management plugins</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/plugins/web-plugins">Web plugins</a></li>
|
||
|
|
<li class="level4"><a href="#documentation/plugins/storage-plugins">Storage plugins</a></li>
|
||
|
|
</ul></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level2"><a href="#contribute">Contribute</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#contribute//chat-with-us-on-irc">Chat with Us on IRC</a></li>
|
||
|
|
<li class="level4"><a href="#contribute//report-bugs">Report Bugs</a></li>
|
||
|
|
<li class="level4"><a href="#contribute//hack">Hack</a></li>
|
||
|
|
<li class="level4"><a href="#contribute//documentation">Documentation</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level2"><a href="#download">Download</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#download//pypi">PyPI</a></li>
|
||
|
|
<li class="level4"><a href="#download//git-repository">Git Repository</a></li>
|
||
|
|
<li class="level4"><a href="#download//source-packages">Source Packages</a></li>
|
||
|
|
<li class="level4"><a href="#download//linux-distribution-packages">Linux Distribution Packages</a></li>
|
||
|
|
</ul></li>
|
||
|
|
<li class="level2"><a href="#about">About</a>
|
||
|
|
<ul>
|
||
|
|
<li class="level4"><a href="#about//main-goals">Main Goals</a></li>
|
||
|
|
<li class="level4"><a href="#about//what-radicale-will-never-be">What Radicale Will Never Be</a></li>
|
||
|
|
<li class="level4"><a href="#about//technical-choices">Technical Choices</a></li>
|
||
|
|
<li class="level4"><a href="#about//history">History</a></li>
|
||
|
|
</ul></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
<div class="documentContainer">
|
||
|
|
<section class="level2" id="getting-started">
|
||
|
|
<h2>Getting started <a class="headerlink" href="#getting-started">¶</a></h2>
|
||
|
|
<section class="level4" id="getting-started//about-radicale">
|
||
|
|
<h4>About Radicale <a class="headerlink" href="#getting-started//about-radicale">¶</a></h4>
|
||
|
|
<p>Radicale is a small but powerful CalDAV (calendars, todo-lists) and CardDAV (contacts) server, that:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Shares calendars through CalDAV, WebDAV and HTTP.</li>
|
||
|
|
<li>Shares contacts through CardDAV, WebDAV and HTTP.</li>
|
||
|
|
<li>Supports events, todos, journal entries and business cards.</li>
|
||
|
|
<li>Works out-of-the-box, no installation nor configuration required.</li>
|
||
|
|
<li>Can warn users on concurrent editing.</li>
|
||
|
|
<li>Can limit access by authentication.</li>
|
||
|
|
<li>Can secure connections.</li>
|
||
|
|
<li>Works with many CalDAV and CardDAV clients.</li>
|
||
|
|
<li>Is GPLv3-licensed free software.</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="getting-started//installation">
|
||
|
|
<h4>Installation <a class="headerlink" href="#getting-started//installation">¶</a></h4>
|
||
|
|
<p>Radicale is really easy to install and works out-of-the-box.</p>
|
||
|
|
<div class="sourceCode" id="cb1"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1"></a>$ <span class="ex">python3</span> -m pip install --upgrade radicale</span>
|
||
|
|
<span id="cb1-2"><a href="#cb1-2"></a>$ <span class="ex">python3</span> -m radicale --config <span class="st">""</span> --storage-filesystem-folder=~/.var/lib/radicale/collections</span></code></pre></div>
|
||
|
|
<p>When your server is launched, you can check that everything's OK by going to <a href="http://localhost:5232/">http://localhost:5232/</a> with your browser! You can login with any username and password.</p>
|
||
|
|
<p>Want more? Why don't you check our wonderful <a href="#documentation">documentation</a>?</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="getting-started//whats-new">
|
||
|
|
<h4>What's New? <a class="headerlink" href="#getting-started//whats-new">¶</a></h4>
|
||
|
|
<p><a href="https://github.com/Kozea/Radicale/blob/master/NEWS.md">Read the latest news</a></p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level2" id="documentation">
|
||
|
|
<h2>Documentation <a class="headerlink" href="#documentation">¶</a></h2>
|
||
|
|
<section class="level4" id="documentation//install-and-set-up">
|
||
|
|
<h4>Install and Set Up <a class="headerlink" href="#documentation//install-and-set-up">¶</a></h4>
|
||
|
|
<p>You're new to Radicale and you want to know how to use it? Welcome aboard!</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#about">What is Radicale?</a></li>
|
||
|
|
<li><a href="#documentation/tutorial">A really simple 5-minute tutorial.</a></li>
|
||
|
|
<li><a href="#documentation/basic-setup">A simple but solid setup.</a></li>
|
||
|
|
<li><a href="#documentation/reverse-proxy">Run behind a reverse proxy.</a></li>
|
||
|
|
<li><a href="#documentation/wsgi">Run with a WSGI server.</a></li>
|
||
|
|
<li><a href="#documentation/versioning">Track all changes to calendars and address books with Git.</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation//use">
|
||
|
|
<h4>Use <a class="headerlink" href="#documentation//use">¶</a></h4>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#documentation/clients">Which clients are supported?</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation//configure">
|
||
|
|
<h4>Configure <a class="headerlink" href="#documentation//configure">¶</a></h4>
|
||
|
|
<p>Now that you have Radicale running, let's see what we can configure to make it fit your needs.</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#documentation/configuration">What can I configure?</a></li>
|
||
|
|
<li><a href="#documentation/authentication-and-rights">Authentication & Rights.</a></li>
|
||
|
|
<li><a href="#documentation/storage">Storage.</a></li>
|
||
|
|
<li><a href="#documentation/logging">Logging.</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation//hack">
|
||
|
|
<h4>Hack <a class="headerlink" href="#documentation//hack">¶</a></h4>
|
||
|
|
<p>Using is fun, but hacking is soooooooo coooooool. Radicale is a really small and simple piece of code, it may be the perfect project to start hacking!</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#documentation/architecture">How does Radicale work?</a></li>
|
||
|
|
<li><a href="#documentation/plugins">Plugins.</a></li>
|
||
|
|
<li><a href="#contribute">Adding or fixing documentation.</a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/tutorial">
|
||
|
|
<h3>Tutorial <a class="headerlink" href="#documentation/tutorial">¶</a></h3>
|
||
|
|
<p>You want to try Radicale but only have 5 minutes free in your calendar? Let's go right now! You won't have the best installation ever, but it will be enough to play a little bit with Radicale.</p>
|
||
|
|
<p>When everything works, you can get a <a href="#documentation/clients">client</a> and start creating calendars and address books. The server <strong>only</strong> binds to localhost (is <strong>not</strong> reachable over the network) and you can log in with any user name and password. If Radicale fits your needs, it may be time for <a href="#documentation/basic-setup">some basic configuration</a>.</p>
|
||
|
|
<p>Follow one of the chapters below depending on your operating system.</p>
|
||
|
|
<section class="level4" id="documentation/tutorial/linux--bsd">
|
||
|
|
<h4>Linux / *BSD <a class="headerlink" href="#documentation/tutorial/linux--bsd">¶</a></h4>
|
||
|
|
<p>First of all, make sure that <strong>python</strong> 3.3 or later (<strong>python</strong> ≥ 3.6 is recommended) 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>
|
||
|
|
<div class="sourceCode" id="cb2"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1"></a><span class="co"># Run the following command as root or</span></span>
|
||
|
|
<span id="cb2-2"><a href="#cb2-2"></a><span class="co"># add the --user argument to only install for the current user</span></span>
|
||
|
|
<span id="cb2-3"><a href="#cb2-3"></a>$ <span class="ex">python3</span> -m pip install --upgrade radicale</span>
|
||
|
|
<span id="cb2-4"><a href="#cb2-4"></a>$ <span class="ex">python3</span> -m radicale --config <span class="st">""</span> --storage-filesystem-folder=~/.var/lib/radicale/collections</span></code></pre></div>
|
||
|
|
<p>Victory! Open <a href="http://localhost:5232/">http://localhost:5232/</a> in your browser! You can login with any username and password.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/tutorial/windows">
|
||
|
|
<h4>Windows <a class="headerlink" href="#documentation/tutorial/windows">¶</a></h4>
|
||
|
|
<p>The first step is to install Python. Go to <a href="https://python.org">python.org</a> and download the latest version of Python 3. Then run the installer. On the first window of the installer, check the "Add Python to PATH" box and click on "Install now". Wait a couple of minutes, it's done!</p>
|
||
|
|
<p>Launch a command prompt and type:</p>
|
||
|
|
<div class="sourceCode" id="cb3"><pre class="sourceCode powershell"><code class="sourceCode powershell"><span id="cb3-1"><a href="#cb3-1"></a>C:\Users\User> python -m pip install --upgrade radicale</span>
|
||
|
|
<span id="cb3-2"><a href="#cb3-2"></a>C:\Users\User> python -m radicale --config <span class="st">""</span> --storage-filesystem-folder=~/radicale/collections</span></code></pre></div>
|
||
|
|
<p>If you are using PowerShell replace <code>--config ""</code> with <code>--config '""'</code>.</p>
|
||
|
|
<p>Victory! Open <a href="http://localhost:5232/">http://localhost:5232/</a> in your browser! You can login with any username and password.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/tutorial/macos">
|
||
|
|
<h4>MacOS <a class="headerlink" href="#documentation/tutorial/macos">¶</a></h4>
|
||
|
|
<p><em>To be written.</em></p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/basic-setup">
|
||
|
|
<h3>Basic Setup <a class="headerlink" href="#documentation/basic-setup">¶</a></h3>
|
||
|
|
<p>Installation instructions can be found on the <a href="#documentation/tutorial">Tutorial</a> page.</p>
|
||
|
|
<section class="level4" id="documentation/basic-setup/configuration">
|
||
|
|
<h4>Configuration <a class="headerlink" href="#documentation/basic-setup/configuration">¶</a></h4>
|
||
|
|
<p>Radicale tries to load configuration files from <code>/etc/radicale/config</code>, <code>~/.config/radicale/config</code> and the <code>RADICALE_CONFIG</code> environment variable. A custom path can be specified with the <code>--config /path/to/config</code> command line argument.</p>
|
||
|
|
<p>You should create a new configuration file at the desired location. (If the use of a configuration file is inconvenient, all options can be passed via command line arguments.)</p>
|
||
|
|
<p>All configuration options are described in detail on the <a href="#documentation/configuration">Configuration</a> page.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/basic-setup/authentication">
|
||
|
|
<h4>Authentication <a class="headerlink" href="#documentation/basic-setup/authentication">¶</a></h4>
|
||
|
|
<p>In its default configuration Radicale doesn't check user names or passwords. If the server is reachable over a network, you should change this.</p>
|
||
|
|
<p>First a <code>users</code> file with all user names and passwords must be created. It can be stored in the same directory as the configuration file.</p>
|
||
|
|
<section class="level5" id="documentation/basic-setup/authentication/the-secure-way">
|
||
|
|
<h5>The secure way <a class="headerlink" href="#documentation/basic-setup/authentication/the-secure-way">¶</a></h5>
|
||
|
|
<p>The <code>users</code> file can be created and managed with <a href="https://httpd.apache.org/docs/current/programs/htpasswd.html">htpasswd</a>:</p>
|
||
|
|
<div class="sourceCode" id="cb4"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1"></a><span class="co"># Create a new htpasswd file with the user "user1"</span></span>
|
||
|
|
<span id="cb4-2"><a href="#cb4-2"></a>$ <span class="ex">htpasswd</span> -B -c /path/to/users user1</span>
|
||
|
|
<span id="cb4-3"><a href="#cb4-3"></a><span class="ex">New</span> password:</span>
|
||
|
|
<span id="cb4-4"><a href="#cb4-4"></a><span class="ex">Re-type</span> new password:</span>
|
||
|
|
<span id="cb4-5"><a href="#cb4-5"></a><span class="co"># Add another user</span></span>
|
||
|
|
<span id="cb4-6"><a href="#cb4-6"></a>$ <span class="ex">htpasswd</span> -B /path/to/users user2</span>
|
||
|
|
<span id="cb4-7"><a href="#cb4-7"></a><span class="ex">New</span> password:</span>
|
||
|
|
<span id="cb4-8"><a href="#cb4-8"></a><span class="ex">Re-type</span> new password:</span></code></pre></div>
|
||
|
|
<p><strong>bcrypt</strong> is used to secure the passwords. Radicale requires additional dependencies for this encryption method:</p>
|
||
|
|
<div class="sourceCode" id="cb5"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1"></a>$ <span class="ex">python3</span> -m pip install --upgrade radicale[bcrypt]</span></code></pre></div>
|
||
|
|
<p>Authentication can be enabled with the following configuration:</p>
|
||
|
|
<div class="sourceCode" id="cb6"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb6-1"><a href="#cb6-1"></a><span class="kw">[auth]</span></span>
|
||
|
|
<span id="cb6-2"><a href="#cb6-2"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> htpasswd</span></span>
|
||
|
|
<span id="cb6-3"><a href="#cb6-3"></a><span class="dt">htpasswd_filename </span><span class="ot">=</span><span class="st"> /path/to/users</span></span>
|
||
|
|
<span id="cb6-4"><a href="#cb6-4"></a><span class="co"># encryption method used in the htpasswd file</span></span>
|
||
|
|
<span id="cb6-5"><a href="#cb6-5"></a><span class="dt">htpasswd_encryption </span><span class="ot">=</span><span class="st"> bcrypt</span></span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/basic-setup/authentication/the-simple-but-insecure-way">
|
||
|
|
<h5>The simple but insecure way <a class="headerlink" href="#documentation/basic-setup/authentication/the-simple-but-insecure-way">¶</a></h5>
|
||
|
|
<p>Create the <code>users</code> file by hand with lines containing the user name and password separated by <code>:</code>. Example:</p>
|
||
|
|
<pre class="htpasswd"><code>user1:password1
|
||
|
|
user2:password2
|
||
|
|
</code></pre>
|
||
|
|
<p>Authentication can be enabled with the following configuration:</p>
|
||
|
|
<div class="sourceCode" id="cb8"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb8-1"><a href="#cb8-1"></a><span class="kw">[auth]</span></span>
|
||
|
|
<span id="cb8-2"><a href="#cb8-2"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> htpasswd</span></span>
|
||
|
|
<span id="cb8-3"><a href="#cb8-3"></a><span class="dt">htpasswd_filename </span><span class="ot">=</span><span class="st"> /path/to/users</span></span>
|
||
|
|
<span id="cb8-4"><a href="#cb8-4"></a><span class="co"># encryption method used in the htpasswd file</span></span>
|
||
|
|
<span id="cb8-5"><a href="#cb8-5"></a><span class="dt">htpasswd_encryption </span><span class="ot">=</span><span class="st"> plain</span></span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/basic-setup/addresses">
|
||
|
|
<h4>Addresses <a class="headerlink" href="#documentation/basic-setup/addresses">¶</a></h4>
|
||
|
|
<p>The default configuration binds the server to localhost. It can't be reached from other computers. This can be changed with the following configuration options:</p>
|
||
|
|
<div class="sourceCode" id="cb9"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb9-1"><a href="#cb9-1"></a><span class="kw">[server]</span></span>
|
||
|
|
<span id="cb9-2"><a href="#cb9-2"></a><span class="dt">hosts </span><span class="ot">=</span><span class="st"> </span><span class="dv">0</span><span class="st">.</span><span class="dv">0</span><span class="st">.</span><span class="fl">0.0</span><span class="st">:</span><span class="dv">5232</span></span></code></pre></div>
|
||
|
|
<p>More addresses can be added (separated by commas).</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/basic-setup/storage">
|
||
|
|
<h4>Storage <a class="headerlink" href="#documentation/basic-setup/storage">¶</a></h4>
|
||
|
|
<p>Data is stored in the folder <code>/var/lib/radicale/collections</code>. The path can be changed with the following configuration:</p>
|
||
|
|
<div class="sourceCode" id="cb10"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb10-1"><a href="#cb10-1"></a><span class="kw">[storage]</span></span>
|
||
|
|
<span id="cb10-2"><a href="#cb10-2"></a><span class="dt">filesystem_folder </span><span class="ot">=</span><span class="st"> /path/to/storage</span></span></code></pre></div>
|
||
|
|
<p><strong>Security:</strong> The storage folder should not be readable by unauthorized users. Otherwise, they can read the calendar data and lock the storage. You can find OS dependent instructions in the <strong>Running as a service</strong> section.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/basic-setup/limits">
|
||
|
|
<h4>Limits <a class="headerlink" href="#documentation/basic-setup/limits">¶</a></h4>
|
||
|
|
<p>Radicale enforces limits on the maximum number of parallel connections, the maximum file size (important for contacts with big photos) and the rate of incorrect authentication attempts. Connections are terminated after a timeout. The default values should be fine for most scenarios.</p>
|
||
|
|
<div class="sourceCode" id="cb11"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb11-1"><a href="#cb11-1"></a><span class="kw">[server]</span></span>
|
||
|
|
<span id="cb11-2"><a href="#cb11-2"></a><span class="dt">max_connections </span><span class="ot">=</span><span class="st"> </span><span class="dv">20</span></span>
|
||
|
|
<span id="cb11-3"><a href="#cb11-3"></a><span class="co"># 100 Megabyte</span></span>
|
||
|
|
<span id="cb11-4"><a href="#cb11-4"></a><span class="dt">max_content_length </span><span class="ot">=</span><span class="st"> </span><span class="dv">100000000</span></span>
|
||
|
|
<span id="cb11-5"><a href="#cb11-5"></a><span class="co"># 30 seconds</span></span>
|
||
|
|
<span id="cb11-6"><a href="#cb11-6"></a><span class="dt">timeout </span><span class="ot">=</span><span class="st"> </span><span class="dv">30</span></span>
|
||
|
|
<span id="cb11-7"><a href="#cb11-7"></a></span>
|
||
|
|
<span id="cb11-8"><a href="#cb11-8"></a><span class="kw">[auth]</span></span>
|
||
|
|
<span id="cb11-9"><a href="#cb11-9"></a><span class="co"># Average delay after failed login attempts in seconds</span></span>
|
||
|
|
<span id="cb11-10"><a href="#cb11-10"></a><span class="dt">delay </span><span class="ot">=</span><span class="st"> </span><span class="dv">1</span></span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/basic-setup/running-as-a-service">
|
||
|
|
<h4>Running as a service <a class="headerlink" href="#documentation/basic-setup/running-as-a-service">¶</a></h4>
|
||
|
|
<p>The method to run Radicale as a service depends on your host operating system. Follow one of the chapters below depending on your operating system and requirements.</p>
|
||
|
|
<section class="level5" id="documentation/basic-setup/running-as-a-service/linux-with-systemd-as-a-user">
|
||
|
|
<h5>Linux with systemd as a user <a class="headerlink" href="#documentation/basic-setup/running-as-a-service/linux-with-systemd-as-a-user">¶</a></h5>
|
||
|
|
<p>Create the file <code>~/.config/systemd/user/radicale.service</code>:</p>
|
||
|
|
<div class="sourceCode" id="cb12"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb12-1"><a href="#cb12-1"></a><span class="kw">[Unit]</span></span>
|
||
|
|
<span id="cb12-2"><a href="#cb12-2"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">A simple CalDAV (calendar) and CardDAV (contact) server</span></span>
|
||
|
|
<span id="cb12-3"><a href="#cb12-3"></a></span>
|
||
|
|
<span id="cb12-4"><a href="#cb12-4"></a><span class="kw">[Service]</span></span>
|
||
|
|
<span id="cb12-5"><a href="#cb12-5"></a><span class="dt">ExecStart</span><span class="ot">=</span><span class="st">/usr/bin/env python3 -m radicale</span></span>
|
||
|
|
<span id="cb12-6"><a href="#cb12-6"></a><span class="dt">Restart</span><span class="ot">=</span><span class="kw">on</span><span class="st">-failure</span></span>
|
||
|
|
<span id="cb12-7"><a href="#cb12-7"></a></span>
|
||
|
|
<span id="cb12-8"><a href="#cb12-8"></a><span class="kw">[Install]</span></span>
|
||
|
|
<span id="cb12-9"><a href="#cb12-9"></a><span class="dt">WantedBy</span><span class="ot">=</span><span class="kw">default</span><span class="st">.target</span></span></code></pre></div>
|
||
|
|
<p>Radicale will load the configuration file from <code>~/.config/radicale/config</code>. You should set the configuration option <code>filesystem_folder</code> in the <code>storage</code> section to something like <code>~/.var/lib/radicale/collections</code>.</p>
|
||
|
|
<p>To enable and manage the service run:</p>
|
||
|
|
<div class="sourceCode" id="cb13"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1"></a><span class="co"># Enable the service</span></span>
|
||
|
|
<span id="cb13-2"><a href="#cb13-2"></a>$ <span class="ex">systemctl</span> --user enable radicale</span>
|
||
|
|
<span id="cb13-3"><a href="#cb13-3"></a><span class="co"># Start the service</span></span>
|
||
|
|
<span id="cb13-4"><a href="#cb13-4"></a>$ <span class="ex">systemctl</span> --user start radicale</span>
|
||
|
|
<span id="cb13-5"><a href="#cb13-5"></a><span class="co"># Check the status of the service</span></span>
|
||
|
|
<span id="cb13-6"><a href="#cb13-6"></a>$ <span class="ex">systemctl</span> --user status radicale</span>
|
||
|
|
<span id="cb13-7"><a href="#cb13-7"></a><span class="co"># View all log messages</span></span>
|
||
|
|
<span id="cb13-8"><a href="#cb13-8"></a>$ <span class="ex">journalctl</span> --user --unit radicale.service</span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/basic-setup/running-as-a-service/linux-with-systemd-system-wide">
|
||
|
|
<h5>Linux with systemd system-wide <a class="headerlink" href="#documentation/basic-setup/running-as-a-service/linux-with-systemd-system-wide">¶</a></h5>
|
||
|
|
<p>Create the <strong>radicale</strong> user and group for the Radicale service. (Run <code>useradd --system --home-dir / --shell /sbin/nologin radicale</code> as root.) The storage folder must be writable by <strong>radicale</strong>. (Run <code>mkdir -p /var/lib/radicale/collections && chown -R radicale:radicale /var/lib/radicale/collections</code> as root.)</p>
|
||
|
|
<p><strong>Security:</strong> The storage should not be readable by others. (Run <code>chmod -R o= /var/lib/radicale/collections</code> as root.)</p>
|
||
|
|
<p>Create the file <code>/etc/systemd/system/radicale.service</code>:</p>
|
||
|
|
<div class="sourceCode" id="cb14"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb14-1"><a href="#cb14-1"></a><span class="kw">[Unit]</span></span>
|
||
|
|
<span id="cb14-2"><a href="#cb14-2"></a><span class="dt">Description</span><span class="ot">=</span><span class="st">A simple CalDAV (calendar) and CardDAV (contact) server</span></span>
|
||
|
|
<span id="cb14-3"><a href="#cb14-3"></a><span class="dt">After</span><span class="ot">=</span><span class="st">network.target</span></span>
|
||
|
|
<span id="cb14-4"><a href="#cb14-4"></a><span class="dt">Requires</span><span class="ot">=</span><span class="st">network.target</span></span>
|
||
|
|
<span id="cb14-5"><a href="#cb14-5"></a></span>
|
||
|
|
<span id="cb14-6"><a href="#cb14-6"></a><span class="kw">[Service]</span></span>
|
||
|
|
<span id="cb14-7"><a href="#cb14-7"></a><span class="dt">ExecStart</span><span class="ot">=</span><span class="st">/usr/bin/env python3 -m radicale</span></span>
|
||
|
|
<span id="cb14-8"><a href="#cb14-8"></a><span class="dt">Restart</span><span class="ot">=</span><span class="kw">on</span><span class="st">-failure</span></span>
|
||
|
|
<span id="cb14-9"><a href="#cb14-9"></a><span class="dt">User</span><span class="ot">=</span><span class="st">radicale</span></span>
|
||
|
|
<span id="cb14-10"><a href="#cb14-10"></a><span class="co"># Deny other users access to the calendar data</span></span>
|
||
|
|
<span id="cb14-11"><a href="#cb14-11"></a><span class="dt">UMask</span><span class="ot">=</span><span class="dv">0027</span></span>
|
||
|
|
<span id="cb14-12"><a href="#cb14-12"></a><span class="co"># Optional security settings</span></span>
|
||
|
|
<span id="cb14-13"><a href="#cb14-13"></a><span class="dt">PrivateTmp</span><span class="ot">=</span><span class="kw">true</span></span>
|
||
|
|
<span id="cb14-14"><a href="#cb14-14"></a><span class="dt">ProtectSystem</span><span class="ot">=</span><span class="st">strict</span></span>
|
||
|
|
<span id="cb14-15"><a href="#cb14-15"></a><span class="dt">ProtectHome</span><span class="ot">=</span><span class="kw">true</span></span>
|
||
|
|
<span id="cb14-16"><a href="#cb14-16"></a><span class="dt">PrivateDevices</span><span class="ot">=</span><span class="kw">true</span></span>
|
||
|
|
<span id="cb14-17"><a href="#cb14-17"></a><span class="dt">ProtectKernelTunables</span><span class="ot">=</span><span class="kw">true</span></span>
|
||
|
|
<span id="cb14-18"><a href="#cb14-18"></a><span class="dt">ProtectKernelModules</span><span class="ot">=</span><span class="kw">true</span></span>
|
||
|
|
<span id="cb14-19"><a href="#cb14-19"></a><span class="dt">ProtectControlGroups</span><span class="ot">=</span><span class="kw">true</span></span>
|
||
|
|
<span id="cb14-20"><a href="#cb14-20"></a><span class="dt">NoNewPrivileges</span><span class="ot">=</span><span class="kw">true</span></span>
|
||
|
|
<span id="cb14-21"><a href="#cb14-21"></a><span class="dt">ReadWritePaths</span><span class="ot">=</span><span class="st">/var/lib/radicale/collections</span></span>
|
||
|
|
<span id="cb14-22"><a href="#cb14-22"></a></span>
|
||
|
|
<span id="cb14-23"><a href="#cb14-23"></a><span class="kw">[Install]</span></span>
|
||
|
|
<span id="cb14-24"><a href="#cb14-24"></a><span class="dt">WantedBy</span><span class="ot">=</span><span class="st">multi-user.target</span></span></code></pre></div>
|
||
|
|
<p>Radicale will load the configuration file from <code>/etc/radicale/config</code>.</p>
|
||
|
|
<p>To enable and manage the service run:</p>
|
||
|
|
<div class="sourceCode" id="cb15"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb15-1"><a href="#cb15-1"></a><span class="co"># Enable the service</span></span>
|
||
|
|
<span id="cb15-2"><a href="#cb15-2"></a>$ <span class="ex">systemctl</span> enable radicale</span>
|
||
|
|
<span id="cb15-3"><a href="#cb15-3"></a><span class="co"># Start the service</span></span>
|
||
|
|
<span id="cb15-4"><a href="#cb15-4"></a>$ <span class="ex">systemctl</span> start radicale</span>
|
||
|
|
<span id="cb15-5"><a href="#cb15-5"></a><span class="co"># Check the status of the service</span></span>
|
||
|
|
<span id="cb15-6"><a href="#cb15-6"></a>$ <span class="ex">systemctl</span> status radicale</span>
|
||
|
|
<span id="cb15-7"><a href="#cb15-7"></a><span class="co"># View all log messages</span></span>
|
||
|
|
<span id="cb15-8"><a href="#cb15-8"></a>$ <span class="ex">journalctl</span> --unit radicale.service</span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/basic-setup/macos-with-launchd">
|
||
|
|
<h4>MacOS with launchd <a class="headerlink" href="#documentation/basic-setup/macos-with-launchd">¶</a></h4>
|
||
|
|
<p><em>To be written.</em></p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/basic-setup/classic-daemonization">
|
||
|
|
<h4>Classic daemonization <a class="headerlink" href="#documentation/basic-setup/classic-daemonization">¶</a></h4>
|
||
|
|
<p>Set the configuration option <code>daemon</code> in the section <code>server</code> to <code>True</code>. You may want to set the option <code>pid</code> to the path of a PID file.</p>
|
||
|
|
<p>After daemonization the server will not log anything. You have to configure <a href="#documentation/logging">Logging</a>.</p>
|
||
|
|
<p>If you start Radicale now, it will initialize and fork into the background. The main process exits, after the PID file is written.</p>
|
||
|
|
<p><strong>Security:</strong> You can set the <strong>umask</strong> with <code>umask 0027</code> before you start the daemon, to protect your calendar data and log files from other users. Don't forget to set permissions of files that are already created!</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/basic-setup/windows-with-nssm---the-non-sucking-service-manager">
|
||
|
|
<h4>Windows with "NSSM - the Non-Sucking Service Manager" <a class="headerlink" href="#documentation/basic-setup/windows-with-nssm---the-non-sucking-service-manager">¶</a></h4>
|
||
|
|
<p>First install <a href="https://nssm.cc/">NSSM</a> and start <code>nssm install</code> in a command prompt. Apply the following configuration:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Service name: <code>Radicale</code></li>
|
||
|
|
<li>Application
|
||
|
|
<ul>
|
||
|
|
<li>Path: <code>C:\Path\To\Python\python.exe</code></li>
|
||
|
|
<li>Arguments: <code>-m radicale --config C:\Path\To\Config</code></li>
|
||
|
|
</ul></li>
|
||
|
|
<li>I/O redirection
|
||
|
|
<ul>
|
||
|
|
<li>Error: <code>C:\Path\To\Radicale.log</code></li>
|
||
|
|
</ul></li>
|
||
|
|
</ul>
|
||
|
|
<p><strong>Security:</strong> Be aware that the service runs in the local system account, you might want to change this. Managing user accounts is beyond the scope of this manual. Also make sure that the storage folder and log file is not readable by unauthorized users.</p>
|
||
|
|
<p>The log file might grow very big over time, you can configure file rotation in <strong>NSSM</strong> to prevent this.</p>
|
||
|
|
<p>The service is configured to start automatically when the computer starts. To start the service manually open <strong>Services</strong> in <strong>Computer Management</strong> and start the <strong>Radicale</strong> service.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/reverse-proxy">
|
||
|
|
<h3>Reverse Proxy <a class="headerlink" href="#documentation/reverse-proxy">¶</a></h3>
|
||
|
|
<p>When a reverse proxy is used, the path at which Radicale is available must be provided via the <code>X-Script-Name</code> header. The proxy must remove the location from the URL path that is forwarded to Radicale.</p>
|
||
|
|
<p>Example <strong>nginx</strong> configuration:</p>
|
||
|
|
<pre class="nginx"><code>location /radicale/ { # The trailing / is important!
|
||
|
|
proxy_pass http://localhost:5232/; # The / is important!
|
||
|
|
proxy_set_header X-Script-Name /radicale;
|
||
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
|
|
proxy_pass_header Authorization;
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
<p>Example <strong>Apache</strong> configuration:</p>
|
||
|
|
<div class="sourceCode" id="cb17"><pre class="sourceCode apache"><code class="sourceCode apache"><span id="cb17-1"><a href="#cb17-1"></a><span class="ex">RewriteEngine</span><span class="ch"> </span><span class="kw">On</span></span>
|
||
|
|
<span id="cb17-2"><a href="#cb17-2"></a>RewriteRule<span class="st"> ^/radicale$ /radicale/ [R,L]</span></span>
|
||
|
|
<span id="cb17-3"><a href="#cb17-3"></a></span>
|
||
|
|
<span id="cb17-4"><a href="#cb17-4"></a><span class="fu"><Location</span><span class="at"> "/radicale/"</span><span class="fu">></span></span>
|
||
|
|
<span id="cb17-5"><a href="#cb17-5"></a> ProxyPass<span class="st"> http://localhost:5232/ retry=0</span></span>
|
||
|
|
<span id="cb17-6"><a href="#cb17-6"></a> ProxyPassReverse<span class="st"> http://localhost:5232/</span></span>
|
||
|
|
<span id="cb17-7"><a href="#cb17-7"></a> RequestHeader<span class="st"> set X-Script-Name /radicale/</span></span>
|
||
|
|
<span id="cb17-8"><a href="#cb17-8"></a><span class="fu"></Location></span></span></code></pre></div>
|
||
|
|
<p>Be reminded that Radicale's default configuration enforces limits on the maximum number of parallel connections, the maximum file size and the rate of incorrect authentication attempts. Connections are terminated after a timeout.</p>
|
||
|
|
<section class="level4" id="documentation/reverse-proxy/manage-user-accounts-with-the-reverse-proxy">
|
||
|
|
<h4>Manage user accounts with the reverse proxy <a class="headerlink" href="#documentation/reverse-proxy/manage-user-accounts-with-the-reverse-proxy">¶</a></h4>
|
||
|
|
<p>Set the configuration option <code>type</code> in the <code>auth</code> section to <code>http_x_remote_user</code>. Radicale uses the user name provided in the <code>X-Remote-User</code> HTTP header and disables HTTP authentication.</p>
|
||
|
|
<p>Example <strong>nginx</strong> configuration:</p>
|
||
|
|
<pre class="nginx"><code>location /radicale/ {
|
||
|
|
proxy_pass http://localhost:5232/;
|
||
|
|
proxy_set_header X-Script-Name /radicale;
|
||
|
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
|
|
proxy_set_header X-Remote-User $remote_user;
|
||
|
|
auth_basic "Radicale - Password Required";
|
||
|
|
auth_basic_user_file /etc/nginx/htpasswd;
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
<p>Example <strong>Apache</strong> configuration:</p>
|
||
|
|
<div class="sourceCode" id="cb19"><pre class="sourceCode apache"><code class="sourceCode apache"><span id="cb19-1"><a href="#cb19-1"></a><span class="ex">RewriteEngine</span><span class="ch"> </span><span class="kw">On</span></span>
|
||
|
|
<span id="cb19-2"><a href="#cb19-2"></a>RewriteRule<span class="st"> ^/radicale$ /radicale/ [R,L]</span></span>
|
||
|
|
<span id="cb19-3"><a href="#cb19-3"></a></span>
|
||
|
|
<span id="cb19-4"><a href="#cb19-4"></a><span class="fu"><Location</span><span class="at"> "/radicale/"</span><span class="fu">></span></span>
|
||
|
|
<span id="cb19-5"><a href="#cb19-5"></a> <span class="ex">AuthType</span><span class="ch"> </span><span class="kw">Basic</span></span>
|
||
|
|
<span id="cb19-6"><a href="#cb19-6"></a> AuthName<span class="st"> "Radicale - Password Required"</span></span>
|
||
|
|
<span id="cb19-7"><a href="#cb19-7"></a> AuthUserFile<span class="st"> "/etc/radicale/htpasswd"</span></span>
|
||
|
|
<span id="cb19-8"><a href="#cb19-8"></a> Require<span class="st"> valid-user</span></span>
|
||
|
|
<span id="cb19-9"><a href="#cb19-9"></a></span>
|
||
|
|
<span id="cb19-10"><a href="#cb19-10"></a> ProxyPass<span class="st"> http://localhost:5232/ retry=0</span></span>
|
||
|
|
<span id="cb19-11"><a href="#cb19-11"></a> ProxyPassReverse<span class="st"> http://localhost:5232/</span></span>
|
||
|
|
<span id="cb19-12"><a href="#cb19-12"></a> RequestHeader<span class="st"> set X-Script-Name /radicale/</span></span>
|
||
|
|
<span id="cb19-13"><a href="#cb19-13"></a> RequestHeader<span class="st"> set X-Remote-User expr=%{REMOTE_USER}</span></span>
|
||
|
|
<span id="cb19-14"><a href="#cb19-14"></a><span class="fu"></Location></span></span></code></pre></div>
|
||
|
|
<p><strong>Security:</strong> Untrusted clients should not be able to access the Radicale server directly. Otherwise, they can authenticate as any user.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/reverse-proxy/secure-connection-between-radicale-and-the-reverse-proxy">
|
||
|
|
<h4>Secure connection between Radicale and the reverse proxy <a class="headerlink" href="#documentation/reverse-proxy/secure-connection-between-radicale-and-the-reverse-proxy">¶</a></h4>
|
||
|
|
<p>SSL certificates can be used to encrypt and authenticate the connection between Radicale and the reverse proxy. First you have to generate a certificate for Radicale and a certificate for the reverse proxy. The following commands generate self-signed certificates. You will be asked to enter additional information about the certificate, the values don't matter and you can keep the defaults.</p>
|
||
|
|
<div class="sourceCode" id="cb20"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb20-1"><a href="#cb20-1"></a>$ <span class="ex">openssl</span> req -x509 -newkey rsa:4096 -keyout server_key.pem -out server_cert.pem -nodes -days 9999</span>
|
||
|
|
<span id="cb20-2"><a href="#cb20-2"></a>$ <span class="ex">openssl</span> req -x509 -newkey rsa:4096 -keyout client_key.pem -out client_cert.pem -nodes -days 9999</span></code></pre></div>
|
||
|
|
<p>Use the following configuration for Radicale:</p>
|
||
|
|
<div class="sourceCode" id="cb21"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb21-1"><a href="#cb21-1"></a><span class="kw">[server]</span></span>
|
||
|
|
<span id="cb21-2"><a href="#cb21-2"></a><span class="dt">ssl </span><span class="ot">=</span><span class="st"> </span><span class="kw">True</span></span>
|
||
|
|
<span id="cb21-3"><a href="#cb21-3"></a><span class="dt">certificate </span><span class="ot">=</span><span class="st"> /path/to/server_cert.pem</span></span>
|
||
|
|
<span id="cb21-4"><a href="#cb21-4"></a><span class="dt">key </span><span class="ot">=</span><span class="st"> /path/to/server_key.pem</span></span>
|
||
|
|
<span id="cb21-5"><a href="#cb21-5"></a><span class="dt">certificate_authority </span><span class="ot">=</span><span class="st"> /path/to/client_cert.pem</span></span></code></pre></div>
|
||
|
|
<p>Example <strong>nginx</strong> configuration:</p>
|
||
|
|
<pre class="nginx"><code>location /radicale/ {
|
||
|
|
proxy_pass https://localhost:5232/;
|
||
|
|
...
|
||
|
|
# Place the files somewhere nginx is allowed to access (e.g. /etc/nginx/...).
|
||
|
|
proxy_ssl_certificate /path/to/client_cert.pem;
|
||
|
|
proxy_ssl_certificate_key /path/to/client_key.pem;
|
||
|
|
proxy_ssl_trusted_certificate /path/to/server_cert.pem;
|
||
|
|
}
|
||
|
|
</code></pre>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/wsgi">
|
||
|
|
<h3>WSGI <a class="headerlink" href="#documentation/wsgi">¶</a></h3>
|
||
|
|
<p>Radicale is compatible with the WSGI specification.</p>
|
||
|
|
<p>A configuration file can be set with the <code>RADICALE_CONFIG</code> environment variable, otherwise no configuration file is loaded and the default configuration is used.</p>
|
||
|
|
<p>Be reminded that Radicale's default configuration enforces limits on the maximum upload file size.</p>
|
||
|
|
<p><strong>Security:</strong> The <code>None</code> authentication type disables all rights checking. Don't use it with <code>REMOTE_USER</code>. Use <code>remote_user</code> instead.</p>
|
||
|
|
<p>Example <strong>uWSGI</strong> configuration:</p>
|
||
|
|
<div class="sourceCode" id="cb23"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb23-1"><a href="#cb23-1"></a><span class="kw">[uwsgi]</span></span>
|
||
|
|
<span id="cb23-2"><a href="#cb23-2"></a><span class="dt">http-socket </span><span class="ot">=</span><span class="st"> </span><span class="dv">127</span><span class="st">.</span><span class="dv">0</span><span class="st">.</span><span class="fl">0.1</span><span class="st">:</span><span class="dv">5232</span></span>
|
||
|
|
<span id="cb23-3"><a href="#cb23-3"></a><span class="dt">processes </span><span class="ot">=</span><span class="st"> </span><span class="dv">8</span></span>
|
||
|
|
<span id="cb23-4"><a href="#cb23-4"></a><span class="dt">plugin </span><span class="ot">=</span><span class="st"> python3</span></span>
|
||
|
|
<span id="cb23-5"><a href="#cb23-5"></a><span class="dt">module </span><span class="ot">=</span><span class="st"> radicale</span></span>
|
||
|
|
<span id="cb23-6"><a href="#cb23-6"></a><span class="dt">env </span><span class="ot">=</span><span class="st"> RADICALE_CONFIG=/etc/radicale/config</span></span></code></pre></div>
|
||
|
|
<p>Example <strong>Gunicorn</strong> configuration:</p>
|
||
|
|
<div class="sourceCode" id="cb24"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb24-1"><a href="#cb24-1"></a><span class="ex">gunicorn</span> --bind <span class="st">'127.0.0.1:5232'</span> --workers 8 --env <span class="st">'RADICALE_CONFIG=/etc/radicale/config'</span> radicale</span></code></pre></div>
|
||
|
|
<section class="level4" id="documentation/wsgi/manage-user-accounts-with-the-wsgi-server">
|
||
|
|
<h4>Manage user accounts with the WSGI server <a class="headerlink" href="#documentation/wsgi/manage-user-accounts-with-the-wsgi-server">¶</a></h4>
|
||
|
|
<p>Set the configuration option <code>type</code> in the <code>auth</code> section to <code>remote_user</code>. Radicale uses the user name provided by the WSGI server and disables authentication over HTTP.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/versioning">
|
||
|
|
<h3>Versioning <a class="headerlink" href="#documentation/versioning">¶</a></h3>
|
||
|
|
<p>This page describes how to keep track of all changes to calendars and address books with <strong>git</strong> (or any other version control system).</p>
|
||
|
|
<p>The repository must be initialized by running <code>git init</code> in the file system folder. Internal files of Radicale can be excluded by creating the file <code>.gitignore</code> with the following content:</p>
|
||
|
|
<pre><code>.Radicale.cache
|
||
|
|
.Radicale.lock
|
||
|
|
.Radicale.tmp-*
|
||
|
|
</code></pre>
|
||
|
|
<p>The configuration option <code>hook</code> in the <code>storage</code> section must be set to the following command:</p>
|
||
|
|
<div class="sourceCode" id="cb26"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb26-1"><a href="#cb26-1"></a><span class="fu">git</span> add -A <span class="kw">&&</span> <span class="kw">(</span><span class="fu">git</span> diff --cached --quiet <span class="kw">||</span> <span class="fu">git</span> commit -m <span class="st">"Changes by "</span>%(user<span class="kw">)</span><span class="ex">s</span>)</span></code></pre></div>
|
||
|
|
<p>The command gets executed after every change to the storage and commits the changes into the <strong>git</strong> repository.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/clients">
|
||
|
|
<h3>Clients <a class="headerlink" href="#documentation/clients">¶</a></h3>
|
||
|
|
<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://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 Thunderbird</a> with <a href="https://addons.mozilla.org/thunderbird/addon/cardbook/">CardBook</a> and <a href="https://www.mozilla.org/projects/calendar/">Lightning</a></li>
|
||
|
|
<li><a href="https://www.inf-it.com/open-source/clients/infcloud/">InfCloud</a>, <a href="https://www.inf-it.com/open-source/clients/caldavzap/">CalDavZAP</a> and <a href="https://www.inf-it.com/open-source/clients/carddavmate/">CardDavMATE</a></li>
|
||
|
|
</ul>
|
||
|
|
<p>Many clients do not support the creation of new calendars and address books. You can use Radicale's web interface (e.g. <a href="http://localhost:5232">http://localhost:5232</a>) to create and manage collections.</p>
|
||
|
|
<p>In some clients you can just enter the URL of the Radicale server (e.g. <code>http://localhost:5232</code>) and your user name. In others, you have to enter the URL of the collection directly (e.g. <code>http://localhost:5232/user/calendar</code>).</p>
|
||
|
|
<section class="level4" id="documentation/clients/davx⁵">
|
||
|
|
<h4>DAVx⁵ <a class="headerlink" href="#documentation/clients/davx⁵">¶</a></h4>
|
||
|
|
<p>Enter the URL of the Radicale server (e.g. <code>http://localhost:5232</code>) and your user name. DAVx⁵ will show all existing calendars and address books and you can create new.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/clients/gnome-calendar-contacts-and-evolution">
|
||
|
|
<h4>GNOME Calendar, Contacts and Evolution <a class="headerlink" href="#documentation/clients/gnome-calendar-contacts-and-evolution">¶</a></h4>
|
||
|
|
<p><strong>GNOME Calendar</strong> and <strong>Contacts</strong> do not support adding WebDAV calendars and address books directly, but you can add them in <strong>Evolution</strong>.</p>
|
||
|
|
<p>In <strong>Evolution</strong> add a new calendar and address book respectively with WebDAV. Enter the URL of the Radicale server (e.g. <code>http://localhost:5232</code>) and your user name. Clicking on the search button will list the existing calendars and address books.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/clients/thunderbird">
|
||
|
|
<h4>Thunderbird <a class="headerlink" href="#documentation/clients/thunderbird">¶</a></h4>
|
||
|
|
<section class="level5" id="documentation/clients/thunderbird/cardbook">
|
||
|
|
<h5>CardBook <a class="headerlink" href="#documentation/clients/thunderbird/cardbook">¶</a></h5>
|
||
|
|
<p>Add a new address book on the network with CardDAV. You have to enter the full URL of the collection (e.g. <code>http://localhost:5232/user/addressbook</code>) and your user name.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/clients/thunderbird/lightning">
|
||
|
|
<h5>Lightning <a class="headerlink" href="#documentation/clients/thunderbird/lightning">¶</a></h5>
|
||
|
|
<p>Add a new calendar on the network with <code>CalDAV</code>. (Don't use <code>iCalendar (ICS)</code>!) You have to enter the full URL of the collection (e.g. <code>http://localhost:5232/user/calendar</code>). If you want to add calendars from different users on the same server, you can specify the user name in the URL (e.g. <code>http://user@localhost...</code>)</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/clients/infcloud-caldavzap-and-carddavmate">
|
||
|
|
<h4>InfCloud, CalDavZAP and CardDavMATE <a class="headerlink" href="#documentation/clients/infcloud-caldavzap-and-carddavmate">¶</a></h4>
|
||
|
|
<p>You can integrate InfCloud into Radicale's web interface with <a href="https://github.com/Unrud/RadicaleInfCloud">RadicaleInfCloud</a>. No additional configuration is required.</p>
|
||
|
|
<p>Set the URL of the Radicale server in <code>config.js</code>. If <strong>InfCloud</strong> is not hosted on the same server and port as Radicale, the browser will deny access to the Radicale server, because of the <a href="https://en.wikipedia.org/wiki/Same-origin_policy">same-origin policy</a>. You have to add additional HTTP header in the <code>headers</code> section of Radicale's configuration. The documentation of <strong>InfCloud</strong> has more details on this.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/clients/manual-creation-of-calendars-and-address-books">
|
||
|
|
<h4>Manual creation of calendars and address books <a class="headerlink" href="#documentation/clients/manual-creation-of-calendars-and-address-books">¶</a></h4>
|
||
|
|
<p>This is not the recommended way of creating and managing your calendars and address books. Use Radicale's web interface or a client with support for it (e.g. <strong>DAVx⁵</strong>).</p>
|
||
|
|
<section class="level5" id="documentation/clients/manual-creation-of-calendars-and-address-books/direct-editing-of-the-storage">
|
||
|
|
<h5>Direct editing of the storage <a class="headerlink" href="#documentation/clients/manual-creation-of-calendars-and-address-books/direct-editing-of-the-storage">¶</a></h5>
|
||
|
|
<p>To create a new collection, you have to create the corresponding folder in the file system storage (e.g. <code>collection-root/user/calendar</code>). To tell Radicale and clients that the collection is a calendar, you have to create the file <code>.Radicale.props</code> with the following content in the folder:</p>
|
||
|
|
<div class="sourceCode" id="cb27"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb27-1"><a href="#cb27-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 <code>/user/calendar</code>. For address books the file must contain:</p>
|
||
|
|
<div class="sourceCode" id="cb28"><pre class="sourceCode json"><code class="sourceCode json"><span id="cb28-1"><a href="#cb28-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 collections. Clients with automatic discovery of collections will only show calendars and addressbooks that are direct children of the path <code>/USERNAME/</code>.</p>
|
||
|
|
<p>Delete collections by deleting the corresponding folders.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/clients/manual-creation-of-calendars-and-address-books/http-requests-with-curl">
|
||
|
|
<h5>HTTP requests with curl <a class="headerlink" href="#documentation/clients/manual-creation-of-calendars-and-address-books/http-requests-with-curl">¶</a></h5>
|
||
|
|
<p>To create a new calendar run something like:</p>
|
||
|
|
<div class="sourceCode" id="cb29"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb29-1"><a href="#cb29-1"></a>$ <span class="ex">curl</span> -u user -X MKCOL <span class="st">'http://localhost:5232/user/calendar'</span> --data \</span>
|
||
|
|
<span id="cb29-2"><a href="#cb29-2"></a><span class="st">'<?xml version="1.0" encoding="UTF-8" ?></span></span>
|
||
|
|
<span id="cb29-3"><a href="#cb29-3"></a><span class="st"><create xmlns="DAV:" xmlns:C="urn:ietf:params:xml:ns:caldav" xmlns:I="http://apple.com/ns/ical/"></span></span>
|
||
|
|
<span id="cb29-4"><a href="#cb29-4"></a><span class="st"> <set></span></span>
|
||
|
|
<span id="cb29-5"><a href="#cb29-5"></a><span class="st"> <prop></span></span>
|
||
|
|
<span id="cb29-6"><a href="#cb29-6"></a><span class="st"> <resourcetype></span></span>
|
||
|
|
<span id="cb29-7"><a href="#cb29-7"></a><span class="st"> <collection /></span></span>
|
||
|
|
<span id="cb29-8"><a href="#cb29-8"></a><span class="st"> <C:calendar /></span></span>
|
||
|
|
<span id="cb29-9"><a href="#cb29-9"></a><span class="st"> </resourcetype></span></span>
|
||
|
|
<span id="cb29-10"><a href="#cb29-10"></a><span class="st"> <C:supported-calendar-component-set></span></span>
|
||
|
|
<span id="cb29-11"><a href="#cb29-11"></a><span class="st"> <C:comp name="VEVENT" /></span></span>
|
||
|
|
<span id="cb29-12"><a href="#cb29-12"></a><span class="st"> <C:comp name="VJOURNAL" /></span></span>
|
||
|
|
<span id="cb29-13"><a href="#cb29-13"></a><span class="st"> <C:comp name="VTODO" /></span></span>
|
||
|
|
<span id="cb29-14"><a href="#cb29-14"></a><span class="st"> </C:supported-calendar-component-set></span></span>
|
||
|
|
<span id="cb29-15"><a href="#cb29-15"></a><span class="st"> <displayname>Calendar</displayname></span></span>
|
||
|
|
<span id="cb29-16"><a href="#cb29-16"></a><span class="st"> <C:calendar-description>Example calendar</C:calendar-description></span></span>
|
||
|
|
<span id="cb29-17"><a href="#cb29-17"></a><span class="st"> <I:calendar-color>#ff0000ff</I:calendar-color></span></span>
|
||
|
|
<span id="cb29-18"><a href="#cb29-18"></a><span class="st"> </prop></span></span>
|
||
|
|
<span id="cb29-19"><a href="#cb29-19"></a><span class="st"> </set></span></span>
|
||
|
|
<span id="cb29-20"><a href="#cb29-20"></a><span class="st"></create>'</span></span></code></pre></div>
|
||
|
|
<p>To create a new address book run something like:</p>
|
||
|
|
<div class="sourceCode" id="cb30"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb30-1"><a href="#cb30-1"></a>$ <span class="ex">curl</span> -u user -X MKCOL <span class="st">'http://localhost:5232/user/addressbook'</span> --data \</span>
|
||
|
|
<span id="cb30-2"><a href="#cb30-2"></a><span class="st">'<?xml version="1.0" encoding="UTF-8" ?></span></span>
|
||
|
|
<span id="cb30-3"><a href="#cb30-3"></a><span class="st"><create xmlns="DAV:" xmlns:CR="urn:ietf:params:xml:ns:carddav"></span></span>
|
||
|
|
<span id="cb30-4"><a href="#cb30-4"></a><span class="st"> <set></span></span>
|
||
|
|
<span id="cb30-5"><a href="#cb30-5"></a><span class="st"> <prop></span></span>
|
||
|
|
<span id="cb30-6"><a href="#cb30-6"></a><span class="st"> <resourcetype></span></span>
|
||
|
|
<span id="cb30-7"><a href="#cb30-7"></a><span class="st"> <collection /></span></span>
|
||
|
|
<span id="cb30-8"><a href="#cb30-8"></a><span class="st"> <CR:addressbook /></span></span>
|
||
|
|
<span id="cb30-9"><a href="#cb30-9"></a><span class="st"> </resourcetype></span></span>
|
||
|
|
<span id="cb30-10"><a href="#cb30-10"></a><span class="st"> <displayname>Address book</displayname></span></span>
|
||
|
|
<span id="cb30-11"><a href="#cb30-11"></a><span class="st"> <CR:addressbook-description>Example address book</CR:addressbook-description></span></span>
|
||
|
|
<span id="cb30-12"><a href="#cb30-12"></a><span class="st"> </prop></span></span>
|
||
|
|
<span id="cb30-13"><a href="#cb30-13"></a><span class="st"> </set></span></span>
|
||
|
|
<span id="cb30-14"><a href="#cb30-14"></a><span class="st"></create>'</span></span></code></pre></div>
|
||
|
|
<p>The collection <code>/USERNAME</code> will be created automatically, when the user authenticates to Radicale for the first time. Clients with automatic discovery of collections will only show calendars and address books that are direct children of the path <code>/USERNAME/</code>.</p>
|
||
|
|
<p>Delete the collections by running something like:</p>
|
||
|
|
<div class="sourceCode" id="cb31"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb31-1"><a href="#cb31-1"></a>$ <span class="ex">curl</span> -u user -X DELETE <span class="st">'http://localhost:5232/user/calendar'</span></span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/configuration">
|
||
|
|
<h3>Configuration <a class="headerlink" href="#documentation/configuration">¶</a></h3>
|
||
|
|
<p>Radicale can be configured with a configuration file or with command line arguments.</p>
|
||
|
|
<p>An example configuration file looks like:</p>
|
||
|
|
<div class="sourceCode" id="cb32"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb32-1"><a href="#cb32-1"></a><span class="kw">[server]</span></span>
|
||
|
|
<span id="cb32-2"><a href="#cb32-2"></a><span class="co"># Bind all addresses</span></span>
|
||
|
|
<span id="cb32-3"><a href="#cb32-3"></a><span class="dt">hosts </span><span class="ot">=</span><span class="st"> </span><span class="dv">0</span><span class="st">.</span><span class="dv">0</span><span class="st">.</span><span class="fl">0.0</span><span class="st">:</span><span class="dv">5232</span></span>
|
||
|
|
<span id="cb32-4"><a href="#cb32-4"></a></span>
|
||
|
|
<span id="cb32-5"><a href="#cb32-5"></a><span class="kw">[auth]</span></span>
|
||
|
|
<span id="cb32-6"><a href="#cb32-6"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> htpasswd</span></span>
|
||
|
|
<span id="cb32-7"><a href="#cb32-7"></a><span class="dt">htpasswd_filename </span><span class="ot">=</span><span class="st"> /path/to/users</span></span>
|
||
|
|
<span id="cb32-8"><a href="#cb32-8"></a><span class="dt">htpasswd_encryption </span><span class="ot">=</span><span class="st"> bcrypt</span></span>
|
||
|
|
<span id="cb32-9"><a href="#cb32-9"></a><span class="kw">[storage]</span></span>
|
||
|
|
<span id="cb32-10"><a href="#cb32-10"></a><span class="dt">filesystem_folder </span><span class="ot">=</span><span class="st"> ~/.var/lib/radicale/collections</span></span></code></pre></div>
|
||
|
|
<p>Radicale tries to load configuration files from <code>/etc/radicale/config</code>, <code>~/.config/radicale/config</code> and the <code>RADICALE_CONFIG</code> environment variable. This behaviour can be overwritten by specifying a path with the <code>--config /path/to/config</code> command line argument.</p>
|
||
|
|
<p>The same example configuration via command line arguments looks like:</p>
|
||
|
|
<div class="sourceCode" id="cb33"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb33-1"><a href="#cb33-1"></a><span class="ex">python3</span> -m radicale --config <span class="st">""</span> --server-hosts 0.0.0.0:5232 --auth-type htpasswd --htpasswd-filename /path/to/htpasswd --htpasswd-encryption bcrypt</span></code></pre></div>
|
||
|
|
<p>The <code>--config ""</code> argument is required to stop Radicale from trying to load configuration files. Run <code>python3 -m radicale --help</code> for more information.</p>
|
||
|
|
<p>In the following, all configuration categories and options are described.</p>
|
||
|
|
<section class="level4" id="documentation/configuration/server">
|
||
|
|
<h4>server <a class="headerlink" href="#documentation/configuration/server">¶</a></h4>
|
||
|
|
<p>Most configuration options in this category are only relevant in standalone mode. All options beside <code>max_content_length</code> and <code>realm</code> are ignored, when Radicale runs via WSGI.</p>
|
||
|
|
<section class="level5" id="documentation/configuration/server/hosts">
|
||
|
|
<h5>hosts <a class="headerlink" href="#documentation/configuration/server/hosts">¶</a></h5>
|
||
|
|
<p>A comma separated list of addresses that the server will bind to.</p>
|
||
|
|
<p>Default: <code>127.0.0.1:5232</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/daemon">
|
||
|
|
<h5>daemon <a class="headerlink" href="#documentation/configuration/server/daemon">¶</a></h5>
|
||
|
|
<p>Daemonize the Radicale process. It does not reset the umask.</p>
|
||
|
|
<p>Default: <code>False</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/pid">
|
||
|
|
<h5>pid <a class="headerlink" href="#documentation/configuration/server/pid">¶</a></h5>
|
||
|
|
<p>If daemon mode is enabled, Radicale will write its PID to this file.</p>
|
||
|
|
<p>Default:</p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/max_connections">
|
||
|
|
<h5>max_connections <a class="headerlink" href="#documentation/configuration/server/max_connections">¶</a></h5>
|
||
|
|
<p>The maximum number of parallel connections. Set to <code>0</code> to disable the limit.</p>
|
||
|
|
<p>Default: <code>20</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/max_content_length">
|
||
|
|
<h5>max_content_length <a class="headerlink" href="#documentation/configuration/server/max_content_length">¶</a></h5>
|
||
|
|
<p>The maximum size of the request body. (bytes)</p>
|
||
|
|
<p>Default: <code>100000000</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/timeout">
|
||
|
|
<h5>timeout <a class="headerlink" href="#documentation/configuration/server/timeout">¶</a></h5>
|
||
|
|
<p>Socket timeout. (seconds)</p>
|
||
|
|
<p>Default: <code>30</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/ssl">
|
||
|
|
<h5>ssl <a class="headerlink" href="#documentation/configuration/server/ssl">¶</a></h5>
|
||
|
|
<p>Enable transport layer encryption.</p>
|
||
|
|
<p>Default: <code>False</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/certificate">
|
||
|
|
<h5>certificate <a class="headerlink" href="#documentation/configuration/server/certificate">¶</a></h5>
|
||
|
|
<p>Path of the SSL certifcate.</p>
|
||
|
|
<p>Default: <code>/etc/ssl/radicale.cert.pem</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/key">
|
||
|
|
<h5>key <a class="headerlink" href="#documentation/configuration/server/key">¶</a></h5>
|
||
|
|
<p>Path to the private key for SSL. Only effective if <code>ssl</code> is enabled.</p>
|
||
|
|
<p>Default: <code>/etc/ssl/radicale.key.pem</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/certificate_authority">
|
||
|
|
<h5>certificate_authority <a class="headerlink" href="#documentation/configuration/server/certificate_authority">¶</a></h5>
|
||
|
|
<p>Path to the CA certificate for validating client certificates. This can be used to secure TCP traffic between Radicale and a reverse proxy. If you want to authenticate users with client-side certificates, you also have to write an authentication plugin that extracts the user name from the certifcate.</p>
|
||
|
|
<p>Default:</p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/protocol">
|
||
|
|
<h5>protocol <a class="headerlink" href="#documentation/configuration/server/protocol">¶</a></h5>
|
||
|
|
<p>SSL protocol used. See python's ssl module for available values.</p>
|
||
|
|
<p>Default: <code>PROTOCOL_TLSv1_2</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/ciphers">
|
||
|
|
<h5>ciphers <a class="headerlink" href="#documentation/configuration/server/ciphers">¶</a></h5>
|
||
|
|
<p>Available ciphers for SSL. See python's ssl module for available ciphers.</p>
|
||
|
|
<p>Default:</p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/dns_lookup">
|
||
|
|
<h5>dns_lookup <a class="headerlink" href="#documentation/configuration/server/dns_lookup">¶</a></h5>
|
||
|
|
<p>Reverse DNS to resolve client address in logs.</p>
|
||
|
|
<p>Default: <code>True</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/server/realm">
|
||
|
|
<h5>realm <a class="headerlink" href="#documentation/configuration/server/realm">¶</a></h5>
|
||
|
|
<p>Message displayed in the client when a password is needed.</p>
|
||
|
|
<p>Default: <code>Radicale - Password Required</code></p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/configuration/encoding">
|
||
|
|
<h4>encoding <a class="headerlink" href="#documentation/configuration/encoding">¶</a></h4>
|
||
|
|
<section class="level5" id="documentation/configuration/encoding/request">
|
||
|
|
<h5>request <a class="headerlink" href="#documentation/configuration/encoding/request">¶</a></h5>
|
||
|
|
<p>Encoding for responding requests.</p>
|
||
|
|
<p>Default: <code>utf-8</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/encoding/stock">
|
||
|
|
<h5>stock <a class="headerlink" href="#documentation/configuration/encoding/stock">¶</a></h5>
|
||
|
|
<p>Encoding for storing local collections</p>
|
||
|
|
<p>Default: <code>utf-8</code></p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/configuration/auth">
|
||
|
|
<h4>auth <a class="headerlink" href="#documentation/configuration/auth">¶</a></h4>
|
||
|
|
<section class="level5" id="documentation/configuration/auth/type">
|
||
|
|
<h5>type <a class="headerlink" href="#documentation/configuration/auth/type">¶</a></h5>
|
||
|
|
<p>The method to verify usernames and passwords.</p>
|
||
|
|
<p>Available backends:</p>
|
||
|
|
<p><code>None</code> : Just allows all usernames and passwords. It also disables rights checking.</p>
|
||
|
|
<p><code>htpasswd</code> : Use an <a href="https://httpd.apache.org/docs/current/programs/htpasswd.html">Apache htpasswd file</a> to store usernames and passwords.</p>
|
||
|
|
<p><code>remote_user</code> : Takes the user name from the <code>REMOTE_USER</code> environment variable and disables HTTP authentication. This can be used to provide the user name from a WSGI server.</p>
|
||
|
|
<p><code>http_x_remote_user</code> : Takes the user name from the <code>X-Remote-User</code> HTTP header and disables HTTP authentication. This can be used to provide the user name from a reverse proxy.</p>
|
||
|
|
<p>Default: <code>None</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/auth/htpasswd_filename">
|
||
|
|
<h5>htpasswd_filename <a class="headerlink" href="#documentation/configuration/auth/htpasswd_filename">¶</a></h5>
|
||
|
|
<p>Path to the htpasswd file.</p>
|
||
|
|
<p>Default:</p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/auth/htpasswd_encryption">
|
||
|
|
<h5>htpasswd_encryption <a class="headerlink" href="#documentation/configuration/auth/htpasswd_encryption">¶</a></h5>
|
||
|
|
<p>The encryption method that is used in the htpasswd file. Use the <a href="https://httpd.apache.org/docs/current/programs/htpasswd.html">htpasswd</a> or similar to generate this files.</p>
|
||
|
|
<p>Available methods:</p>
|
||
|
|
<p><code>plain</code> : Passwords are stored in plaintext. This is obviously not secure! The htpasswd file for this can be created by hand and looks like:</p>
|
||
|
|
<pre class="htpasswd"><code>user1:password1
|
||
|
|
user2:password2
|
||
|
|
</code></pre>
|
||
|
|
<p><code>bcrypt</code> : This uses a modified version of the Blowfish stream cipher. It's very secure. The <strong>passlib</strong> python module is required for this. Additionally you may need one of the following python modules: <strong>bcrypt</strong>, <strong>py-bcrypt</strong> or <strong>bcryptor</strong>.</p>
|
||
|
|
<p><code>md5</code> : This uses an iterated md5 digest of the password with a salt. The <strong>passlib</strong> python module is required for this.</p>
|
||
|
|
<p><code>sha1</code> : Passwords are stored as SHA1 hashes. It's insecure!</p>
|
||
|
|
<p><code>ssha</code> : Passwords are stored as salted SHA1 hashes. It's insecure!</p>
|
||
|
|
<p><code>crypt</code> : This uses UNIX <a href="https://manpages.debian.org/unstable/manpages-dev/crypt.3.en.html">crypt(3)</a>. It's insecure!</p>
|
||
|
|
<p>Default: <code>bcrypt</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/auth/delay">
|
||
|
|
<h5>delay <a class="headerlink" href="#documentation/configuration/auth/delay">¶</a></h5>
|
||
|
|
<p>Average delay after failed login attempts in seconds.</p>
|
||
|
|
<p>Default: <code>1</code></p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/configuration/rights">
|
||
|
|
<h4>rights <a class="headerlink" href="#documentation/configuration/rights">¶</a></h4>
|
||
|
|
<section class="level5" id="documentation/configuration/rights/type">
|
||
|
|
<h5>type <a class="headerlink" href="#documentation/configuration/rights/type">¶</a></h5>
|
||
|
|
<p>The backend that is used to check the access rights of collections.</p>
|
||
|
|
<p>The recommended backend is <code>owner_only</code>. If access to calendars and address books outside of the home directory of users (that's <code>/USERNAME/</code>) is granted, clients won't detect these collections and will not show them to the user. Choosing any other method is only useful if you access calendars and address books directly via URL.</p>
|
||
|
|
<p>Available backends:</p>
|
||
|
|
<p><code>None</code> : Everyone can read and write everything.</p>
|
||
|
|
<p><code>authenticated</code> : Authenticated users can read and write everything.</p>
|
||
|
|
<p><code>owner_only</code> : Authenticated users can read and write their own collections under the path <em>/USERNAME/</em>.</p>
|
||
|
|
<p><code>owner_write</code> : Authenticated users can read everything and write their own collections under the path <em>/USERNAME/</em>.</p>
|
||
|
|
<p><code>from_file</code> : Load the rules from a file.</p>
|
||
|
|
<p>Default: <code>owner_only</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/rights/file">
|
||
|
|
<h5>file <a class="headerlink" href="#documentation/configuration/rights/file">¶</a></h5>
|
||
|
|
<p>File for the rights backend <code>from_file</code>. See the <a href="#documentation/authentication-and-rights">Rights</a> page.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/configuration/storage">
|
||
|
|
<h4>storage <a class="headerlink" href="#documentation/configuration/storage">¶</a></h4>
|
||
|
|
<section class="level5" id="documentation/configuration/storage/type">
|
||
|
|
<h5>type <a class="headerlink" href="#documentation/configuration/storage/type">¶</a></h5>
|
||
|
|
<p>The backend that is used to store data.</p>
|
||
|
|
<p>Available backends:</p>
|
||
|
|
<p><code>multifilesystem</code> : Stores the data in the filesystem.</p>
|
||
|
|
<p>Default: <code>multifilesystem</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/storage/filesystem_folder">
|
||
|
|
<h5>filesystem_folder <a class="headerlink" href="#documentation/configuration/storage/filesystem_folder">¶</a></h5>
|
||
|
|
<p>Folder for storing local collections, created if not present.</p>
|
||
|
|
<p>Default: <code>/var/lib/radicale/collections</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/storage/filesystem_locking">
|
||
|
|
<h5>filesystem_locking <a class="headerlink" href="#documentation/configuration/storage/filesystem_locking">¶</a></h5>
|
||
|
|
<p>Lock the storage. This must be disabled if locking is not supported by the underlying file system. Never start multiple instances of Radicale or edit the storage externally while Radicale is running if disabled.</p>
|
||
|
|
<p>Default: <code>True</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/storage/max_sync_token_age">
|
||
|
|
<h5>max_sync_token_age <a class="headerlink" href="#documentation/configuration/storage/max_sync_token_age">¶</a></h5>
|
||
|
|
<p>Delete sync-token that are older than the specified time. (seconds)</p>
|
||
|
|
<p>Default: <code>2592000</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/storage/filesystem_fsync">
|
||
|
|
<h5>filesystem_fsync <a class="headerlink" href="#documentation/configuration/storage/filesystem_fsync">¶</a></h5>
|
||
|
|
<p>Sync all changes to disk during requests. (This can impair performance.) Disabling it increases the risk of data loss, when the system crashes or power fails!</p>
|
||
|
|
<p>Default: <code>True</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/storage/hook">
|
||
|
|
<h5>hook <a class="headerlink" href="#documentation/configuration/storage/hook">¶</a></h5>
|
||
|
|
<p>Command that is run after changes to storage. Take a look at the <a href="#documentation/versioning">Versioning</a> page for an example.</p>
|
||
|
|
<p>Default:</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/configuration/web">
|
||
|
|
<h4>web <a class="headerlink" href="#documentation/configuration/web">¶</a></h4>
|
||
|
|
<section class="level5" id="documentation/configuration/web/type">
|
||
|
|
<h5>type <a class="headerlink" href="#documentation/configuration/web/type">¶</a></h5>
|
||
|
|
<p>The backend that provides the web interface of Radicale.</p>
|
||
|
|
<p>Available backends:</p>
|
||
|
|
<p><code>none</code> : Just shows the message "Radicale works!".</p>
|
||
|
|
<p><code>internal</code> : Allows creation and management of address books and calendars.</p>
|
||
|
|
<p>Default: <code>internal</code></p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/configuration/logging">
|
||
|
|
<h4>logging <a class="headerlink" href="#documentation/configuration/logging">¶</a></h4>
|
||
|
|
<section class="level5" id="documentation/configuration/logging/debug">
|
||
|
|
<h5>debug <a class="headerlink" href="#documentation/configuration/logging/debug">¶</a></h5>
|
||
|
|
<p>Set the default logging level to debug.</p>
|
||
|
|
<p>Default: <code>False</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/logging/full_environment">
|
||
|
|
<h5>full_environment <a class="headerlink" href="#documentation/configuration/logging/full_environment">¶</a></h5>
|
||
|
|
<p>Log all environment variables (including those set in the shell).</p>
|
||
|
|
<p>Default: <code>False</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/logging/mask_passwords">
|
||
|
|
<h5>mask_passwords <a class="headerlink" href="#documentation/configuration/logging/mask_passwords">¶</a></h5>
|
||
|
|
<p>Don't include passwords in logs.</p>
|
||
|
|
<p>Default: <code>True</code></p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/configuration/logging/config">
|
||
|
|
<h5>config <a class="headerlink" href="#documentation/configuration/logging/config">¶</a></h5>
|
||
|
|
<p>Logging configuration file. See the <a href="#documentation/logging">Logging</a> page.</p>
|
||
|
|
<p>Default:</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/configuration/headers">
|
||
|
|
<h4>headers <a class="headerlink" href="#documentation/configuration/headers">¶</a></h4>
|
||
|
|
<p>In this section additional HTTP headers that are sent to clients can be specified.</p>
|
||
|
|
<p>An example to relax the same-origin policy:</p>
|
||
|
|
<div class="sourceCode" id="cb35"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb35-1"><a href="#cb35-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="level3" id="documentation/authentication-and-rights">
|
||
|
|
<h3>Authentication and Rights <a class="headerlink" href="#documentation/authentication-and-rights">¶</a></h3>
|
||
|
|
<p>This page describes the format of the rights file for the <code>from_file</code> authentication backend. The configuration option <code>file</code> in the <code>rights</code> section must point to the rights file.</p>
|
||
|
|
<p>The recommended rights method is <code>owner_only</code>. If access to calendars and address books outside of the home directory of users (that's <code>/USERNAME/</code>) is granted, clients won't detect these collections and will not show them to the user. This is only useful if you access calendars and address books directly via URL.</p>
|
||
|
|
<p>An example rights file:</p>
|
||
|
|
<div class="sourceCode" id="cb36"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb36-1"><a href="#cb36-1"></a><span class="co"># The user "admin" can read and write any collection.</span></span>
|
||
|
|
<span id="cb36-2"><a href="#cb36-2"></a><span class="kw">[admin]</span></span>
|
||
|
|
<span id="cb36-3"><a href="#cb36-3"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> admin</span></span>
|
||
|
|
<span id="cb36-4"><a href="#cb36-4"></a><span class="dt">collection </span><span class="ot">=</span><span class="st"> .*</span></span>
|
||
|
|
<span id="cb36-5"><a href="#cb36-5"></a><span class="dt">permission </span><span class="ot">=</span><span class="st"> rw</span></span>
|
||
|
|
<span id="cb36-6"><a href="#cb36-6"></a></span>
|
||
|
|
<span id="cb36-7"><a href="#cb36-7"></a><span class="co"># Block access for the user "user" to everything.</span></span>
|
||
|
|
<span id="cb36-8"><a href="#cb36-8"></a><span class="kw">[block]</span></span>
|
||
|
|
<span id="cb36-9"><a href="#cb36-9"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> user</span></span>
|
||
|
|
<span id="cb36-10"><a href="#cb36-10"></a><span class="dt">collection </span><span class="ot">=</span><span class="st"> .*</span></span>
|
||
|
|
<span id="cb36-11"><a href="#cb36-11"></a><span class="dt">permission </span><span class="ot">=</span></span>
|
||
|
|
<span id="cb36-12"><a href="#cb36-12"></a></span>
|
||
|
|
<span id="cb36-13"><a href="#cb36-13"></a><span class="co"># Authenticated users can read and write their own collections.</span></span>
|
||
|
|
<span id="cb36-14"><a href="#cb36-14"></a><span class="kw">[owner-write]</span></span>
|
||
|
|
<span id="cb36-15"><a href="#cb36-15"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> .+</span></span>
|
||
|
|
<span id="cb36-16"><a href="#cb36-16"></a><span class="dt">collection </span><span class="ot">=</span><span class="st"> %(login)s(/.*)?</span></span>
|
||
|
|
<span id="cb36-17"><a href="#cb36-17"></a><span class="dt">permission </span><span class="ot">=</span><span class="st"> rw</span></span>
|
||
|
|
<span id="cb36-18"><a href="#cb36-18"></a></span>
|
||
|
|
<span id="cb36-19"><a href="#cb36-19"></a><span class="co"># Everyone can read the root collection</span></span>
|
||
|
|
<span id="cb36-20"><a href="#cb36-20"></a><span class="kw">[read]</span></span>
|
||
|
|
<span id="cb36-21"><a href="#cb36-21"></a><span class="dt">user </span><span class="ot">=</span><span class="st"> .*</span></span>
|
||
|
|
<span id="cb36-22"><a href="#cb36-22"></a><span class="dt">collection </span><span class="ot">=</span></span>
|
||
|
|
<span id="cb36-23"><a href="#cb36-23"></a><span class="dt">permission </span><span class="ot">=</span><span class="st"> r</span></span></code></pre></div>
|
||
|
|
<p>The titles of the sections are ignored (but must be unique). The keys <code>user</code> and <code>collection</code> contain regular expressions, that are matched against the user name and the path of the collection. Permissions from the first matching section are used. If no section matches, access gets denied.</p>
|
||
|
|
<p>The user name is empty for anonymous users. Therefore, the regex <code>.+</code> only matches authenticated users and <code>.*</code> matches everyone (including anonymous users).</p>
|
||
|
|
<p>The path of the collection is separated by <code>/</code> and has no leading or trailing <code>/</code>. Therefore, the path of the root collection is empty.</p>
|
||
|
|
<p><code>%(login)s</code> gets replaced by the user name and <code>%(path)s</code> by the path of the collection. You can also get groups from the <code>user</code> regex in the <code>collection</code> regex with <code>{0}</code>, <code>{1}</code>, etc.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/storage">
|
||
|
|
<h3>Storage <a class="headerlink" href="#documentation/storage">¶</a></h3>
|
||
|
|
<p>This document describes the layout and format of the file system storage (<code>multifilesystem</code> backend).</p>
|
||
|
|
<p>It's safe to access and manipulate the data by hand or with scripts. Scripts can be invoked manually, periodically (e.g. with <a href="https://manpages.debian.org/unstable/cron/cron.8.en.html">cron</a>) or after each change to the storage with the configuration option <code>hook</code> in the <code>storage</code> section (e.g. <a href="#documentation/versioning">Git Versioning</a>).</p>
|
||
|
|
<section class="level4" id="documentation/storage/layout">
|
||
|
|
<h4>Layout <a class="headerlink" href="#documentation/storage/layout">¶</a></h4>
|
||
|
|
<p>The file system contains the following files and folders:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>.Radicale.lock</code>: The lock file for locking the storage.</li>
|
||
|
|
<li><code>collection-root</code>: This folder contains all collections and items.</li>
|
||
|
|
</ul>
|
||
|
|
<p>A collection is represented by a folder. This folder may contain the file <code>.Radicale.props</code> with all WebDAV properties of the collection encoded as <a href="https://en.wikipedia.org/wiki/JSON">JSON</a>.</p>
|
||
|
|
<p>An item is represented by a file containing the iCalendar data.</p>
|
||
|
|
<p>All files and folders, whose names start with a dot but not <code>.Radicale.</code> (internal files) are ignored.</p>
|
||
|
|
<p>If you introduce syntax errors in any of the files, all requests that access the faulty data will fail. The logging output should contain the names of the culprits.</p>
|
||
|
|
<p>Future releases of Radicale 2.x.x will store caches and sync-tokens in the <code>.Radicale.cache</code> folder inside of collections. This folder may be created or modified, while the storage is locked for shared access. In theory, it should be safe to delete the folder. Caches will be recreated automatically and clients will be told that their sync-token isn't valid anymore.</p>
|
||
|
|
<p>You may encounter files or folders that start with <code>.Radicale.tmp-</code>. Radicale uses them for atomic creation and deletion of files and folders. They should be deleted after requests are finished but it's possible that they are left behind when Radicale or the computer crashes. It's safe to delete them.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/storage/locking">
|
||
|
|
<h4>Locking <a class="headerlink" href="#documentation/storage/locking">¶</a></h4>
|
||
|
|
<p>When the data is accessed by hand or by an externally invoked script, the storage must be locked. The storage can be locked for exclusive or shared access. It prevents Radicale from reading or writing the file system. The storage is locked with exclusive access while the <code>hook</code> runs.</p>
|
||
|
|
<section class="level5" id="documentation/storage/locking/linux-shell-scripts">
|
||
|
|
<h5>Linux shell scripts <a class="headerlink" href="#documentation/storage/locking/linux-shell-scripts">¶</a></h5>
|
||
|
|
<p>Use the <a href="https://manpages.debian.org/unstable/util-linux/flock.1.en.html">flock</a> utility.</p>
|
||
|
|
<div class="sourceCode" id="cb37"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb37-1"><a href="#cb37-1"></a><span class="co"># Exclusive</span></span>
|
||
|
|
<span id="cb37-2"><a href="#cb37-2"></a>$ <span class="ex">flock</span> --exclusive /path/to/storage/.Radicale.lock COMMAND</span>
|
||
|
|
<span id="cb37-3"><a href="#cb37-3"></a><span class="co"># Shared</span></span>
|
||
|
|
<span id="cb37-4"><a href="#cb37-4"></a>$ <span class="ex">flock</span> --shared /path/to/storage/.Radicale.lock COMMAND</span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/storage/locking/linux-and-macos">
|
||
|
|
<h5>Linux and MacOS <a class="headerlink" href="#documentation/storage/locking/linux-and-macos">¶</a></h5>
|
||
|
|
<p>Use the <a href="https://manpages.debian.org/unstable/manpages-dev/flock.2.en.html">flock</a> syscall. Python provides it in the <a href="https://docs.python.org/3/library/fcntl.html#fcntl.flock">fcntl</a> module.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/storage/locking/windows">
|
||
|
|
<h5>Windows <a class="headerlink" href="#documentation/storage/locking/windows">¶</a></h5>
|
||
|
|
<p>Use <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa365202%28v=vs.85%29.aspx">LockFile</a> for exclusive access or <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa365203%28v=vs.85%29.aspx">LockFileEx</a> which also supports shared access. Setting <code>nNumberOfBytesToLockLow</code> to <code>1</code> and <code>nNumberOfBytesToLockHigh</code> to <code>0</code> works.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/logging">
|
||
|
|
<h3>Logging <a class="headerlink" href="#documentation/logging">¶</a></h3>
|
||
|
|
<p>Radicale logs to <code>stderr</code>. The verbosity of the log output can be controlled with <code>--debug</code> command line argument or the <code>debug</code> configuration option in the <code>logging</code> section.</p>
|
||
|
|
<p>This is the recommended configuration for use with modern init systems (like <strong>systemd</strong>) or if you just test Radicale in a terminal.</p>
|
||
|
|
<p>You can configure Radicale to write its logging output to files (and even rotate them). This is useful if the process daemonizes or if your chosen method of running Radicale doesn't handle logging output.</p>
|
||
|
|
<p>A logging configuration file can be specified in the <code>config</code> configuration option in the <code>logging</code> section. The file format is explained in the <a href="https://docs.python.org/3/library/logging.config.html#configuration-file-format">Python Logging Module</a>.</p>
|
||
|
|
<section class="level4" id="documentation/logging/logging-to-a-file">
|
||
|
|
<h4>Logging to a file <a class="headerlink" href="#documentation/logging/logging-to-a-file">¶</a></h4>
|
||
|
|
<p>An example configuration to write the log output to the file <code>/var/log/radicale/log</code>:</p>
|
||
|
|
<div class="sourceCode" id="cb38"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb38-1"><a href="#cb38-1"></a><span class="kw">[loggers]</span></span>
|
||
|
|
<span id="cb38-2"><a href="#cb38-2"></a><span class="dt">keys </span><span class="ot">=</span><span class="st"> root</span></span>
|
||
|
|
<span id="cb38-3"><a href="#cb38-3"></a></span>
|
||
|
|
<span id="cb38-4"><a href="#cb38-4"></a><span class="kw">[handlers]</span></span>
|
||
|
|
<span id="cb38-5"><a href="#cb38-5"></a><span class="dt">keys </span><span class="ot">=</span><span class="st"> file</span></span>
|
||
|
|
<span id="cb38-6"><a href="#cb38-6"></a></span>
|
||
|
|
<span id="cb38-7"><a href="#cb38-7"></a><span class="kw">[formatters]</span></span>
|
||
|
|
<span id="cb38-8"><a href="#cb38-8"></a><span class="dt">keys </span><span class="ot">=</span><span class="st"> full</span></span>
|
||
|
|
<span id="cb38-9"><a href="#cb38-9"></a></span>
|
||
|
|
<span id="cb38-10"><a href="#cb38-10"></a><span class="kw">[logger_root]</span></span>
|
||
|
|
<span id="cb38-11"><a href="#cb38-11"></a><span class="co"># Change this to DEBUG or INFO for higher verbosity.</span></span>
|
||
|
|
<span id="cb38-12"><a href="#cb38-12"></a><span class="dt">level </span><span class="ot">=</span><span class="st"> WARNING</span></span>
|
||
|
|
<span id="cb38-13"><a href="#cb38-13"></a><span class="dt">handlers </span><span class="ot">=</span><span class="st"> file</span></span>
|
||
|
|
<span id="cb38-14"><a href="#cb38-14"></a></span>
|
||
|
|
<span id="cb38-15"><a href="#cb38-15"></a><span class="kw">[handler_file]</span></span>
|
||
|
|
<span id="cb38-16"><a href="#cb38-16"></a><span class="dt">class </span><span class="ot">=</span><span class="st"> FileHandler</span></span>
|
||
|
|
<span id="cb38-17"><a href="#cb38-17"></a><span class="co"># Specify the output file here.</span></span>
|
||
|
|
<span id="cb38-18"><a href="#cb38-18"></a><span class="dt">args </span><span class="ot">=</span><span class="st"> ('/var/log/radicale/log',)</span></span>
|
||
|
|
<span id="cb38-19"><a href="#cb38-19"></a><span class="dt">formatter </span><span class="ot">=</span><span class="st"> full</span></span>
|
||
|
|
<span id="cb38-20"><a href="#cb38-20"></a></span>
|
||
|
|
<span id="cb38-21"><a href="#cb38-21"></a><span class="kw">[formatter_full]</span></span>
|
||
|
|
<span id="cb38-22"><a href="#cb38-22"></a><span class="dt">format </span><span class="ot">=</span><span class="st"> %(asctime)s - [%(thread)x] %(levelname)s: %(message)s</span></span></code></pre></div>
|
||
|
|
<p>You can specify multiple <strong>logger</strong>, <strong>handler</strong> and <strong>formatter</strong> if you want to have multiple simultaneous log outputs.</p>
|
||
|
|
<p>The parent folder of the log files must exist and must be writable by Radicale.</p>
|
||
|
|
<p><strong>Security:</strong> The log files should not be readable by unauthorized users. Set permissions accordingly.</p>
|
||
|
|
<section class="level5" id="documentation/logging/logging-to-a-file/timed-rotation-of-disk-log-files">
|
||
|
|
<h5>Timed rotation of disk log files <a class="headerlink" href="#documentation/logging/logging-to-a-file/timed-rotation-of-disk-log-files">¶</a></h5>
|
||
|
|
<p>An example <strong>handler</strong> configuration to write the log output to the file <code>/var/log/radicale/log</code> and rotate it. Replace the section <code>handler_file</code> from the file logging example:</p>
|
||
|
|
<div class="sourceCode" id="cb39"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb39-1"><a href="#cb39-1"></a><span class="kw">[handler_file]</span></span>
|
||
|
|
<span id="cb39-2"><a href="#cb39-2"></a><span class="dt">class </span><span class="ot">=</span><span class="st"> handlers.TimedRotatingFileHandler</span></span>
|
||
|
|
<span id="cb39-3"><a href="#cb39-3"></a><span class="co"># Specify the output file and parameter for rotation here.</span></span>
|
||
|
|
<span id="cb39-4"><a href="#cb39-4"></a><span class="co"># See https://docs.python.org/3/library/logging.handlers.html#logging.handlers.TimedRotatingFileHandler</span></span>
|
||
|
|
<span id="cb39-5"><a href="#cb39-5"></a><span class="co"># Example: rollover at midnight and keep 7 files (means one week)</span></span>
|
||
|
|
<span id="cb39-6"><a href="#cb39-6"></a><span class="dt">args </span><span class="ot">=</span><span class="st"> ('/var/log/radicale/log', 'midnight', </span><span class="dv">1</span><span class="st">, </span><span class="dv">7</span><span class="st">)</span></span>
|
||
|
|
<span id="cb39-7"><a href="#cb39-7"></a><span class="dt">formatter </span><span class="ot">=</span><span class="st"> full</span></span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="documentation/logging/logging-to-a-file/rotation-of-disk-log-files-based-on-size">
|
||
|
|
<h5>Rotation of disk log files based on size <a class="headerlink" href="#documentation/logging/logging-to-a-file/rotation-of-disk-log-files-based-on-size">¶</a></h5>
|
||
|
|
<p>An example <strong>handler</strong> configuration to write the log output to the file <code>/var/log/radicale/log</code> and rotate it . Replace the section <code>handle_file</code> from the file logging example:</p>
|
||
|
|
<div class="sourceCode" id="cb40"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb40-1"><a href="#cb40-1"></a><span class="kw">[handler_file]</span></span>
|
||
|
|
<span id="cb40-2"><a href="#cb40-2"></a><span class="dt">class </span><span class="ot">=</span><span class="st"> handlers.RotatingFileHandler</span></span>
|
||
|
|
<span id="cb40-3"><a href="#cb40-3"></a><span class="co"># Specify the output file and parameter for rotation here.</span></span>
|
||
|
|
<span id="cb40-4"><a href="#cb40-4"></a><span class="co"># See https://docs.python.org/3/library/logging.handlers.html#logging.handlers.RotatingFileHandler</span></span>
|
||
|
|
<span id="cb40-5"><a href="#cb40-5"></a><span class="co"># Example: rollover at 100000 kB and keep 10 files (means 1 MB)</span></span>
|
||
|
|
<span id="cb40-6"><a href="#cb40-6"></a><span class="dt">args </span><span class="ot">=</span><span class="st"> ('/var/log/radicale/log', 'a', </span><span class="dv">100000</span><span class="st">, </span><span class="dv">10</span><span class="st">)</span></span>
|
||
|
|
<span id="cb40-7"><a href="#cb40-7"></a><span class="dt">formatter </span><span class="ot">=</span><span class="st"> full</span></span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/architecture">
|
||
|
|
<h3>Architecture <a class="headerlink" href="#documentation/architecture">¶</a></h3>
|
||
|
|
<p>Radicale is a really small piece of software, but understanding it is not as easy as it seems. But don't worry, reading this short page is enough to understand what a CalDAV/CardDAV server is, and how Radicale's code is organized.</p>
|
||
|
|
<section class="level4" id="documentation/architecture/general-architecture">
|
||
|
|
<h4>General Architecture <a class="headerlink" href="#documentation/architecture/general-architecture">¶</a></h4>
|
||
|
|
<p>Here is a simple overview of the global architecture for reaching a calendar or an address book through network:</p>
|
||
|
|
<div class="tableContainer"><table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Part</th>
|
||
|
|
<th>Layer</th>
|
||
|
|
<th>Protocol or Format</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td rowspan="2">Server</td>
|
||
|
|
<td>Calendar/Contact Storage</td>
|
||
|
|
<td>iCal/vCard</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>Calendar/Contact Server</td>
|
||
|
|
<td>CalDAV/CardDAV Server</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>Transfer</td>
|
||
|
|
<td>Network</td>
|
||
|
|
<td>CalDAV/CardDAV (HTTP + TLS)</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td rowspan="2">Client</td>
|
||
|
|
<td>Calendar/Contact Client</td>
|
||
|
|
<td>CalDAV/CardDAV Client</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>GUI</td>
|
||
|
|
<td>Terminal, GTK, Web interface, etc.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table></div>
|
||
|
|
<p>Radicale is <strong>only the server part</strong> of this architecture.</p>
|
||
|
|
<p>Please note that:</p>
|
||
|
|
<ul>
|
||
|
|
<li>CalDAV and CardDAV are superset protocols of WebDAV,</li>
|
||
|
|
<li>WebDAV is a superset protocol of HTTP.</li>
|
||
|
|
</ul>
|
||
|
|
<p>Radicale being a CalDAV/CardDAV server, it also can be seen as a special WebDAV and HTTP server.</p>
|
||
|
|
<p>Radicale is <strong>not the client part</strong> of this architecture. It means that Radicale never draws calendars, address books, events and contacts on the screen. It only stores them and give the possibility to share them online with other people.</p>
|
||
|
|
<p>If you want to see or edit your events and your contacts, you have to use another software called a client, that can be a "normal" applications with icons and buttons, a terminal or another web application.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/architecture/code-architecture">
|
||
|
|
<h4>Code Architecture <a class="headerlink" href="#documentation/architecture/code-architecture">¶</a></h4>
|
||
|
|
<p>The <code>radicale</code> package offers 9 modules.</p>
|
||
|
|
<p><code>__main__</code> : The main module provides a simple function called run. Its main work is to read the configuration from the configuration file and from the options given in the command line; then it creates a server, according to the configuration.</p>
|
||
|
|
<p><code>__init__</code> : This is the core part of the module, with the code for the CalDAV/CardDAV server. The server inherits from a WSGIServer server class, which relies on the default HTTP server class given by Python. The code managing the different HTTP requests according to the CalDAV/CardDAV normalization is written here.</p>
|
||
|
|
<p><code>config</code> : This part gives a dict-like access to the server configuration, read from the configuration file. The configuration can be altered when launching the executable with some command line options.</p>
|
||
|
|
<p><code>xmlutils</code> : The functions defined in this module are mainly called by the CalDAV/CardDAV server class to read the XML part of the request, read or alter the calendars, and create the XML part of the response. The main part of this code relies on ElementTree.</p>
|
||
|
|
<p><code>log</code> : The start function provided by this module starts a logging mechanism based on the default Python logging module. Logging options can be stored in a logging configuration file.</p>
|
||
|
|
<p><code>auth</code> : This module provides a default authentication manager equivalent to Apache's htpasswd. Login + password couples are stored in a file and used to authenticate users. Passwords can be encrypted using various methods. Other authentication methods can inherit from the base class in this file and be provided as plugins.</p>
|
||
|
|
<p><code>rights</code> : This module is a set of Access Control Lists, a set of methods used by Radicale to manage rights to access the calendars. When the CalDAV/CardDAV server is launched, an Access Control List is chosen in the set, according to the configuration. The HTTP requests are then filtered to restrict the access depending on who is authenticated. Other configurations can be written using regex-based rules. Other rights managers can also inherit from the base class in this file and be provided as plugins.</p>
|
||
|
|
<p><code>storage</code> : In this module are written the classes representing collections and items in Radicale, and the class storing these collections and items in your filesystem. Other storage classes can inherit from the base class in this file and be provided as plugins.</p>
|
||
|
|
<p><code>web</code> : This module contains the web interface.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level3" id="documentation/plugins">
|
||
|
|
<h3>Plugins <a class="headerlink" href="#documentation/plugins">¶</a></h3>
|
||
|
|
<p>Radicale can be extended by plugins for authentication, rights management and storage. Plugins are <strong>python</strong> modules.</p>
|
||
|
|
<section class="level4" id="documentation/plugins/getting-started">
|
||
|
|
<h4>Getting started <a class="headerlink" href="#documentation/plugins/getting-started">¶</a></h4>
|
||
|
|
<p>To get started we walk through the creation of a simple authentication plugin, that accepts login attempts if the username and password are equal.</p>
|
||
|
|
<p>The easiest way to develop and install <strong>python</strong> 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 following content in an empty folder:</p>
|
||
|
|
<div class="sourceCode" id="cb41"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb41-1"><a href="#cb41-1"></a><span class="co">#!/usr/bin/env python3</span></span>
|
||
|
|
<span id="cb41-2"><a href="#cb41-2"></a></span>
|
||
|
|
<span id="cb41-3"><a href="#cb41-3"></a><span class="im">from</span> distutils.core <span class="im">import</span> setup</span>
|
||
|
|
<span id="cb41-4"><a href="#cb41-4"></a></span>
|
||
|
|
<span id="cb41-5"><a href="#cb41-5"></a>setup(name<span class="op">=</span><span class="st">"radicale_silly_auth"</span>, packages<span class="op">=</span>[<span class="st">"radicale_silly_auth"</span>])</span></code></pre></div>
|
||
|
|
<p>In the same folder create the sub-folder <code>radicale_silly_auth</code>. The folder must have the same name as specified in <code>packages</code> above.</p>
|
||
|
|
<p>Create the file <code>__init__.py</code> in the <code>radicale_silly_auth</code> folder with the following content:</p>
|
||
|
|
<div class="sourceCode" id="cb42"><pre class="sourceCode python"><code class="sourceCode python"><span id="cb42-1"><a href="#cb42-1"></a><span class="im">from</span> radicale.auth <span class="im">import</span> BaseAuth</span>
|
||
|
|
<span id="cb42-2"><a href="#cb42-2"></a></span>
|
||
|
|
<span id="cb42-3"><a href="#cb42-3"></a></span>
|
||
|
|
<span id="cb42-4"><a href="#cb42-4"></a><span class="kw">class</span> Auth(BaseAuth):</span>
|
||
|
|
<span id="cb42-5"><a href="#cb42-5"></a> <span class="kw">def</span> is_authenticated(<span class="va">self</span>, user, password):</span>
|
||
|
|
<span id="cb42-6"><a href="#cb42-6"></a> <span class="co"># Example custom configuration option</span></span>
|
||
|
|
<span id="cb42-7"><a href="#cb42-7"></a> foo <span class="op">=</span> <span class="st">""</span></span>
|
||
|
|
<span id="cb42-8"><a href="#cb42-8"></a> <span class="cf">if</span> <span class="va">self</span>.configuration.has_option(<span class="st">"auth"</span>, <span class="st">"foo"</span>):</span>
|
||
|
|
<span id="cb42-9"><a href="#cb42-9"></a> foo <span class="op">=</span> <span class="va">self</span>.configuration.get(<span class="st">"auth"</span>, <span class="st">"foo"</span>)</span>
|
||
|
|
<span id="cb42-10"><a href="#cb42-10"></a> <span class="va">self</span>.logger.info(<span class="st">"Configuration option </span><span class="sc">%r</span><span class="st"> is </span><span class="sc">%r</span><span class="st">"</span>, <span class="st">"foo"</span>, foo)</span>
|
||
|
|
<span id="cb42-11"><a href="#cb42-11"></a></span>
|
||
|
|
<span id="cb42-12"><a href="#cb42-12"></a> <span class="co"># Check authentication</span></span>
|
||
|
|
<span id="cb42-13"><a href="#cb42-13"></a> <span class="va">self</span>.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="cb42-14"><a href="#cb42-14"></a> user, password)</span>
|
||
|
|
<span id="cb42-15"><a href="#cb42-15"></a> <span class="cf">return</span> user <span class="op">==</span> password</span></code></pre></div>
|
||
|
|
<p>Install the python module by running the following command in the same folder as <code>setup.py</code>:</p>
|
||
|
|
<div class="sourceCode" id="cb43"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb43-1"><a href="#cb43-1"></a><span class="ex">python3</span> -m pip install --upgrade .</span></code></pre></div>
|
||
|
|
<p>To make use this great creation in Radicale, set the configuration option <code>type</code> in the <code>auth</code> section to <code>radicale_silly_auth</code>:</p>
|
||
|
|
<div class="sourceCode" id="cb44"><pre class="sourceCode ini"><code class="sourceCode ini"><span id="cb44-1"><a href="#cb44-1"></a><span class="kw">[auth]</span></span>
|
||
|
|
<span id="cb44-2"><a href="#cb44-2"></a><span class="dt">type </span><span class="ot">=</span><span class="st"> radicale_silly_auth</span></span>
|
||
|
|
<span id="cb44-3"><a href="#cb44-3"></a><span class="dt">foo </span><span class="ot">=</span><span class="st"> bar</span></span></code></pre></div>
|
||
|
|
<p>You can uninstall the module with:</p>
|
||
|
|
<div class="sourceCode" id="cb45"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb45-1"><a href="#cb45-1"></a><span class="ex">python3</span> -m pip uninstall radicale_silly_auth</span></code></pre></div>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/plugins/authentication-plugins">
|
||
|
|
<h4>Authentication plugins <a class="headerlink" href="#documentation/plugins/authentication-plugins">¶</a></h4>
|
||
|
|
<p>This plugin type is used to check login credentials. The module must contain a class <code>Auth</code> that extends <code>radicale.auth.BaseAuth</code>. Take a look at the file <code>radicale/auth.py</code> in Radicale's source code for more information.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/plugins/rights-management-plugins">
|
||
|
|
<h4>Rights management plugins <a class="headerlink" href="#documentation/plugins/rights-management-plugins">¶</a></h4>
|
||
|
|
<p>This plugin type is used to check if a user has access to a path. The module must contain a class <code>Rights</code> that extends <code>radicale.rights.BaseRights</code>. Take a look at the file <code>radicale/rights.py</code> in Radicale's source code for more information.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/plugins/web-plugins">
|
||
|
|
<h4>Web plugins <a class="headerlink" href="#documentation/plugins/web-plugins">¶</a></h4>
|
||
|
|
<p>This plugin type is used to provide the web interface for Radicale. The module must contain a class <code>Web</code> that extends <code>radicale.web.BaseWeb</code>. Take a look at the file <code>radicale/web.py</code> in Radicale's source code for more information.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="documentation/plugins/storage-plugins">
|
||
|
|
<h4>Storage plugins <a class="headerlink" href="#documentation/plugins/storage-plugins">¶</a></h4>
|
||
|
|
<p>This plugin is used to store collections and items. The module must contain a class <code>Collection</code> that extends <code>radicale.storage.BaseCollection</code>. Take a look at the file <code>radicale/storage.py</code> in Radicale's source code for more information.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level2" id="contribute">
|
||
|
|
<h2>Contribute <a class="headerlink" href="#contribute">¶</a></h2>
|
||
|
|
<section class="level4" id="contribute//chat-with-us-on-irc">
|
||
|
|
<h4>Chat with Us on IRC <a class="headerlink" href="#contribute//chat-with-us-on-irc">¶</a></h4>
|
||
|
|
<p>Want to say something? Join our IRC room: <code>##kozea</code> on Freenode.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="contribute//report-bugs">
|
||
|
|
<h4>Report Bugs <a class="headerlink" href="#contribute//report-bugs">¶</a></h4>
|
||
|
|
<p>Found a bug? Want a new feature? Report a new issue on the <a href="https://github.com/Kozea/Radicale/issues">Radicale bug-tracker</a>.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="contribute//hack">
|
||
|
|
<h4>Hack <a class="headerlink" href="#contribute//hack">¶</a></h4>
|
||
|
|
<p>Interested in hacking? Feel free to clone the <a href="https://github.com/Kozea/Radicale">git repository on Github</a> if you want to add new features, fix bugs or update the documentation.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="contribute//documentation">
|
||
|
|
<h4>Documentation <a class="headerlink" href="#contribute//documentation">¶</a></h4>
|
||
|
|
<p>To change or complement the documentation create a pull request to <a href="https://github.com/Kozea/Radicale/blob/master/DOCUMENTATION.md">DOCUMENTATION.md</a>.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level2" id="download">
|
||
|
|
<h2>Download <a class="headerlink" href="#download">¶</a></h2>
|
||
|
|
<section class="level4" id="download//pypi">
|
||
|
|
<h4>PyPI <a class="headerlink" href="#download//pypi">¶</a></h4>
|
||
|
|
<p>Radicale is <a href="https://pypi.python.org/pypi/Radicale/">available on PyPI</a>. To install, just type as superuser:</p>
|
||
|
|
<pre><code>$ python3 -m pip install --upgrade radicale
|
||
|
|
</code></pre>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="download//git-repository">
|
||
|
|
<h4>Git Repository <a class="headerlink" href="#download//git-repository">¶</a></h4>
|
||
|
|
<p>If you want the development version of Radicale, take a look at the <a href="https://github.com/Kozea/Radicale/">git repository on GitHub</a>, or install it directly with:</p>
|
||
|
|
<pre><code>$ python3 -m pip install --upgrade git+https://github.com/Kozea/Radicale
|
||
|
|
</code></pre>
|
||
|
|
<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 class="level4" id="download//source-packages">
|
||
|
|
<h4>Source Packages <a class="headerlink" href="#download//source-packages">¶</a></h4>
|
||
|
|
<p>You can download the Radicale package for each release:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.11"><strong>2.1.11 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.10"><strong>2.1.10 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.9"><strong>2.1.9 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.8"><strong>2.1.8 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.7"><strong>2.1.7 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.6"><strong>2.1.6 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.5"><strong>2.1.5 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.4"><strong>2.1.4 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.3"><strong>2.1.3 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.2"><strong>2.1.2 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/1.1.6"><strong>1.1.6 - Sixth Law of Nature</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.1"><strong>2.1.1 - Wild Radish Again</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.0"><strong>2.1.0 - Wild Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/1.1.4"><strong>1.1.4 - Fifth Law of Nature</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.0rc3">2.1.0rc3</a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.0rc2">2.1.0rc2</a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.1.0rc1">2.1.0rc1</a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.0.0"><strong>2.0.0 - Little Big Radish</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/1.1.3"><strong>1.1.3 - Fourth Law of Nature</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.0.0rc2">2.0.0rc2</a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/1.1.2"><strong>1.1.2 - Third Law of Nature</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/2.0.0rc1">2.0.0rc1</a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/1.1.1"><strong>1.1.1 - Second Law of Nature</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/1.1"><strong>1.1 - Law of Nature</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/1.0.1"><strong>1.0.1 - Sunflower Again</strong></a></li>
|
||
|
|
<li><a href="https://api.github.com/repos/Kozea/Radicale/tarball/1.0"><strong>1.0 - Sunflower</strong></a></li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="download//linux-distribution-packages">
|
||
|
|
<h4>Linux Distribution Packages <a class="headerlink" href="#download//linux-distribution-packages">¶</a></h4>
|
||
|
|
<p>Radicale has been packaged for:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="https://aur.archlinux.org/packages/radicale/">ArchLinux (AUR)</a> by Guillaume Bouchard</li>
|
||
|
|
<li><a href="http://packages.debian.org/radicale">Debian</a> by Jonas Smedegaard</li>
|
||
|
|
<li><a href="https://packages.gentoo.org/packages/www-apps/radicale">Gentoo</a> by René Neumann, Maxim Koltsov and Manuel Rüger</li>
|
||
|
|
<li><a href="https://admin.fedoraproject.org/pkgdb/package/radicale/">Fedora</a> by Jorti</li>
|
||
|
|
<li><a href="http://madb.mageia.org/package/show/application/0/name/radicale">Mageia</a> by Jani Välimaa</li>
|
||
|
|
<li><a href="http://openports.se/productivity/radicale">OpenBSD</a> by Sergey Bronnikov, Stuart Henderson and Ian Darwin</li>
|
||
|
|
<li><a href="http://software.opensuse.org/package/Radicale?search_term=radicale">openSUSE</a> by Ákos Szőts and Rueckert</li>
|
||
|
|
<li><a href="http://code.activestate.com/pypm/radicale/">PyPM</a></li>
|
||
|
|
<li><a href="http://schoepfer.info/slackware.xhtml#packages-network">Slackware</a> by Johannes Schöpfer</li>
|
||
|
|
<li><a href="http://packages.trisquel.info/search?searchon=names&keywords=radicale">Trisquel</a></li>
|
||
|
|
<li><a href="http://packages.ubuntu.com/radicale">Ubuntu</a> by the MOTU and Jonas Smedegaard</li>
|
||
|
|
</ul>
|
||
|
|
<p>Radicale is also <a href="https://cloudron.io/button.html?app=org.radicale.cloudronapp">available on Cloudron</a> and has a Dockerfile.</p>
|
||
|
|
<p>If you are interested in creating packages for other Linux distributions, read the <a href="#contribute">"Contribute" page</a>.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level2" id="about">
|
||
|
|
<h2>About <a class="headerlink" href="#about">¶</a></h2>
|
||
|
|
<section class="level4" id="about//main-goals">
|
||
|
|
<h4>Main Goals <a class="headerlink" href="#about//main-goals">¶</a></h4>
|
||
|
|
<p>Radicale is a complete calendar and contact storing and manipulating solution. It can store multiple calendars and multiple address books.</p>
|
||
|
|
<p>Calendar and contact manipulation is available from both local and distant accesses, possibly limited through authentication policies.</p>
|
||
|
|
<p>It aims to be a lightweight solution, easy to use, easy to install, easy to configure. As a consequence, it requires few software dependencies and is pre-configured to work out-of-the-box.</p>
|
||
|
|
<p>Radicale is written in Python. It runs on most of the UNIX-like platforms (Linux, *BSD, macOS) and Windows. It is free and open-source software.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="about//what-radicale-will-never-be">
|
||
|
|
<h4>What Radicale Will Never Be <a class="headerlink" href="#about//what-radicale-will-never-be">¶</a></h4>
|
||
|
|
<p>Radicale is a server, not a client. No interfaces will be created to work with the server, as it is a really (really really) much more difficult task.</p>
|
||
|
|
<p>CalDAV and CardDAV are not perfect protocols. We think that their main problem is their complexity, that is why we decided not to implement the whole standard but just enough to understand some of its client-side implementations.</p>
|
||
|
|
<p>CalDAV and CardDAV are the best open standards available and they are quite widely used by both clients and servers. We decided to use it, and we will not use another one.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level4" id="about//technical-choices">
|
||
|
|
<h4>Technical Choices <a class="headerlink" href="#about//technical-choices">¶</a></h4>
|
||
|
|
<p>Important global development choices have been decided before writing code. They are very useful to understand why the Radicale Project is different from other CalDAV and CardDAV servers, and why features are included or not in the code.</p>
|
||
|
|
<section class="level5" id="about//technical-choices/oriented-to-calendar-and-contact-user-agents">
|
||
|
|
<h5>Oriented to Calendar and Contact User Agents <a class="headerlink" href="#about//technical-choices/oriented-to-calendar-and-contact-user-agents">¶</a></h5>
|
||
|
|
<p>Calendar and contact servers work with calendar and contact clients, using a defined protocol. CalDAV and CardDAV are good protocols, covering lots of features and use cases, but it is quite hard to implement fully.</p>
|
||
|
|
<p>Some calendar servers have been created to follow the CalDAV and CardDAV RFCs as much as possible: <a href="http://www.davical.org/">Davical</a>, <a href="http://sabre.io/baikal/">Baïkal</a> and <a href="http://trac.calendarserver.org/">Darwin Calendar Server</a>, for example, are much more respectful of CalDAV and CardDAV and can be used with a large number of clients. They are very good choices if you want to develop and test new CalDAV clients, or if you have a possibly heterogeneous list of user agents.</p>
|
||
|
|
<p>Even if it tries it best to follow the RFCs, Radicale does not and <strong>will not</strong> blindly implements the CalDAV and CardDAV standards. It is mainly designed to support the CalDAV and CardDAV implementations of different clients.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="about//technical-choices/simple">
|
||
|
|
<h5>Simple <a class="headerlink" href="#about//technical-choices/simple">¶</a></h5>
|
||
|
|
<p>Radicale is designed to be simple to install, simple to configure, simple to use.</p>
|
||
|
|
<p>The installation is very easy, particularly with Linux: one dependency, no superuser rights needed, no configuration required, no database. Installing and launching the main script out-of-the-box, as a normal user, are often the only steps to have a simple remote calendar and contact access.</p>
|
||
|
|
<p>Contrary to other servers that are often complicated, require high privileges or need a strong configuration, the Radicale Server can (sometimes, if not often) be launched in a couple of minutes, if you follow the <a href="#documentation/tutorial">tutorial</a>.</p>
|
||
|
|
</section>
|
||
|
|
<section class="level5" id="about//technical-choices/lazy">
|
||
|
|
<h5>Lazy <a class="headerlink" href="#about//technical-choices/lazy">¶</a></h5>
|
||
|
|
<p>The CalDAV RFC defines what must be done, what can be done and what cannot be done. Many violations of the protocol are totally defined and behaviours are given in such cases.</p>
|
||
|
|
<p>Radicale often assumes that the clients are perfect and that protocol violations do not exist. That is why most of the errors in client requests have undetermined consequences for the lazy server that can reply good answers, bad answers, or even no answer.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="level4 last" id="about//history">
|
||
|
|
<h4>History <a class="headerlink" href="#about//history">¶</a></h4>
|
||
|
|
<p>Radicale has been started as a (free topic) stupid school project replacing another (assigned topic) even more stupid school project.</p>
|
||
|
|
<p>At the beginning, it was just a proof-of-concept. The main goal was to write a small, dirty and simple CalDAV server working with Lightning, using no external libraries. That's how we created a piece of code that's (quite) easy to understand, to use and to hack.</p>
|
||
|
|
<p>The <a href="https://github.com/Kozea/Radicale/commit/b1591aea">first lines</a> have been added to the SVN (!) repository as I was drinking (many) beers at the very end of 2008 (Python 2.6 and 3.0 were just released). It's now packaged for a growing number of Linux distributions.</p>
|
||
|
|
<p>And that was fun going from here to there thanks to you!</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
</main>
|
||
|
|
</html>
|