Radicale

https://radicale.org/v3.html
Admin
Radicale is a free and open-source CalDAV and CardDAV server that enables sharing of calendars,...
Tokens:30,329
Snippets:310
Trust Score:9.2
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install and start Radicale on Windows

Source: https://radicale.org/v3.html

Installs Radicale and starts the server on Windows. The server uses filesystem storage in ~/radicale/collections and no authentication. The server binds to localhost by default.

```bash
python -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
python -m radicale --storage-filesystem-folder=~/radicale/collections --auth-type none
```

--------------------------------

### Install the plugin with pip

Source: https://radicale.org/v3.html

Run this command in the same folder as setup.py to install the module.

```bash
python3 -m pip install .
```

--------------------------------

### Start Radicale as system user or root (Linux/BSD)

Source: https://radicale.org/v3.html

Starts the Radicale server manually with data stored in a system folder under /var/lib/radicale/collections. Requires write permissions to that folder. The server binds to localhost by default.

```bash
# Start, data is stored in a system folder (requires write permissions to /var/lib/radicale/collections)
python3 -m radicale --storage-filesystem-folder=/var/lib/radicale/collections --auth-type none
```

--------------------------------

### Install Radicale in virtual environment (Linux/BSD)

Source: https://radicale.org/v3.html

Installs Radicale after activating the virtual environment. Run this after the virtual environment is activated.

```bash
python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
```

--------------------------------

### Start Radicale as normal user (Linux/BSD)

Source: https://radicale.org/v3.html

Starts the Radicale server manually with filesystem storage in the user's home directory and no authentication. Data is stored only for the current user. The server binds to localhost by default.

```bash
# Start, data is stored for the current user only
python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections --auth-type none
```

--------------------------------

### Example rights file for from_file backend

Source: https://radicale.org/v3.html

Example rights file showing sections for root, principal, calendars, and group-based access. The first matching section determines permissions; if none match, access is denied. The user and collection keys are regular expressions, and {user} and {0}, {1}, etc. can be used for substitution. Write {{ and }} for literal curly braces.

```ini
# Allow reading root collection for authenticated users
[root]
user: .+
collection:
permissions: R

# Allow reading and writing principal collection (same as username)
[principal]
user: .+
collection: {user}
permissions: RW

# Allow reading and writing calendars and address books that are direct
# children of the principal collection
[calendars]
user: .+
collection: {user}/[^/]+
permissions: rw

# Allow reading and writing the collection named "common" for people in
# certain LDAP groups
[groupcal]
groups: members,directors
collection: common
permission: rw
```

--------------------------------

### Example Radicale configuration file

Source: https://radicale.org/v3.html

An example INI-style configuration file for Radicale, showing server hosts, htpasswd authentication, and filesystem storage. It is loaded from /etc/radicale/config or ~/.config/radicale/config by default.

```ini
[server]
# Bind all addresses
hosts = 0.0.0.0:5232, [::]:5232

[auth]
type = htpasswd
htpasswd_filename = ~/.config/radicale/users
htpasswd_encryption = autodetect

[storage]
filesystem_folder = ~/.var/lib/radicale/collections

```

--------------------------------

### Install Radicale from PyPI

Source: https://radicale.org/v3.html

Install the latest stable Radicale release from PyPI using pip. Run as superuser.

```bash
python3 -m pip install --upgrade radicale
```

--------------------------------

### Install Radicale for current user (Linux/BSD)

Source: https://radicale.org/v3.html

Installs Radicale only for the current user using pip. Recommended for testing. If the install fails with 'error: externally-managed-environment', create and activate a virtual environment first.

```bash
# Run the following command to only install for the current user
python3 -m pip install --user --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
```

--------------------------------

### setup.py for radicale_static_password_auth plugin

Source: https://radicale.org/v3.html

Minimal Distutils setup script for the plugin package. Place it in an empty folder and create a sub-folder with the same name as specified in 'packages'.

```python
#!/usr/bin/env python3

from distutils.core import setup

setup(name="radicale_static_password_auth",
      packages=["radicale_static_password_auth"])
```

--------------------------------

### Equivalent command-line configuration for Radicale

Source: https://radicale.org/v3.html

Shows the same configuration as the example file, but passed via command-line arguments to python3 -m radicale. Each option is prefixed with the section name and uses hyphens instead of underscores.

```bash
python3 -m radicale --server-hosts 0.0.0.0:5232,[::]:5232 \
        --auth-type htpasswd --auth-htpasswd-filename ~/.config/radicale/users \
        --auth-htpasswd-encryption autodetect

```

