1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-08-01 18:18:31 +00:00

Document features of the development version

This commit is contained in:
Unrud 2017-06-07 21:39:54 +02:00
parent 200a9cc40b
commit 326859e53e
5 changed files with 143 additions and 5 deletions

View file

@ -86,6 +86,17 @@ 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
authentication plugin that extracts the user name from the certifcate.
Default:
### protocol
SSL protocol used. See python's ssl module for available values.
@ -130,6 +141,20 @@ Available backends:
: Use an [Apache htpasswd file](https://httpd.apache.org/docs/current/programs/htpasswd.html) to store
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
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
authentication. This can be used to provide the user name from a reverse
proxy.
Default: `None`
### htpasswd_filename
@ -226,6 +251,24 @@ 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.
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`
### filesystem_fsync
Sync all changes to disk during requests. (This can impair performance.)
Disabling it increases the risk of data loss, when the system crashes or
@ -239,6 +282,21 @@ Command that is run after changes to storage. Take a look at the
Default:
## web
### type
(This feature is only available in the development version!)
The backend that provides the web interface of Radicale.
`none`
: Just shows the message "Radicale works!".
`internal`
: Allows creation and management of address books and calendars.
Default: `internal`
## logging
## debug
Set the default logging level to debug.