Update documentation to reflect 0.2 version changes.

project_description.rst

@@ -4,7 +4,7 @@
 
 :Author: Guillaume Ayoub
 
-:Date: 2009-07-21
+:Date: 2010-01-22
 
 :Abstract: This document defines the main goals of the Radicale
  Project, what it covers and what it does not.
@@ -18,8 +18,7 @@ The Radicale Project is a complete calendar storing and manipulating
 solution. It can store multiple calendars.
 
 Calendar manipulation is available from both local and distant
-accesses, possibly limited through authentification policies and
+accesses, possibly limited through authentication policies.
-calendar-based rules.
 
 
 What Radicale Is
@@ -30,7 +29,11 @@ Calendar Server
 
 The Radicale Project is mainly a calendar server, giving local and
 distant accessess for reading, creating, modifying and deleting
-multiple calendars.
+multiple calendars through a simplified CalDAV protocol.
+
+Data can be encrypted by SSL, and their access can be restricted thanks to
+different authentication methods.
+
 
 What Radicale will Be
 =====================

technical_choices.rst

@@ -4,7 +4,7 @@
 
 :Author: Guillaume Ayoub
 
-:Date: 2009-07-21
+:Date: 2010-01-22
 
 :Abstract: This document describes the global technical choices of the
  Radicale Project and the global architectures of its different parts.
@@ -75,7 +75,7 @@ you have a possibly heterogeneous list of user agents.
 
 The Radicale Server does not and **will not** support the CalDAV standard. It
 supports the CalDAV implementation of different clients (only Sunbird 0.9+ [#]_ and
-Lightning 0.9+ [#]_ for the moment).
+Lightning 0.9+ [#]_ for the moment, including 1.0).
 
 .. [#] `Cosmo <http://chandlerproject.org/Projects/CosmoHome>`_, the web
    contents and calendars sharing server build to support the Chandler Project.
@@ -95,9 +95,9 @@ Simple
 The Radicale Server is designed to be simple to install, simple to configure,
 simple to use.
 
-The installation is very easy, particularly with Linux: few dependances, no
+The installation is very easy, particularly with Linux: no dependances, no
 superuser rights needed, no configuration required. Launching the main script
-out-of-the-box, as anormal user, is often the only step to have a simple remote
+out-of-the-box, as a normal user, is often the only step to have a simple remote
 calendar access.
 
 Contrary to other servers that are often complicated, require high privileges

user_documentation.rst

@@ -4,7 +4,7 @@
 
 :Author: Guillaume Ayoub
 
-:Date: 2010-01-11
+:Date: 2010-01-22
 
 :Abstract: This document is a short description for installing and using the
  Radicale Calendar Server.
@@ -18,11 +18,16 @@ Dependencies
 ------------
 
 Radicale is written in pure python and does not depend on any librabry. It is
-known to work on Python 2.5, 2.6, 3.0 and 3.1.
+known to work on Python 2.5, 2.6, 3.0 and 3.1 [#]_.
 
 Linux users certainly have Python already installed. For Windows and MacOS
 users, please install Python [#]_ thanks to the adequate installer.
 
+
+.. [#] HTTPS support depends on the ``ssl`` module, only available from Python
+   2.6. Nevertheless, Radicale without TLS encryption works well with Python
+   2.5.
+
 .. [#] `Python download page <http://python.org/download/>`_.
 
 Radicale
@@ -52,7 +57,7 @@ Starting Server
 ---------------
 
 To start Radicale CalDAV server, you have to launch the file called
-``radicale.py`` located in the root folder of the software.
+``radicale.py`` located in the root folder of the software package.
 
 Using Sunbird
 -------------
@@ -94,19 +99,29 @@ Then, launching the server can be easily done by typing as a normal user::
 
   radicale
 
-.. note::
-   Radicale has no daemon mode yet. Please use external programs (such as
-   ``screen``) to use Radicale as a resident program.
-
 Configuring Server
 ------------------
 
-The server configuration can be modified in ``/etc/radicale.conf``. Here is the
+Configuration File
-default configuration file, with the main parameters::
+~~~~~~~~~~~~~~~~~~
+
+The server configuration can be modified in ``/etc/radicale.conf`` or in
+``~/.config/radicale/config``. Here is the default configuration file, with the
+main parameters::
 
   [server]
+  # CalDAV server hostname, empty means all hostnames
+  host = 
   # CalDAV server port
   port = 5232
+  # Daemon flag
+  daemon = False
+  # SSL flag, enable HTTPS protocol
+  ssl = False
+  # SSL certificate path (if needed)
+  certificate = /etc/apache2/ssl/server.crt
+  # SSL private key (if needed)
+  key = /etc/apache2/ssl/server.key
   
   [encoding]
   # Encoding for responding requests
@@ -114,12 +129,33 @@ default configuration file, with the main parameters::
   # Encoding for storing local calendars
   stock = utf-8
 
+  [acl]
+  # Access method
+  # Value: fake | htpasswd
+  type = fake
+  # Htpasswd filename (if needed)
+  filename = /etc/radicale/users
+  # Htpasswd encryption method (if needed)
+  # Value: plain | sha1 | crypt
+  encryption = crypt
+
   [support]
+  # Storage method
+  # Value: plain
+  type = plain
   # Folder for storing local calendars
   folder = ~/.config/radicale
-  # Default calendar path
+  # Default calendar path, automatically created if not present
   calendar = radicale/calendar
 
 This configuration file is read each time the server is launched. If some
 values are not given, the default ones are used. If no configuration file is
 available, all the default values are used.
+
+Command Line Options
+~~~~~~~~~~~~~~~~~~~~
+
+All the options of the ``server`` part can be changed with command line
+options. These options are available by typing::
+
+  radicale --help