mirrors/Radicale
1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-04-05 14:17:35 +03:00
Code Issues Projects Releases Packages Wiki Activity

Lint markdown

Browse source
This commit is contained in:
Unrud 2021-12-14 00:25:31 +01:00
parent 96ba4472f9
commit c73b7466be
4 changed files with 407 additions and 428 deletions
Download patch file Download diff file Expand all files Collapse all files

4
.mdl.style Normal file
View file

@ -0,0 +1,4 @@
all
rule 'MD026', :punctuation => '.,;:!'
exclude_rule 'MD001'
exclude_rule 'MD024'

1
.mdlrc Normal file
View file

@ -0,0 +1 @@
style File.join(File.dirname(__FILE__), '.mdl.style')

171
DOCUMENTATION.md
View file

@ -1,31 +1,33 @@
# Documentation # Documentation
## Getting started ## Getting started
#### About Radicale #### About Radicale
Radicale is a small but powerful CalDAV (calendars, to-do lists) and CardDAV Radicale is a small but powerful CalDAV (calendars, to-do lists) and CardDAV
(contacts) server, that: (contacts) server, that:
* Shares calendars and contact lists through CalDAV, CardDAV and HTTP. * Shares calendars and contact lists through CalDAV, CardDAV and HTTP.
* Supports events, todos, journal entries and business cards. * Supports events, todos, journal entries and business cards.
* Works out-of-the-box, no complicated setup or configuration required. * Works out-of-the-box, no complicated setup or configuration required.
* Can limit access by authentication. * Can limit access by authentication.
* Can secure connections with TLS. * Can secure connections with TLS.
* Works with many * Works with many
[CalDAV and CardDAV clients](#supported-clients). [CalDAV and CardDAV clients](#supported-clients).
* Stores all data on the file system in a simple folder structure. * Stores all data on the file system in a simple folder structure.
* Can be extended with plugins. * Can be extended with plugins.
* Is GPLv3-licensed free software. * Is GPLv3-licensed free software.
#### Installation #### Installation
Radicale is really easy to install and works out-of-the-box. Radicale is really easy to install and works out-of-the-box.
```bash ```bash
$ python3 -m pip install --upgrade radicale python3 -m pip install --upgrade radicale
$ python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections
``` ```
When the server is launched, open http://localhost:5232/ in your browser! When the server is launched, open <http://localhost:5232> in your browser!
You can login with any username and password. You can login with any username and password.
Want more? Check the [tutorials](#tutorials) and the Want more? Check the [tutorials](#tutorials) and the
@ -37,6 +39,7 @@ Read the
[changelog on GitHub.](https://github.com/Kozea/Radicale/blob/v3/NEWS.md) [changelog on GitHub.](https://github.com/Kozea/Radicale/blob/v3/NEWS.md)
## Tutorials ## Tutorials
### Simple 5-minute setup ### Simple 5-minute setup
You want to try Radicale but only have 5 minutes free in your calendar? Let's You want to try Radicale but only have 5 minutes free in your calendar? Let's
@ -65,7 +68,7 @@ $ python3 -m pip install --upgrade radicale
$ python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections $ python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections
``` ```
Victory! Open http://localhost:5232/ in your browser! Victory! Open <http://localhost:5232> in your browser!
You can log in with any username and password. You can log in with any username and password.
#### Windows #### Windows
@ -83,7 +86,7 @@ C:\Users\User> python -m pip install --upgrade radicale
C:\Users\User> python -m radicale --storage-filesystem-folder=~/radicale/collections C:\Users\User> python -m radicale --storage-filesystem-folder=~/radicale/collections
``` ```
Victory! Open http://localhost:5232/ in your browser! Victory! Open <http://localhost:5232> in your browser!
You can log in with any username and password. You can log in with any username and password.
### Basic Configuration ### Basic Configuration
@ -213,8 +216,8 @@ requirements.
#### Linux with systemd system-wide #### Linux with systemd system-wide
Create the **radicale** user and group for the Radicale service. Create the **radicale** user and group for the Radicale service. (Run
(Run `useradd --system --user-group --home-dir / --shell /sbin/nologin radicale` as root.) `useradd --system --user-group --home-dir / --shell /sbin/nologin radicale` as root.)
The storage folder must be writable by **radicale**. (Run The storage folder must be writable by **radicale**. (Run
`mkdir -p /var/lib/radicale/collections && chown -R radicale:radicale /var/lib/radicale/collections` `mkdir -p /var/lib/radicale/collections && chown -R radicale:radicale /var/lib/radicale/collections`
as root.) as root.)
@ -250,6 +253,7 @@ ReadWritePaths=/var/lib/radicale/collections
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
``` ```
Radicale will load the configuration file from `/etc/radicale/config`. Radicale will load the configuration file from `/etc/radicale/config`.
To enable and manage the service run: To enable and manage the service run:
@ -303,11 +307,11 @@ $ journalctl --user --unit radicale.service
First install [NSSM](https://nssm.cc/) and start `nssm install` in a command First install [NSSM](https://nssm.cc/) and start `nssm install` in a command
prompt. Apply the following configuration: prompt. Apply the following configuration:
* Service name: `Radicale` * Service name: `Radicale`
* Application * Application
* Path: `C:\Path\To\Python\python.exe` * Path: `C:\Path\To\Python\python.exe`
* Arguments: `-m radicale --config C:\Path\To\Config` * Arguments: `-m radicale --config C:\Path\To\Config`
* I/O redirection * I/O redirection
* Error: `C:\Path\To\Radicale.log` * Error: `C:\Path\To\Radicale.log`
> **Security:** Be aware that the service runs in the local system account, > **Security:** Be aware that the service runs in the local system account,
@ -438,8 +442,10 @@ information about the certificate, the values don't matter and you can keep the
defaults. defaults.
```bash ```bash
$ openssl req -x509 -newkey rsa:4096 -keyout server_key.pem -out server_cert.pem -nodes -days 9999 openssl req -x509 -newkey rsa:4096 -keyout server_key.pem -out server_cert.pem \
$ openssl req -x509 -newkey rsa:4096 -keyout client_key.pem -out client_cert.pem -nodes -days 9999 -nodes -days 9999
openssl req -x509 -newkey rsa:4096 -keyout client_key.pem -out client_cert.pem \
-nodes -days 9999
``` ```
Use the following configuration for Radicale: Use the following configuration for Radicale:
@ -487,7 +493,8 @@ env = RADICALE_CONFIG=/etc/radicale/config
Example **Gunicorn** configuration: Example **Gunicorn** configuration:
```bash ```bash
gunicorn --bind '127.0.0.1:5232' --workers 8 --env 'RADICALE_CONFIG=/etc/radicale/config' radicale gunicorn --bind '127.0.0.1:5232' --env 'RADICALE_CONFIG=/etc/radicale/config' \
--workers 8 radicale
``` ```
#### Manage user accounts with the WSGI server #### Manage user accounts with the WSGI server
@ -505,7 +512,7 @@ The repository must be initialized by running `git init` in the file
system folder. Internal files of Radicale can be excluded by creating the system folder. Internal files of Radicale can be excluded by creating the
file `.gitignore` with the following content: file `.gitignore` with the following content:
``` ```gitignore
.Radicale.cache .Radicale.cache
.Radicale.lock .Radicale.lock
.Radicale.tmp-* .Radicale.tmp-*
@ -522,6 +529,7 @@ The command gets executed after every change to the storage and commits
the changes into the **git** repository. the changes into the **git** repository.
## Documentation ## Documentation
### Configuration ### Configuration
Radicale can be configured with a configuration file or with Radicale can be configured with a configuration file or with
@ -553,7 +561,9 @@ Paths that start with `?` are optional.
The same example configuration via command line arguments looks like: The same example configuration via command line arguments looks like:
```bash ```bash
python3 -m radicale --server-hosts 0.0.0.0:5232,[::]:5232 --auth-type htpasswd --auth-htpasswd-filename ~/.config/radicale/users --auth-htpasswd-encryption md5 python3 -m radicale --server-hosts 0.0.0.0:5232,[::]:5232 \
--auth-type htpasswd --auth-htpasswd-filename ~/.config/radicale/users \
--auth-htpasswd-encryption md5
``` ```
Add the argument `--config ""` to stop Radicale from loading the default Add the argument `--config ""` to stop Radicale from loading the default
@ -618,6 +628,7 @@ authentication plugin that extracts the user name from the certificate.
Default: Default:
#### encoding #### encoding
##### request ##### request
Encoding for responding requests. Encoding for responding requests.
@ -631,6 +642,7 @@ Encoding for storing local collections
Default: `utf-8` Default: `utf-8`
#### auth #### auth
##### type ##### type
The method to verify usernames and passwords. The method to verify usernames and passwords.
@ -674,6 +686,7 @@ Available methods:
`plain` `plain`
: Passwords are stored in plaintext. This is obviously not secure! : Passwords are stored in plaintext. This is obviously not secure!
The htpasswd file for this can be created by hand and looks like: The htpasswd file for this can be created by hand and looks like:
```htpasswd ```htpasswd
user1:password1 user1:password1
user2:password2 user2:password2
@ -701,6 +714,7 @@ Message displayed in the client when a password is needed.
Default: `Radicale - Password Required` Default: `Radicale - Password Required`
#### rights #### rights
##### type ##### type
The backend that is used to check the access rights of collections. The backend that is used to check the access rights of collections.
@ -735,6 +749,7 @@ File for the rights backend `from_file`. See the
[Rights](#authentication-and-rights) section. [Rights](#authentication-and-rights) section.
#### storage #### storage
##### type ##### type
The backend that is used to store data. The backend that is used to store data.
@ -745,7 +760,8 @@ Available backends:
: Stores the data in the filesystem. : Stores the data in the filesystem.
`multifilesystem_nolock` `multifilesystem_nolock`
: The `multifilesystem` backend without file-based locking. Must only be used with a single process. : The `multifilesystem` backend without file-based locking.
Must only be used with a single process.
Default: `multifilesystem` Default: `multifilesystem`
@ -769,6 +785,7 @@ Command that is run after changes to storage. Take a look at the
Default: Default:
#### web #### web
##### type ##### type
The backend that provides the web interface of Radicale. The backend that provides the web interface of Radicale.
@ -786,6 +803,7 @@ Default: `internal`
#### logging #### logging
##### level ##### level
Set the logging level. Set the logging level.
Available levels: **debug**, **info**, **warning**, **error**, **critical** Available levels: **debug**, **info**, **warning**, **error**, **critical**
@ -813,21 +831,21 @@ Access-Control-Allow-Origin = *
Radicale has been tested with: Radicale has been tested with:
* [Android](https://android.com/) with * [Android](https://android.com/) with
[DAVx⁵](https://www.davx5.com/) (formerly DAVdroid) [DAVx⁵](https://www.davx5.com/) (formerly DAVdroid)
* [GNOME Calendar](https://wiki.gnome.org/Apps/Calendar), * [GNOME Calendar](https://wiki.gnome.org/Apps/Calendar),
[Contacts](https://wiki.gnome.org/Apps/Contacts) and [Contacts](https://wiki.gnome.org/Apps/Contacts) and
[Evolution](https://wiki.gnome.org/Apps/Evolution) [Evolution](https://wiki.gnome.org/Apps/Evolution)
* [Mozilla Thunderbird](https://www.mozilla.org/thunderbird/) with * [Mozilla Thunderbird](https://www.mozilla.org/thunderbird/) with
[CardBook](https://addons.mozilla.org/thunderbird/addon/cardbook/) and [CardBook](https://addons.mozilla.org/thunderbird/addon/cardbook/) and
[Lightning](https://www.mozilla.org/projects/calendar/) [Lightning](https://www.mozilla.org/projects/calendar/)
* [InfCloud](https://www.inf-it.com/open-source/clients/infcloud/), * [InfCloud](https://www.inf-it.com/open-source/clients/infcloud/),
[CalDavZAP](https://www.inf-it.com/open-source/clients/caldavzap/) and [CalDavZAP](https://www.inf-it.com/open-source/clients/caldavzap/) and
[CardDavMATE](https://www.inf-it.com/open-source/clients/carddavmate/) [CardDavMATE](https://www.inf-it.com/open-source/clients/carddavmate/)
Many clients do not support the creation of new calendars and address books. Many clients do not support the creation of new calendars and address books.
You can use Radicale's web interface You can use Radicale's web interface
(e.g. http://localhost:5232) to create and manage address books and calendars. (e.g. <http://localhost:5232>) to create and manage address books and calendars.
In some clients you can just enter the URL of the Radicale server In some clients you can just enter the URL of the Radicale server
(e.g. `http://localhost:5232`) and your user name. In others, you have to (e.g. `http://localhost:5232`) and your user name. In others, you have to
@ -853,6 +871,7 @@ address books.
#### Thunderbird #### Thunderbird
##### CardBook ##### CardBook
Add a new address book on the network with CardDAV. You have to enter the full Add a new address book on the network with CardDAV. You have to enter the full
URL of the collection (e.g. `http://localhost:5232/user/addressbook`) and URL of the collection (e.g. `http://localhost:5232/user/addressbook`) and
your user name. your user name.
@ -936,7 +955,7 @@ children of the path `/USERNAME/`.
Delete the collections by running something like: Delete the collections by running something like:
```bash ```bash
$ curl -u user -X DELETE 'http://localhost:5232/user/calendar' curl -u user -X DELETE 'http://localhost:5232/user/calendar'
``` ```
### Authentication and Rights ### Authentication and Rights
@ -994,12 +1013,12 @@ if you want to use regular curly braces in the `user` and `collection` regexes.
The following `permissions` are recognized: The following `permissions` are recognized:
* **R:** read collections (excluding address books and calendars) * **R:** read collections (excluding address books and calendars)
* **r:** read address book and calendar collections * **r:** read address book and calendar collections
* **i:** subset of **r** that only allows direct access via HTTP method GET * **i:** subset of **r** that only allows direct access via HTTP method GET
(CalDAV/CardDAV is susceptible to expensive search requests) (CalDAV/CardDAV is susceptible to expensive search requests)
* **W:** write collections (excluding address books and calendars) * **W:** write collections (excluding address books and calendars)
* **w:** write address book and calendar collections * **w:** write address book and calendar collections
### Storage ### Storage
@ -1016,8 +1035,8 @@ section (e.g. [Versioning with Git](#versioning-with-git)).
The file system contains the following files and folders: The file system contains the following files and folders:
* `.Radicale.lock`: The lock file for locking the storage. * `.Radicale.lock`: The lock file for locking the storage.
* `collection-root`: This folder contains all collections and items. * `collection-root`: This folder contains all collections and items.
A collection is represented by a folder. This folder may contain the file A collection is represented by a folder. This folder may contain the file
`.Radicale.props` with all WebDAV properties of the collection encoded `.Radicale.props` with all WebDAV properties of the collection encoded
@ -1124,47 +1143,20 @@ organized.
Here is a simple overview of the global architecture for reaching a calendar or Here is a simple overview of the global architecture for reaching a calendar or
an address book through network: an address book through network:
<table> | Part | Layer | Protocol or Format |
<thead> |----------|--------------------------|------------------------------------|
<tr> | Server | Calendar/Contact Storage | iCal/vCard |
<th>Part</th> | '' | Calendar/Contact Server | CalDAV/CardDAV Server |
<th>Layer</th> | Transfer | Network | CalDAV/CardDAV (HTTP + TLS) |
<th>Protocol or Format</th> | Client | Calendar/Contact Client | CalDAV/CardDAV Client |
</tr> | '' | GUI | Terminal, GTK, Web interface, etc. |
</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>
Radicale is **only the server part** of this architecture. Radicale is **only the server part** of this architecture.
Please note that: Please note that:
* CalDAV and CardDAV are superset protocols of WebDAV, * CalDAV and CardDAV are superset protocols of WebDAV,
* WebDAV is a superset protocol of HTTP. * WebDAV is a superset protocol of HTTP.
Radicale being a CalDAV/CardDAV server, it also can be seen as a special WebDAV Radicale being a CalDAV/CardDAV server, it also can be seen as a special WebDAV
and HTTP server. and HTTP server.
@ -1369,7 +1361,9 @@ To change or complement the documentation create a pull request to
Radicale is [available on PyPI](https://pypi.python.org/pypi/Radicale/). To Radicale is [available on PyPI](https://pypi.python.org/pypi/Radicale/). To
install, just type as superuser: install, just type as superuser:
$ python3 -m pip install --upgrade radicale ```bash
python3 -m pip install --upgrade radicale
```
#### Git Repository #### Git Repository
@ -1377,7 +1371,9 @@ If you want the development version of Radicale, take a look at the
[git repository on GitHub](https://github.com/Kozea/Radicale/), or install it [git repository on GitHub](https://github.com/Kozea/Radicale/), or install it
directly with: directly with:
$ python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz ```bash
python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
```
You can also download the content of the repository as an You can also download the content of the repository as an
[archive](https://github.com/Kozea/Radicale/tarball/master). [archive](https://github.com/Kozea/Radicale/tarball/master).
@ -1391,23 +1387,24 @@ You can find the source packages of all releases on
Radicale has been packaged for: Radicale has been packaged for:
* [ArchLinux](https://www.archlinux.org/packages/community/any/radicale/) by * [ArchLinux](https://www.archlinux.org/packages/community/any/radicale/) by
David Runge David Runge
* [Debian](http://packages.debian.org/radicale) by Jonas Smedegaard * [Debian](http://packages.debian.org/radicale) by Jonas Smedegaard
* [Gentoo](https://packages.gentoo.org/packages/www-apps/radicale) * [Gentoo](https://packages.gentoo.org/packages/www-apps/radicale)
by René Neumann, Maxim Koltsov and Manuel Rüger by René Neumann, Maxim Koltsov and Manuel Rüger
* [Fedora/RHEL/CentOS](https://src.fedoraproject.org/rpms/radicale) by Jorti and Peter Bieringer * [Fedora/RHEL/CentOS](https://src.fedoraproject.org/rpms/radicale) by Jorti
* [Mageia](http://madb.mageia.org/package/show/application/0/name/radicale) and Peter Bieringer
* [Mageia](http://madb.mageia.org/package/show/application/0/name/radicale)
by Jani Välimaa by Jani Välimaa
* [OpenBSD](http://openports.se/productivity/radicale) by Sergey Bronnikov, * [OpenBSD](http://openports.se/productivity/radicale) by Sergey Bronnikov,
Stuart Henderson and Ian Darwin Stuart Henderson and Ian Darwin
* [openSUSE](http://software.opensuse.org/package/Radicale?search_term=radicale) * [openSUSE](http://software.opensuse.org/package/Radicale?search_term=radicale)
by Ákos Szőts and Rueckert by Ákos Szőts and Rueckert
* [PyPM](http://code.activestate.com/pypm/radicale/) * [PyPM](http://code.activestate.com/pypm/radicale/)
* [Slackware](http://schoepfer.info/slackware.xhtml#packages-network) by * [Slackware](http://schoepfer.info/slackware.xhtml#packages-network) by
Johannes Schöpfer Johannes Schöpfer
* [Trisquel](http://packages.trisquel.info/search?searchon=names&keywords=radicale) * [Trisquel](http://packages.trisquel.info/search?searchon=names&keywords=radicale)
* [Ubuntu](http://packages.ubuntu.com/radicale) by the MOTU and Jonas * [Ubuntu](http://packages.ubuntu.com/radicale) by the MOTU and Jonas
Smedegaard Smedegaard
Radicale is also Radicale is also

525
NEWS.md
View file

@ -2,52 +2,53 @@
## 3.0.6 ## 3.0.6
* Allow web plugins to handle POST requests * Allow web plugins to handle POST requests
## 3.0.5 ## 3.0.5
* Start storage hook in own process group * Start storage hook in own process group
* Kill storage hook on error or exit * Kill storage hook on error or exit
* Try to kill child processes of storage hook * Try to kill child processes of storage hook
* Internal Server: Exit immediately when signal is received (do not wait for clients or storage hook to finish) * Internal Server: Exit immediately when signal is received
(do not wait for clients or storage hook to finish)
## 3.0.4 ## 3.0.4
* Fix internal server on FreeBSD * Fix internal server on FreeBSD
## 3.0.3 ## 3.0.3
* Fix internal server on OpenBSD * Fix internal server on OpenBSD
## 3.0.2 ## 3.0.2
* Use 403 response for supported-report and valid-sync-token errors * Use 403 response for supported-report and valid-sync-token errors
* Internal server: Handle missing IPv6 support * Internal server: Handle missing IPv6 support
## 3.0.1 ## 3.0.1
* Fix XML error messages * Fix XML error messages
## 3.0.0 ## 3.0.0
This release is incompatible with previous releases. This release is incompatible with previous releases.
See the upgrade checklist below. See the upgrade checklist below.
* Parallel write requests * Parallel write requests
* Support PyPy * Support PyPy
* Protect against XML denial-of-service attacks * Protect against XML denial-of-service attacks
* Check for duplicated UIDs in calendars/address books * Check for duplicated UIDs in calendars/address books
* Only add missing UIDs for uploaded whole calendars/address books * Only add missing UIDs for uploaded whole calendars/address books
* Switch from md5 to sha256 for UIDs and tokens * Switch from md5 to sha256 for UIDs and tokens
* Code cleanup: * Code cleanup:
* All plugin interfaces were simplified and are incompatible with * All plugin interfaces were simplified and are incompatible with
old plugins old plugins
* Major refactor * Major refactor
* Never sanitize paths multiple times (check if they are sanitized) * Never sanitize paths multiple times (check if they are sanitized)
* Config * Config
* Multiple configuration files separated by ``:`` (resp. ``;`` * Multiple configuration files separated by `:` (resp. `;`
on Windows) on Windows)
* Optional configuration files by prepending file path with ``?`` * Optional configuration files by prepending file path with `?`
* Check validity of every configuration file and command line * Check validity of every configuration file and command line
arguments separately arguments separately
* Report the source of invalid configuration parameters in * Report the source of invalid configuration parameters in
@ -56,36 +57,36 @@ See the upgrade checklist below.
* Store configuration as parsed values * Store configuration as parsed values
* Use Schema that describes configuration and allow plugins to apply * Use Schema that describes configuration and allow plugins to apply
their own schemas their own schemas
* Mark internal settings with ``_`` * Mark internal settings with `_`
* Internal server * Internal server
* Bind to IPv4 and IPv6 address, when both are available for hostname * Bind to IPv4 and IPv6 address, when both are available for hostname
* Set default address to ``localhost:5232`` * Set default address to `localhost:5232`
* Remove settings for SSL ciphers and protocol versions (enforce safe * Remove settings for SSL ciphers and protocol versions (enforce safe
defaults instead) defaults instead)
* Remove settings for file locking because they are of little use * Remove settings for file locking because they are of little use
* Remove daemonization (should be handled by service managers) * Remove daemonization (should be handled by service managers)
* Logging * Logging
* Replace complex Python logger configuration with simple * Replace complex Python logger configuration with simple
``logging.level`` setting `logging.level` setting
* Write PID and ``threadName`` instead of cryptic id's in log messages * Write PID and `threadName` instead of cryptic id's in log messages
* Use ``wsgi.errors`` for logging (as required by the WSGI spec) * Use `wsgi.errors` for logging (as required by the WSGI spec)
* Code cleanup: * Code cleanup:
* Don't pass logger object around (use ``logging.getLogger()`` * Don't pass logger object around (use `logging.getLogger()`
instead) instead)
* Auth * Auth
* Use ``md5`` as default for ``htpasswd_encryption`` setting * Use `md5` as default for `htpasswd_encryption` setting
* Move setting ``realm`` from section ``server`` to ``auth`` * Move setting `realm` from section `server` to `auth`
* Rights * Rights
* Use permissions ``RW`` for non-leaf collections and ``rw`` for * Use permissions `RW` for non-leaf collections and `rw` for
address books/calendars address books/calendars
* New permission ``i`` that only allows access with HTTP method GET * New permission `i` that only allows access with HTTP method GET
(CalDAV/CardDAV is susceptible to expensive search requests) (CalDAV/CardDAV is susceptible to expensive search requests)
* Web * Web
* Add upload dialog for calendars/address books from file * Add upload dialog for calendars/address books from file
* Show startup loading message * Show startup loading message
* Show warning if JavaScript is disabled * Show warning if JavaScript is disabled
* Pass HTML Validator * Pass HTML Validator
* Storage * Storage
* Check for missing UIDs in items * Check for missing UIDs in items
* Check for child collections in address books and calendars * Check for child collections in address books and calendars
* Code cleanup: * Code cleanup:
@ -93,221 +94,214 @@ See the upgrade checklist below.
## Upgrade checklist ## Upgrade checklist
* Config * Config
* Some settings were removed * Some settings were removed
* The default of ``auth.htpasswd_encryption`` changed to ``md5`` * The default of `auth.htpasswd_encryption` changed to `md5`
* The setting ``server.realm`` moved to ``auth.realm`` * The setting `server.realm` moved to `auth.realm`
* The setting ``logging.debug`` was replaced by ``logging.level`` * The setting `logging.debug` was replaced by `logging.level`
* The format of the ``rights.file`` configuration file changed: * The format of the `rights.file` configuration file changed:
* Permission ``r`` replaced by ``Rr`` * Permission `r` replaced by `Rr`
* Permission ``w`` replaced by ``Ww`` * Permission `w` replaced by `Ww`
* New permission ``i`` added as subset of ``r`` * New permission `i` added as subset of `r`
* Replaced variable ``%(login)s`` by ``{user}`` * Replaced variable `%(login)s` by `{user}`
* Removed variable ``%(path)s`` * Removed variable `%(path)s`
* ``{`` must be escaped as ``{{`` and ``}`` as ``}}`` in regexes * `{` must be escaped as `{{` and `}` as `}}` in regexes
* File system storage * File system storage
* The storage format is compatible with Radicale 2.x.x * The storage format is compatible with Radicale 2.x.x
* Run ``radicale --verify-storage`` to check for errors * Run `radicale --verify-storage` to check for errors
* Custom plugins: * Custom plugins:
* ``auth`` and ``web`` plugins require minor adjustments * `auth` and `web` plugins require minor adjustments
* ``rights`` plugins must be adapted to the new permission model * `rights` plugins must be adapted to the new permission model
* ``storage`` plugins require major changes * `storage` plugins require major changes
## 2.1.10 - Wild Radish ## 2.1.10 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Update required versions for dependencies * Update required versions for dependencies
* Get ``RADICALE_CONFIG`` from WSGI environ * Get `RADICALE_CONFIG` from WSGI environ
* Improve HTTP status codes * Improve HTTP status codes
* Fix race condition in storage lock creation * Fix race condition in storage lock creation
* Raise default limits for content length and timeout * Raise default limits for content length and timeout
* Log output from hook * Log output from hook
## 2.1.9 - Wild Radish ## 2.1.9 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Specify versions for dependencies * Specify versions for dependencies
* Move WSGI initialization into module * Move WSGI initialization into module
* Check if ``REPORT`` method is actually supported * Check if `REPORT` method is actually supported
* Include ``rights`` file in source distribution * Include `rights` file in source distribution
* Specify ``md5`` and ``bcrypt`` as extras * Specify `md5` and `bcrypt` as extras
* Improve logging messages * Improve logging messages
* Windows: Fix crash when item path is a directory * Windows: Fix crash when item path is a directory
## 2.1.8 - Wild Radish ## 2.1.8 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Flush files before fsync'ing * Flush files before fsync'ing
## 2.1.7 - Wild Radish ## 2.1.7 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Don't print warning when cache format changes * Don't print warning when cache format changes
* Add documentation for ``BaseAuth`` * Add documentation for `BaseAuth`
* Add ``is_authenticated2(login, user, password)`` to ``BaseAuth`` * Add `is_authenticated2(login, user, password)` to `BaseAuth`
* Fix names of custom properties in PROPFIND requests with * Fix names of custom properties in PROPFIND requests with
``D:propname`` or ``D:allprop`` `D:propname` or `D:allprop`
* Return all properties in PROPFIND requests with ``D:propname`` or * Return all properties in PROPFIND requests with `D:propname` or
``D:allprop`` `D:allprop`
* Allow ``D:displayname`` property on all collections * Allow `D:displayname` property on all collections
* Answer with ``D:unauthenticated`` for ``D:current-user-principal`` property * Answer with `D:unauthenticated` for `D:current-user-principal` property
when not logged in when not logged in
* Remove non-existing ``ICAL:calendar-color`` and ``C:calendar-timezone`` * Remove non-existing `ICAL:calendar-color` and `C:calendar-timezone`
properties from PROPFIND requests with ``D:propname`` or ``D:allprop`` properties from PROPFIND requests with `D:propname` or `D:allprop`
* Add ``D:owner`` property to calendar and address book objects * Add `D:owner` property to calendar and address book objects
* Remove ``D:getetag`` and ``D:getlastmodified`` properties from regular * Remove `D:getetag` and `D:getlastmodified` properties from regular
collections collections
## 2.1.6 - Wild Radish ## 2.1.6 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Fix content-type of VLIST * Fix content-type of VLIST
* Specify correct COMPONENT in content-type of VCALENDAR * Specify correct COMPONENT in content-type of VCALENDAR
* Cache COMPONENT of calendar objects (improves speed with some clients) * Cache COMPONENT of calendar objects (improves speed with some clients)
* Stricter parsing of filters * Stricter parsing of filters
* Improve support for CardDAV filter * Improve support for CardDAV filter
* Fix some smaller bugs in CalDAV filter * Fix some smaller bugs in CalDAV filter
* Add X-WR-CALNAME and X-WR-CALDESC to calendars downloaded via HTTP/WebDAV * Add X-WR-CALNAME and X-WR-CALDESC to calendars downloaded via HTTP/WebDAV
* Use X-WR-CALNAME and X-WR-CALDESC from calendars published via WebDAV * Use X-WR-CALNAME and X-WR-CALDESC from calendars published via WebDAV
## 2.1.5 - Wild Radish ## 2.1.5 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Add ``--verify-storage`` command-line argument * Add `--verify-storage` command-line argument
* Allow comments in the htpasswd file * Allow comments in the htpasswd file
* Don't strip whitespaces from user names and passwords in the htpasswd file * Don't strip whitespaces from user names and passwords in the htpasswd file
* Remove cookies from logging output * Remove cookies from logging output
* Allow uploads of whole collections with many components * Allow uploads of whole collections with many components
* Show warning message if server.timeout is used with Python < 3.5.2 * Show warning message if server.timeout is used with Python < 3.5.2
## 2.1.4 - Wild Radish ## 2.1.4 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Fix incorrect time range matching and calculation for some edge-cases with * Fix incorrect time range matching and calculation for some edge-cases with
rescheduled recurrences rescheduled recurrences
* Fix owner property * Fix owner property
## 2.1.3 - Wild Radish ## 2.1.3 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Enable timeout for SSL handshakes and move them out of the main thread * Enable timeout for SSL handshakes and move them out of the main thread
* Create cache entries during upload of items * Create cache entries during upload of items
* Stop built-in server on Windows when Ctrl+C is pressed * Stop built-in server on Windows when Ctrl+C is pressed
* Prevent slow down when multiple requests hit a collection during cache warm-up * Prevent slow down when multiple requests hit a collection during cache warm-up
## 2.1.2 - Wild Radish ## 2.1.2 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Remove workarounds for bugs in VObject < 0.9.5 * Remove workarounds for bugs in VObject < 0.9.5
* Error checking of collection tags and associated components * Error checking of collection tags and associated components
* Improve error checking of uploaded collections and components * Improve error checking of uploaded collections and components
* Don't delete empty collection properties implicitly * Don't delete empty collection properties implicitly
* Improve logging of VObject serialization * Improve logging of VObject serialization
## 2.1.1 - Wild Radish Again ## 2.1.1 - Wild Radish Again
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Add missing UIDs instead of failing * Add missing UIDs instead of failing
* Improve error checking of calendar and address book objects * Improve error checking of calendar and address book objects
* Fix upload of whole address books * Fix upload of whole address books
## 2.1.0 - Wild Radish ## 2.1.0 - Wild Radish
This release is compatible with version 2.0.0. This release is compatible with version 2.0.0.
* Built-in web interface for creating and managing address books and calendars * Built-in web interface for creating and managing address books and calendars
* can be extended with web plugins * can be extended with web plugins
* Much faster storage backend * Much faster storage backend
* Significant reduction in memory usage * Significant reduction in memory usage
* Improved logging * Improved logging
* Include paths (of invalid items / requests) in log messages * Include paths (of invalid items / requests) in log messages
* Include configuration values causing problems in log messages * Include configuration values causing problems in log messages
* Log warning message for invalid requests by clients * Log warning message for invalid requests by clients
* Log error message for invalid files in the storage backend * Log error message for invalid files in the storage backend
* No stack traces unless debugging is enabled * No stack traces unless debugging is enabled
* Time range filter also regards overwritten recurrences * Time range filter also regards overwritten recurrences
* Items that couldn't be filtered because of bugs in VObject are always * Items that couldn't be filtered because of bugs in VObject are always
returned (and a warning message is logged) returned (and a warning message is logged)
* Basic error checking of configuration files * Basic error checking of configuration files
* File system locking isn't disabled implicitly anymore, instead a new * File system locking isn't disabled implicitly anymore, instead a new
configuration option gets introduced configuration option gets introduced
* The permissions of the lock file are not changed anymore * The permissions of the lock file are not changed anymore
* Support for sync-token * Support for sync-token
* Support for client-side SSL certificates * Support for client-side SSL certificates
* Rights plugins can decide if access to an item is granted explicitly * Rights plugins can decide if access to an item is granted explicitly
* Respond with 403 instead of 404 for principal collections of non-existing * Respond with 403 instead of 404 for principal collections of non-existing
users when ``owner_only`` plugin is used (information leakage) users when `owner_only` plugin is used (information leakage)
* Authentication plugins can provide the login and password from the * Authentication plugins can provide the login and password from the
environment environment
* new ``remote_user`` plugin, that gets the login from the ``REMOTE_USER`` * new `remote_user` plugin, that gets the login from the `REMOTE_USER`
environment variable (for WSGI server) environment variable (for WSGI server)
* new ``http_x_remote_user`` plugin, that gets the login from the * new `http_x_remote_user` plugin, that gets the login from the
``X-Remote-User`` HTTP header (for reverse proxies) `X-Remote-User` HTTP header (for reverse proxies)
## 2.0.0 - Little Big Radish ## 2.0.0 - Little Big Radish
This feature is not compatible with the 1.x.x versions. Follow our This feature is not compatible with the 1.x.x versions. Follow our
[migration guide](https://radicale.org/2.1.html#documentation/migration-from-1xx-to-2xx) if you want to switch from 1.x.x to [migration guide](https://radicale.org/2.1.html#documentation/migration-from-1xx-to-2xx)
2.0.0. if you want to switch from 1.x.x to 2.0.0.
* Support Python 3.3+ only, Python 2 is not supported anymore * Support Python 3.3+ only, Python 2 is not supported anymore
* Keep only one simple filesystem-based storage system * Keep only one simple filesystem-based storage system
* Remove built-in Git support * Remove built-in Git support
* Remove built-in authentication modules * Remove built-in authentication modules
* Keep the WSGI interface, use Python HTTP server by default * Keep the WSGI interface, use Python HTTP server by default
* Use a real iCal parser, rely on the "vobject" external module * Use a real iCal parser, rely on the "vobject" external module
* Add a solid calendar discovery * Add a solid calendar discovery
* Respect the difference between "files" and "folders", don't rely on slashes * Respect the difference between "files" and "folders", don't rely on slashes
* Remove the calendar creation with GET requests * Remove the calendar creation with GET requests
* Be stateless * Be stateless
* Use a file locker * Use a file locker
* Add threading * Add threading
* Get atomic writes * Get atomic writes
* Support new filters * Support new filters
* Support read-only permissions * Support read-only permissions
* Allow External plugins for authentication, rights management, storage and * Allow External plugins for authentication, rights management, storage and
version control version control
## 1.1.4 - Fifth Law of Nature ## 1.1.4 - Fifth Law of Nature
* Use ``shutil.move`` for ``--export-storage`` * Use `shutil.move` for `--export-storage`
## 1.1.3 - Fourth Law of Nature ## 1.1.3 - Fourth Law of Nature
* Add a ``--export-storage=FOLDER`` command-line argument (by Unrud, see #606) * Add a `--export-storage=FOLDER` command-line argument (by Unrud, see #606)
## 1.1.2 - Third Law of Nature ## 1.1.2 - Third Law of Nature
* **Security fix**: Add a random timer to avoid timing oracles and simple * **Security fix**: Add a random timer to avoid timing oracles and simple
bruteforce attacks when using the htpasswd authentication method. bruteforce attacks when using the htpasswd authentication method.
* Various minor fixes. * Various minor fixes.
## 1.1.1 - Second Law of Nature ## 1.1.1 - Second Law of Nature
* Fix the owner_write rights rule * Fix the owner_write rights rule
## 1.1 - Law of Nature ## 1.1 - Law of Nature
One feature in this release is **not backward compatible**: One feature in this release is **not backward compatible**:
* Use the first matching section for rights (inspired from daald) * Use the first matching section for rights (inspired from daald)
Now, the first section matching the path and current user in your custom rights Now, the first section matching the path and current user in your custom rights
file is used. In the previous versions, the most permissive rights of all the file is used. In the previous versions, the most permissive rights of all the
@ -317,175 +311,158 @@ specific rules at the top of the file independant from the generic ones.
Many **improvements in this release are related to security**, you should Many **improvements in this release are related to security**, you should
upgrade Radicale as soon as possible: upgrade Radicale as soon as possible:
* Improve the regex used for well-known URIs (by Unrud) * Improve the regex used for well-known URIs (by Unrud)
* Prevent regex injection in rights management (by Unrud) * Prevent regex injection in rights management (by Unrud)
* Prevent crafted HTTP request from calling arbitrary functions (by Unrud) * Prevent crafted HTTP request from calling arbitrary functions (by Unrud)
* Improve URI sanitation and conversion to filesystem path (by Unrud) * Improve URI sanitation and conversion to filesystem path (by Unrud)
* Decouple the daemon from its parent environment (by Unrud) * Decouple the daemon from its parent environment (by Unrud)
Some bugs have been fixed and little enhancements have been added: Some bugs have been fixed and little enhancements have been added:
* Assign new items to corret key (by Unrud) * Assign new items to corret key (by Unrud)
* Avoid race condition in PID file creation (by Unrud) * Avoid race condition in PID file creation (by Unrud)
* Improve the docker version (by cdpb) * Improve the docker version (by cdpb)
* Encode message and commiter for git commits * Encode message and commiter for git commits
* Test with Python 3.5 * Test with Python 3.5
## 1.0.1 - Sunflower Again ## 1.0.1 - Sunflower Again
* Update the version because of a **stupid** "feature"™ of PyPI * Update the version because of a **stupid** "feature"™ of PyPI
## 1.0 - Sunflower ## 1.0 - Sunflower
* Enhanced performances (by Mathieu Dupuy) * Enhanced performances (by Mathieu Dupuy)
* Add MD5-APR1 and BCRYPT for htpasswd-based authentication (by Jan-Philip Gehrcke) * Add MD5-APR1 and BCRYPT for htpasswd-based authentication (by Jan-Philip Gehrcke)
* Use PAM service (by Stephen Paul Weber) * Use PAM service (by Stephen Paul Weber)
* Don't discard PROPPATCH on empty collections (by Markus Unterwaditzer) * Don't discard PROPPATCH on empty collections (by Markus Unterwaditzer)
* Write the path of the collection in the git message (by Matthew Monaco) * Write the path of the collection in the git message (by Matthew Monaco)
* Tests launched on Travis * Tests launched on Travis
## 0.10 - Lovely Endless Grass ## 0.10 - Lovely Endless Grass
* Support well-known URLs (by Mathieu Dupuy) * Support well-known URLs (by Mathieu Dupuy)
* Fix collection discovery (by Markus Unterwaditzer) * Fix collection discovery (by Markus Unterwaditzer)
* Reload logger config on SIGHUP (by Élie Bouttier) * Reload logger config on SIGHUP (by Élie Bouttier)
* Remove props files when deleting a collection (by Vincent Untz) * Remove props files when deleting a collection (by Vincent Untz)
* Support salted SHA1 passwords (by Marc Kleine-Budde) * Support salted SHA1 passwords (by Marc Kleine-Budde)
* Don't spam the logs about non-SSL IMAP connections to localhost (by Giel van Schijndel) * Don't spam the logs about non-SSL IMAP connections to localhost (by Giel van Schijndel)
## 0.9 - Rivers ## 0.9 - Rivers
* Custom handlers for auth, storage and rights (by Sergey Fursov) * Custom handlers for auth, storage and rights (by Sergey Fursov)
* 1-file-per-event storage (by Jean-Marc Martins) * 1-file-per-event storage (by Jean-Marc Martins)
* Git support for filesystem storages (by Jean-Marc Martins) * Git support for filesystem storages (by Jean-Marc Martins)
* DB storage working with PostgreSQL, MariaDB and SQLite (by Jean-Marc Martins) * DB storage working with PostgreSQL, MariaDB and SQLite (by Jean-Marc Martins)
* Clean rights manager based on regular expressions (by Sweil) * Clean rights manager based on regular expressions (by Sweil)
* Support of contacts for Apple's clients * Support of contacts for Apple's clients
* Support colors (by Jochen Sprickerhof) * Support colors (by Jochen Sprickerhof)
* Decode URLs in XML (by Jean-Marc Martins) * Decode URLs in XML (by Jean-Marc Martins)
* Fix PAM authentication (by Stepan Henek) * Fix PAM authentication (by Stepan Henek)
* Use consistent etags (by 9m66p93w) * Use consistent etags (by 9m66p93w)
* Use consistent sorting order (by Daniel Danner) * Use consistent sorting order (by Daniel Danner)
* Return 401 on unauthorized DELETE requests (by Eduard Braun) * Return 401 on unauthorized DELETE requests (by Eduard Braun)
* Move pid file creation in child process (by Mathieu Dupuy) * Move pid file creation in child process (by Mathieu Dupuy)
* Allow requests without base_prefix (by jheidemann) * Allow requests without base_prefix (by jheidemann)
## 0.8 - Rainbow ## 0.8 - Rainbow
* New authentication and rights management modules (by Matthias Jordan) * New authentication and rights management modules (by Matthias Jordan)
* Experimental database storage * Experimental database storage
* Command-line option for custom configuration file (by Mark Adams) * Command-line option for custom configuration file (by Mark Adams)
* Root URL not at the root of a domain (by Clint Adams, Fabrice Bellet, Vincent Untz) * Root URL not at the root of a domain (by Clint Adams, Fabrice Bellet, Vincent Untz)
* Improved support for iCal, CalDAVSync, CardDAVSync, CalDavZAP and CardDavMATE * Improved support for iCal, CalDAVSync, CardDAVSync, CalDavZAP and CardDavMATE
* Empty PROPFIND requests handled (by Christoph Polcin) * Empty PROPFIND requests handled (by Christoph Polcin)
* Colon allowed in passwords * Colon allowed in passwords
* Configurable realm message * Configurable realm message
## 0.7.1 - Waterfalls ## 0.7.1 - Waterfalls
* Many address books fixes * Many address books fixes
* New IMAP ACL (by Daniel Aleksandersen) * New IMAP ACL (by Daniel Aleksandersen)
* PAM ACL fixed (by Daniel Aleksandersen) * PAM ACL fixed (by Daniel Aleksandersen)
* Courier ACL fixed (by Benjamin Frank) * Courier ACL fixed (by Benjamin Frank)
* Always set display name to collections (by Oskari Timperi) * Always set display name to collections (by Oskari Timperi)
* Various DELETE responses fixed * Various DELETE responses fixed
## 0.7 - Eternal Sunshine ## 0.7 - Eternal Sunshine
* Repeating events * Repeating events
* Collection deletion * Collection deletion
* Courier and PAM authentication methods * Courier and PAM authentication methods
* CardDAV support * CardDAV support
* Custom LDAP filters supported * Custom LDAP filters supported
## 0.6.4 - Tulips ## 0.6.4 - Tulips
* Fix the installation with Python 3.1 * Fix the installation with Python 3.1
## 0.6.3 - Red Roses ## 0.6.3 - Red Roses
* MOVE requests fixed * MOVE requests fixed
* Faster REPORT answers * Faster REPORT answers
* Executable script moved into the package * Executable script moved into the package
## 0.6.2 - Seeds ## 0.6.2 - Seeds
* iPhone and iPad support fixed * iPhone and iPad support fixed
* Backslashes replaced by slashes in PROPFIND answers on Windows * Backslashes replaced by slashes in PROPFIND answers on Windows
* PyPI archive set as default download URL * PyPI archive set as default download URL
## 0.6.1 - Growing Up ## 0.6.1 - Growing Up
* Example files included in the tarball * Example files included in the tarball
* htpasswd support fixed * htpasswd support fixed
* Redirection loop bug fixed * Redirection loop bug fixed
* Testing message on GET requests * Testing message on GET requests
## 0.6 - Sapling ## 0.6 - Sapling
* WSGI support * WSGI support
* IPv6 support * IPv6 support
* Smart, verbose and configurable logs * Smart, verbose and configurable logs
* Apple iCal 4 and iPhone support (by Łukasz Langa) * Apple iCal 4 and iPhone support (by Łukasz Langa)
* KDE KOrganizer support * KDE KOrganizer support
* LDAP auth backend (by Corentin Le Bail) * LDAP auth backend (by Corentin Le Bail)
* Public and private calendars (by René Neumann) * Public and private calendars (by René Neumann)
* PID file * PID file
* MOVE requests management * MOVE requests management
* Journal entries support * Journal entries support
* Drop Python 2.5 support * Drop Python 2.5 support
## 0.5 - Historical Artifacts ## 0.5 - Historical Artifacts
* Calendar depth * Calendar depth
* MacOS and Windows support * MacOS and Windows support
* HEAD requests management * HEAD requests management
* htpasswd user from calendar path * htpasswd user from calendar path
## 0.4 - Hot Days Back ## 0.4 - Hot Days Back
* Personal calendars * Personal calendars
* Last-Modified HTTP header * Last-Modified HTTP header
* ``no-ssl`` and ``foreground`` options * `no-ssl` and `foreground` options
* Default configuration file * Default configuration file
## 0.3 - Dancing Flowers ## 0.3 - Dancing Flowers
* Evolution support * Evolution support
* Version management * Version management
## 0.2 - Snowflakes ## 0.2 - Snowflakes
* Sunbird pre-1.0 support * Sunbird pre-1.0 support
* SSL connection * SSL connection
* Htpasswd authentication * Htpasswd authentication
* Daemon mode * Daemon mode
* User configuration * User configuration
* Twisted dependency removed * Twisted dependency removed
* Python 3 support * Python 3 support
* Real URLs for PUT and DELETE * Real URLs for PUT and DELETE
* Concurrent modification reported to users * Concurrent modification reported to users
* Many bugs fixed (by Roger Wenham) * Many bugs fixed (by Roger Wenham)
## 0.1 - Crazy Vegetables ## 0.1 - Crazy Vegetables
* First release * First release
* Lightning/Sunbird 0.9 compatibility * Lightning/Sunbird 0.9 compatibility
* Easy installer * Easy installer