2016-02-08 18:48:16 +01:00
|
|
|
---
|
|
|
|
|
layout: page
|
|
|
|
|
title: Documentation
|
|
|
|
|
permalink: /documentation/
|
|
|
|
|
---
|
2016-02-12 22:38:02 +01:00
|
|
|
|
2017-06-17 02:32:07 +02:00
|
|
|
This documentation page is written for version 2.x.x. If you want to update
|
|
|
|
|
Radicale from 1.x.x to 2.x.x, please follow
|
2017-05-27 11:31:35 +02:00
|
|
|
our [migration guide]({{ site.baseurl }}/1to2/). You can find on GitHub the
|
|
|
|
|
[documentation page for the 1.1.x versions](https://github.com/Kozea/Radicale/blob/website/pages/user_documentation.rst).
|
2016-02-12 22:38:02 +01:00
|
|
|
|
2017-05-27 12:06:41 +02:00
|
|
|
## Install and Set Up
|
2016-02-12 22:38:02 +01:00
|
|
|
|
2016-08-10 18:09:04 +02:00
|
|
|
You're new to Radicale and you want to know how to use it? Welcome aboard!
|
2016-02-12 22:38:02 +01:00
|
|
|
|
2016-08-11 19:03:50 +02:00
|
|
|
- [What is Radicale?]({{ site.baseurl }}/about/)
|
|
|
|
|
- [A really simple 5-minute tutorial.]({{ site.baseurl }}/tutorial/)
|
2017-05-24 19:13:47 +02:00
|
|
|
- [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/)
|
2016-08-11 19:03:50 +02:00
|
|
|
|
|
|
|
|
## Use
|
|
|
|
|
|
|
|
|
|
- [Which clients are supported?]({{ site.baseurl }}/clients/)
|
2016-02-12 22:38:02 +01:00
|
|
|
|
2016-08-10 18:09:04 +02:00
|
|
|
## Configure
|
2016-02-12 22:38:02 +01:00
|
|
|
|
2016-08-10 18:09:04 +02:00
|
|
|
Now that you have Radicale running, let's see what we can configure to make it
|
2017-05-24 19:13:47 +02:00
|
|
|
fit your needs.
|
2016-08-10 18:09:04 +02:00
|
|
|
|
2016-08-11 19:03:50 +02:00
|
|
|
- [What can I configure?]({{ site.baseurl }}/configuration/)
|
|
|
|
|
- [Authentication & Rights.]({{ site.baseurl }}/rights/)
|
|
|
|
|
- [Storage.]({{ site.baseurl }}/storage/)
|
|
|
|
|
- [Logging.]({{ site.baseurl }}/logging/)
|
2016-08-10 18:09:04 +02:00
|
|
|
|
|
|
|
|
## 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!
|
|
|
|
|
|
2016-08-11 19:03:50 +02:00
|
|
|
- [How does Radicale work?]({{ site.baseurl }}/architecture/)
|
|
|
|
|
- [Plugins.]({{ site.baseurl }}/plugins/)
|
2017-07-21 15:39:47 +02:00
|
|
|
- [Adding or fixing documentation.]({{ site.baseurl }}/contribute/)
|
