From ee68ca343a3aeeb9c4c12f97d28b8e6c53637c7c Mon Sep 17 00:00:00 2001 From: Unrud Date: Sun, 25 Jun 2017 11:02:36 +0200 Subject: [PATCH] Update documentation for 2.1.0 --- configuration.md | 20 ++------------------ index.html | 1 + plugins.md | 2 -- proxy.md | 6 ------ tutorial.md | 8 ++++---- use.md | 20 +++++++++----------- wsgi.md | 10 +++------- 7 files changed, 19 insertions(+), 48 deletions(-) diff --git a/configuration.md b/configuration.md index 3866eeed..b349b25e 100644 --- a/configuration.md +++ b/configuration.md @@ -87,9 +87,6 @@ Path to the private key for SSL. Only effective if `ssl` is enabled. Default: `/etc/ssl/radicale.key.pem` ### certificate_authority - -(This feature is only available in the development version!) - Path to the CA certificate for validating client certificates. This can be used to secure TCP traffic between Radicale and a reverse proxy. If you want to authenticate users with client-side certificates, you also have to write an @@ -142,16 +139,12 @@ Available backends: usernames and passwords. `remote_user` -: (This feature is only available in the development version!) - - Takes the user name from the `REMOTE_USER` environment variable and disables +: Takes the user name from the `REMOTE_USER` environment variable and disables HTTP authentication. This can be used to provide the user name from a WSGI server. `http_x_remote_user` -: (This feature is only available in the development version!) - - Takes the user name from the `X-Remote-User` HTTP header and disables HTTP +: Takes the user name from the `X-Remote-User` HTTP header and disables HTTP authentication. This can be used to provide the user name from a reverse proxy. @@ -252,9 +245,6 @@ Folder for storing local collections, created if not present. Default: `/var/lib/radicale/collections` ### filesystem_locking - -(This setting is only available in the development version!) - Lock the storage. This must be disabled if locking is not supported by the underlying file system. Never start multiple instances of Radicale or edit the storage externally while Radicale is running if disabled. @@ -262,9 +252,6 @@ storage externally while Radicale is running if disabled. Default: `True` ### max_sync_token_age - -(This feature is only available in the development version!) - Delete sync-token that are older than the specified time. (seconds) Default: `2592000` @@ -284,9 +271,6 @@ Default: ## web ### type - -(This feature is only available in the development version!) - The backend that provides the web interface of Radicale. `none` diff --git a/index.html b/index.html index fbab05df..71a063a1 100644 --- a/index.html +++ b/index.html @@ -41,6 +41,7 @@ $ python3 -m radicale --config "" --storage-filesystem-folder=~/.var/lib/radical

When your server is launched, you can check that everything's OK by going to http://localhost:5232/ with your browser! + You can login with any username and password.

diff --git a/plugins.md b/plugins.md index b3e9fbba..7dd00d1a 100644 --- a/plugins.md +++ b/plugins.md @@ -69,8 +69,6 @@ The module must contain a class `Rights` that extends Radicale's source code for more information. ## Web plugins -(This feature is only available in the development version!) - This plugin type is used to provide the web interface for Radicale. The module must contain a class `Web` that extends `radicale.web.BaseWeb`. Take a look at the file `radicale/web.py` in diff --git a/proxy.md b/proxy.md index 203f71b4..285afc57 100644 --- a/proxy.md +++ b/proxy.md @@ -23,9 +23,6 @@ maximum number of parallel connections, the maximum file size and the rate of incorrect authentication attempts. Connections are terminated after a timeout. ## Manage user accounts with the reverse proxy - -(This feature is only available in the development version!) - Set the configuration option `type` in the `auth` section to `http_x_remote_user`. Radicale uses the user name provided in the `X-Remote-User` HTTP header and @@ -45,9 +42,6 @@ location /radicale/ { ``` ## Secure connection between Radicale and the reverse proxy - -(This feature is only available in the development version!) - 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 diff --git a/tutorial.md b/tutorial.md index abd2fae0..9ecc8ae8 100644 --- a/tutorial.md +++ b/tutorial.md @@ -31,8 +31,8 @@ $ python3 -m pip install --upgrade radicale $ python3 -m radicale --config "" --storage-filesystem-folder=~/.var/lib/radicale/collections ``` -Victory! Open [http://localhost:5232/](http://localhost:5232/) in your browser -and enjoy the "Radicale works!" message! +Victory! Open [http://localhost:5232/](http://localhost:5232/) in your browser! +You can login with any username and password. ## Windows @@ -49,8 +49,8 @@ C:\Users\User> python -m pip install --upgrade radicale C:\Users\User> python -m radicale --config "" --storage-filesystem-folder=~/radicale/collections ``` -Victory! Open [http://localhost:5232/](http://localhost:5232/) in your browser -and enjoy the "Radicale works!" message! +Victory! Open [http://localhost:5232/](http://localhost:5232/) in your browser! +You can login with any username and password. ## MacOS diff --git a/use.md b/use.md index 4533090d..a2e10389 100644 --- a/use.md +++ b/use.md @@ -19,11 +19,9 @@ Radicale has been tested with: [CardDavMATE](https://www.inf-it.com/open-source/clients/carddavmate/) Many clients do not support the creation of new calendars and address books. -You have to use another client for this or create them manually -(unfortunately this is quite complicated). The development version of Radicale -has a web interface that lets you create and manage collections conveniently. -Manual creation of calendars and address books is described in -the last chapter. +You can use Radicale's web interface +(e.g. [http://localhost:5232](http://localhost:5232)) to create and manage +collections. 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 @@ -63,6 +61,10 @@ specify the user name in the URL (e.g. `http://user@localhost...`) ## InfCloud, CalDavZAP and CardDavMATE +You can integrate InfCloud into Radicale's web interface with +[RadicaleInfCloud](https://github.com/Unrud/RadicaleInfCloud). No additional +configuration is required. + Set the URL of the Radicale server in ``config.js``. If **InfCloud** is not hosted on the same server and port as Radicale, the browser will deny access to the Radicale server, because of the @@ -70,15 +72,11 @@ the Radicale server, because of the You have to add additional HTTP header in the `headers` section of Radicale's configuration. The documentation of **InfCloud** has more details on this. -In the development version of Radicale you can integrate InfCloud directly with -[RadicaleInfCloud](https://github.com/Unrud/RadicaleInfCloud). - ## Manual creation of calendars and address books This is not the recommended way of creating and managing your calendars and -address books. Use a client with support for it if possible -(e.g. **DAVdroid**). The development version of Radicale has a web interface -that lets you create and manage collections conveniently. +address books. Use Radicale's web interface or a client with support for it +(e.g. **DAVdroid**). ### Direct editing of the storage diff --git a/wsgi.md b/wsgi.md index ec010bfe..1528e252 100644 --- a/wsgi.md +++ b/wsgi.md @@ -10,17 +10,13 @@ the source code as the WSGI file. A configuration file can be set with the `RADICALE_CONFIG` environment variable, otherwise the default configuration is used. -**Important:** The `None` authentication type disables all rights checking. -Don't use it with `REMOTE_USER`. The development version of Radicale has -the `remote_user` module for this use-case. - Be reminded that Radicale's default configuration enforces limits on the maximum upload file size. +**Security:** The `None` authentication type disables all rights checking. +Don't use it with `REMOTE_USER`. Use `remote_user` instead. + ## Manage user accounts with the WSGI server - -(This feature is only available in the development version!) - Set 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.