Radicale is really easy to install and works out-of-the-box.
-$ python3 -m pip install --upgrade radicale
-$ python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collectionsWhen the server is launched, open http://localhost:5232/ in your browser! You can login with any username and password.
+python3 -m pip install --upgrade radicale
+python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collectionsWhen the server is launched, open http://localhost:5232 in your browser! You can login with any username and password.
Want more? Check the tutorials and the documentation.
Victory! Open http://localhost:5232/ in your browser! You can log in with any username and password.
+Victory! Open http://localhost:5232 in your browser! You can log in with any username and password.
The first step is to install Python. Go to python.org 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!
Launch a command prompt and type:
-C:\Users\User> python -m pip install --upgrade radicale
-C:\Users\User> python -m radicale --storage-filesystem-folder=~/radicale/collectionsVictory! Open http://localhost:5232/ in your browser! You can log in with any username and password.
+python -m pip install --upgrade radicale
+python -m radicale --storage-filesystem-folder=~/radicale/collectionsVictory! Open http://localhost:5232 in your browser! You can log in with any username and password.
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.
-$ openssl req -x509 -newkey rsa:4096 -keyout server_key.pem -out server_cert.pem -nodes -days 9999
-$ openssl req -x509 -newkey rsa:4096 -keyout client_key.pem -out client_cert.pem -nodes -days 9999openssl req -x509 -newkey rsa:4096 -keyout server_key.pem -out server_cert.pem \
+ -nodes -days 9999
+openssl req -x509 -newkey rsa:4096 -keyout client_key.pem -out client_cert.pem \
+ -nodes -days 9999Use the following configuration for Radicale:
[server]
ssl = True
@@ -551,7 +553,8 @@ user2:password2Example Gunicorn configuration:
-gunicorn --bind '127.0.0.1:5232' --workers 8 --env 'RADICALE_CONFIG=/etc/radicale/config' radicalegunicorn --bind '127.0.0.1:5232' --env 'RADICALE_CONFIG=/etc/radicale/config' \
+ --workers 8 radicaleSet the configuration option type in the auth section to remote_user. Radicale uses the user name provided by the WSGI server and disables authentication over HTTP.
This tutorial describes how to keep track of all changes to calendars and address books with git (or any other version control system).
The repository must be initialized by running git init in the file system folder. Internal files of Radicale can be excluded by creating the file .gitignore with the following content:
.Radicale.cache
+.Radicale.cache
.Radicale.lock
.Radicale.tmp-*
The configuration option hook in the storage section must be set to the following command:
@@ -588,7 +591,9 @@ user2:password2Radicale tries to load configuration files from /etc/radicale/config and ~/.config/radicale/config. Custom paths can be specified with the --config /path/to/config command line argument or the RADICALE_CONFIG environment variable. Multiple configuration files can be separated by : (resp. ; on Windows). Paths that start with ? are optional.
The same example configuration via command line arguments looks like:
-python3 -m radicale --server-hosts 0.0.0.0:5232,[::]:5232 --auth-type htpasswd --htpasswd-filename ~/.config/radicale/users --htpasswd-encryption md5python3 -m radicale --server-hosts 0.0.0.0:5232,[::]:5232 \
+ --auth-type htpasswd --auth-htpasswd-filename ~/.config/radicale/users \
+ --auth-htpasswd-encryption md5Add the argument --config "" to stop Radicale from loading the default configuration files. Run python3 -m radicale --help for more information.
In the following, all configuration categories and options are described.
The backend that is used to store data.
Available backends:
multifilesystem : Stores the data in the filesystem.
multifilesystem_nolock : The multifilesystem backend without file-based locking. Must only be used with a single process.
Default: multifilesystem
Many clients do not support the creation of new calendars and address books. You can use Radicale's web interface (e.g. http://localhost:5232) to create and manage address books and calendars.
+Many clients do not support the creation of new calendars and address books. You can use Radicale's web interface (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 (e.g. http://localhost:5232) and your user name. In others, you have to enter the URL of the collection directly (e.g. http://localhost:5232/user/calendar).
The collection /USERNAME 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 /USERNAME/.
Delete the collections by running something like:
-$ curl -u user -X DELETE 'http://localhost:5232/user/calendar'curl -u user -X DELETE 'http://localhost:5232/user/calendar'Here is a simple overview of the global architecture for reaching a calendar or an address book through network:
| Part | Layer | Protocol or Format |
|---|---|---|
| Server | +||
| Server | Calendar/Contact Storage | iCal/vCard |
| '' | Calendar/Contact Server | CalDAV/CardDAV Server |
| Transfer | Network | CalDAV/CardDAV (HTTP + TLS) |
| Client | +||
| Client | Calendar/Contact Client | CalDAV/CardDAV Client |
| '' | GUI | Terminal, GTK, Web interface, etc. |