--------------------------------

### Start Radicale with Docker Compose

Source: https://radicale.org/v3.html

Start the Radicale container in detached mode using Docker Compose.

```bash
$ docker compose up -d
```

--------------------------------

### Create and activate virtual environment (Linux/BSD)

Source: https://radicale.org/v3.html

Creates a virtual environment in ~/venv and activates it. Use this before installing if the system reports 'error: externally-managed-environment'.

```bash
python3 -m venv ~/venv
source ~/venv/bin/activate
```

--------------------------------

### Enable and manage systemd service (system-wide)

Source: https://radicale.org/v3.html

Commands to enable, start, check status, and view logs for the Radicale systemd service.

```bash
# Enable the service
$ systemctl enable radicale
# Start the service
$ systemctl start radicale
# Check the status of the service
$ systemctl status radicale
# View all log messages
$ journalctl --unit radicale.service
```

--------------------------------

### Create config and data directories

Source: https://radicale.org/v3.html

Create directories to store data and configuration for the Docker Compose setup.

```bash
$ mkdir config data
```

--------------------------------

### Using Radicale command-line options in startup scripts

Source: https://radicale.org/v3.html

Three shell script examples for storing Radicale command-line options in variables: a simple string, an array method #1, and an array method #2. These allow passing multiple options to the /usr/bin/radicale executable.

```bash
## simple variable containing multiple options
RADICALE_OPTIONS="--logging-level=debug --config=/etc/radicale/config --logging-request-header-on-debug --logging-rights-rule-doesnt-match-on-debug"
/usr/bin/radicale $RADICALE_OPTIONS

## variable as array method #1
RADICALE_OPTIONS=("--logging-level=debug" "--config=/etc/radicale/config" "--logging-request-header-on-debug" "--logging-rights-rule-doesnt-match-on-debug")
/usr/bin/radicale ${RADICALE_OPTIONS[@]}

## variable as array method #2
RADICALE_OPTIONS=()
RADICALE_OPTIONS+=("--logging-level=debug")
RADICALE_OPTIONS+=("--config=/etc/radicale/config")
/usr/bin/radicale ${RADICALE_OPTIONS[@]}

```

--------------------------------

### Create plain text users file

Source: https://radicale.org/v3.html

Example of a users file with plain text passwords, one per line in the format username:password.

```text
user1:password1
user2:password2
```

--------------------------------

### predefined_collections configuration example

Source: https://radicale.org/v3.html

Example configuration for the predefined_collections option, defining two collections: an address book and a calendar. The address book uses the tag VADDRESSBOOK and a display name, while the calendar uses the tag VCALENDAR with supported components VEVENT, VJOURNAL, and VTODO.

```json
{
  "def-addressbook": {
     "D:displayname": "Personal Address Book",
     "tag": "VADDRESSBOOK"
  },
  "def-calendar": {
     "C:supported-calendar-component-set": "VEVENT,VJOURNAL,VTODO",
     "D:displayname": "Personal Calendar",
     "tag": "VCALENDAR"
  }
}
```

--------------------------------

### Create Radicale directory

Source: https://radicale.org/v3.html

Create a directory to store the data, configuration, and compose file for Docker Compose setup.

```bash
$ mkdir radicale
$ cd radicale
```

--------------------------------

### Set Content-Security-Policy header

Source: https://radicale.org/v3.html

Example configuration to set a Content-Security-Policy that disallows execution of unknown JavaScript.

```ini
Content-Security-Policy = default-src 'self'; object-src 'none'
```

--------------------------------

### Enable and manage systemd user service

Source: https://radicale.org/v3.html

Commands to enable, start, check status, and view logs for the Radicale systemd user service.

```bash
# Enable the service
$ systemctl --user enable radicale
# Start the service
$ systemctl --user start radicale
# Check the status of the service
$ systemctl --user status radicale
# View all log messages
$ journalctl --user --unit radicale.service
```

--------------------------------

### Command-line override of logging.backtrace_on_debug

Source: https://radicale.org/v3.html

Shows how a configuration file option can be overridden on the command line by replacing underscores with hyphens and prepending the section name. The example config sets logging.backtrace_on_debug to False, which can be enabled with --logging-backtrace-on-debug=true.

```ini
[logging]
backtrace_on_debug = False

```

--------------------------------

### Create and chown storage folder for radicale

Source: https://radicale.org/v3.html

