Radicale/documentation.md

layout	title	permalink
page	Documentation	/documentation/

This documentation page is written for version 2.0.x. If you want to update Radicale from 1.x.x to 2.0.x, please follow our [migration guide]({{ site.baseurl }}/1to2/).

Install and set up

You're new to Radicale and you want to know how to use it? Welcome aboard!

• [What is Radicale?]({{ site.baseurl }}/about/)
• [A really simple 5-minute tutorial.]({{ site.baseurl }}/tutorial/)
• [A simple but solid setup.]({{ site.baseurl }}/setup/)
• [Run behind a reverse proxy.]({{ site.baseurl }}/proxy/)
• [Run with a WSGI server.]({{ site.baseurl }}/wsgi/)
• [Track all changes to calendars and address books with Git.]({{ site.baseurl }}/versioning/)

Use

• [Which clients are supported?]({{ site.baseurl }}/clients/)

Configure

Now that you have Radicale running, let's see what we can configure to make it fit your needs.

• [What can I configure?]({{ site.baseurl }}/configuration/)
• [Authentication & Rights.]({{ site.baseurl }}/rights/)
• [Storage.]({{ site.baseurl }}/storage/)
• [Logging.]({{ site.baseurl }}/logging/)

Hack

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!

• [How does Radicale work?]({{ site.baseurl }}/architecture/)
• [Plugins.]({{ site.baseurl }}/plugins/)
• [Debugging.]({{ site.baseurl }}/debugging/)
• [Adding or fixing documentation.]({{ site.baseurl }}/edit/)