Run as root to create the storage folder and make it writable by the 'radicale' user.

```bash
mkdir -p /var/lib/radicale/collections && chown -R radicale:radicale /var/lib/radicale/collections
```

--------------------------------

### Install Radicale as system user or root (Linux/BSD)

Source: https://radicale.org/v3.html

Installs Radicale as root or a non-root system user. Not recommended. The --user flag may be required if dependencies are not available system-wide or if using a virtual environment.

```bash
# Run the following command as root (not recommended) or non-root system user
# (the later may require --user in case dependencies are not available system-wide and/or virtual environment)
python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
```

--------------------------------

### Uninstall the plugin with pip

Source: https://radicale.org/v3.html

Removes the installed plugin module.

```bash
python3 -m pip uninstall radicale_static_password_auth
```

--------------------------------

### Set Access-Control-Allow-Origin header

Source: https://radicale.org/v3.html

Example configuration to relax the same-origin policy by setting the Access-Control-Allow-Origin header to *.

```ini
Access-Control-Allow-Origin = *
```

--------------------------------

### Create and chown cache folder for radicale

Source: https://radicale.org/v3.html

Run as root to create the cache folder and make it writable by the 'radicale' user. Only needed if a dedicated cache folder is configured.

```bash
mkdir -p /var/cache/radicale && chown -R radicale:radicale /var/cache/radicale
```

--------------------------------

### Initialize git repository for Radicale collections

Source: https://radicale.org/v3.html

Commands to initialize a git repository in the collection base directory, set user configuration, and create a .gitignore file to exclude cache, lock, and temporary files. Run as the 'radicale' user.

```bash
## assuming "radicale" user is starting "radicale" service
# change to user "radicale"
su -l -s /bin/bash radicale

# change to collection base directory defined in [storage] -> filesystem_folder
#  assumed here /var/lib/radicale/collections
cd /var/lib/radicale/collections

# initialize git repository
git init

# set user and e-mail, here minimum example
git config user.name "$USER"
git config user.email "$USER@$HOSTNAME"

# define ignore of cache/lock/tmp files
cat <<'END' >.gitignore
.Radicale.cache
.Radicale.lock
.Radicale.tmp-*
END
```

--------------------------------

### Create user systemd service file for Radicale

Source: https://radicale.org/v3.html

Create the file ~/.config/systemd/user/radicale.service with this content to run Radicale as a user service.

```ini
[Unit]
Description=A simple CalDAV (calendar) and CardDAV (contact) server

[Service]
ExecStart=/usr/bin/env python3 -m radicale
Restart=on-failure

[Install]
WantedBy=default.target
```

--------------------------------

### Configure server and authentication limits

Source: https://radicale.org/v3.html

Configuration to set limits on connections, content size, resource size, timeout, and authentication delay.

```ini
[server]
max_connections = 20
# 100 Megabyte
max_content_length = 100000000
# 10 Megabyte (>= 3.5.10)
max_resource_size = 10000000
# 30 seconds
timeout = 30

[auth]
# Average delay after failed login attempts in seconds
# Also used for invalid/not-existing/not-enabled share-by-token (>= 3.7.0)
delay = 1
```

--------------------------------

### Create radicale user for systemd service

Source: https://radicale.org/v3.html

Run as root to create the 'radicale' user and group for the Radicale service.

```bash
useradd --system --user-group --home-dir / --shell /sbin/nologin radicale
```

--------------------------------

### Create address book collection .Radicale.props

Source: https://radicale.org/v3.html

Create a .Radicale.props file with this JSON content in a collection folder to indicate it is an address book. The collection becomes available at the URL path.

```json
{"tag": "VADDRESSBOOK"}
```

--------------------------------

### Configure flexible LDAP logins with ldap_filter and ldap_user_attribute

Source: https://radicale.org/v3.html

Example configuration for allowing users to log in using either their common name (cn) or email address (mail). The ldap_filter uses the {0} placeholder for the login name, and ldap_user_attribute is set to cn to consolidate usernames after authentication.

```ini
ldap_filter = (&(objectclass=inetOrgPerson)(|(cn={0})(mail={0})))
ldap_user_attribute = cn
```

--------------------------------

### Create calendar collection .Radicale.props

Source: https://radicale.org/v3.html

Create a .Radicale.props file with this JSON content in a collection folder to indicate it is a calendar. The collection becomes available at the URL path (e.g., /user/calendar).

```json
{"tag": "VCALENDAR"}
```
Tokens:
Raw