Scroll to navigation

RADICALE(1) User Commands RADICALE(1)

NAME

radicale - a simple calendar server

DESCRIPTION

usage: radicale [OPTIONS]

options:

show this help message and exit
show program's version number and exit
check the storage for errors and exit
check the provided item file for errors and exit
check the sharing database for errors and exit
use specific configuration files
print debug information

server:

backend specific options omitted
server to use (builtin|hypercorn|cheroot), hypercorn also serves H2C and needs the "h2" extra (pip install radicale[h2]), cheroot needs the "cheroot" extra
set server hostnames including ports
maximum number of parallel connections
maximum size of request body in bytes (default: 100 Mbyte)
base delay in case of error 5xx response (seconds)
maximum size of resource (default: 10 Mbyte)
maximum occurrence by an RRULE (default: 10000)
socket timeout
use SSL connection
do not use SSL connection (opposite of --server-ssl)
SSL/TLS protocol (Apache SSLProtocol format)
SSL/TLS Cipher Suite (OpenSSL cipher list format)
set certificate file
set private key file
set CA certificate for validating clients
script name to strip from URI if called by reverse proxy (default taken from HTTP_X_SCRIPT_NAME or SCRIPT_NAME)
validate user value (none|minimal|unicodeletter|unicode-none|strict)
validate path value (none|minimal|unicodeletter|unicode-none|strict)

encoding:

encoding for responding requests
encoding for storing local collections

auth:

backend specific options omitted
authentication method (none|remote_user|http_x_remote_ user|http_remote_user|denyall|htpasswd|ldap|imap|oauth 2|pam|dovecot)
cache successful/failed logins for until expiration time
do not cache successful/failed logins for until expiration time (opposite of --auth-cache-logins)
expiration time for caching successful logins in seconds
expiration time for caching failed logins in seconds
htpasswd filename
htpasswd encryption method
enable caching of htpasswd file
do not enable caching of htpasswd file (opposite of --auth-htpasswd-cache)
Connection type for dovecot authentication
dovecot auth AF_UNIX socket
dovecot auth AF_INET or AF_INET6 host
dovecot auth port
remote address source for passing it to auth method
message displayed when a password is needed
incorrect authentication delay
URI to the LDAP server
Base DN of the LDAP server
DN of an LDAP user with read access to users anmd - if defined - groups
Password of ldap_reader_dn (better: use ldap_secret_file)
Path to the file containing the password of ldap_reader_dn
Filter to search for the LDAP entry of the user to authenticate
Attribute to be used as username after authentication
Encryption mode to be used: *none*|tls|starttls
Certificate verification mode for tls and starttls. NONE, OPTIONAL, default is REQUIRED
Path to the CA file in PEM format which is used to certify the server certificate
Attribute in the user's LDAP entry to read the group memberships from
Attribute in the group entries to read the group's members from
Base DN to search for groups. Only if it differs from ldap_base and if ldap_group_members_attribute is set
Search filter to search for groups having the user as member. Only if ldap_group_members_attribute is set
Quirk for Authentik LDAP server: ignore modifyTimestamp and createTimestamp attributes.
do not Quirk for Authentik LDAP server: ignore modifyTimestamp and createTimestamp attributes. (opposite of --auth-ldap-ignore-attribute-createmodify-timestamp)
IMAP server hostname: address|address:port|[address]:port|*localhost*
Secure the IMAP connection: *tls*|starttls|none
Append '@' + domain to login before trying IMAP connection
OAuth2 token endpoint URL
OAuth2 client id
OAuth2 client secret
PAM group user should be member of
PAM service
strip domain from username
do not strip domain from username (opposite of --authstrip-domain)
convert username to uppercase, must be true for caseinsensitive auth providers
do not convert username to uppercase, must be true for case-insensitive auth providers (opposite of --authuc-username)
convert username to lowercase, must be true for caseinsensitive auth providers
do not convert username to lowercase, must be true for case-insensitive auth providers (opposite of --authlc-username)
url-decode the username, set to True when clients send url-encoded email address as username
do not url-decode the username, set to True when clients send url-encoded email address as username (opposite of --auth-urldecode-username)

group:

backend specific options omitted
group lookup method (none|from_auth|htgroup)
htpgroup filename
enable caching of htgroup file
do not enable caching of htgroup file (opposite of --group-htgroup-cache)
folder under collection_root_folder containing collections of base64 encoded group names

rights:

backend specific options omitted
rights backend
permit delete of a collection
do not permit delete of a collection (opposite of --rights-permit-delete-collection)
permit overwrite of a collection
do not permit overwrite of a collection (opposite of --rights-permit-overwrite-collection)
file for rights management from_file

storage:

backend specific options omitted
storage backend
path where collections are stored
path where cache of collections is stored in case of use_cache_subfolder_* options are active
use subfolder 'collection-cache' for 'item' cache file structure instead of inside collection folder
do not use subfolder 'collection-cache' for 'item' cache file structure instead of inside collection folder (opposite of --storage-use-cache-subfolder-foritem)
use subfolder 'collection-cache' for 'history' cache file structure instead of inside collection folder
do not use subfolder 'collection-cache' for 'history' cache file structure instead of inside collection folder (opposite of --storage-use-cache-subfolder-forhistory)
use subfolder 'collection-cache' for 'sync-token' cache file structure instead of inside collection folder
do not use subfolder 'collection-cache' for 'synctoken' cache file structure instead of inside collection folder (opposite of --storage-use-cachesubfolder-for-synctoken)
use mtime and file size instead of SHA256 for 'item' cache (improves speed)
do not use mtime and file size instead of SHA256 for 'item' cache (improves speed) (opposite of --storageuse-mtime-and-size-for-item-cache)
umask for folder creation (empty: system default)
delete sync token that are older
skip broken item instead of triggering exception
do not skip broken item instead of triggering exception (opposite of --storage-skip-broken-item)
command that is run after changes to storage
strict preconditions check on PUT
do not strict preconditions check on PUT (opposite of --storage-strict-preconditions)
predefined user collections

sharing:

backend specific options omitted
sharing database type
database path
enable sharing of collection by token
do not enable sharing of collection by token (opposite of --sharing-collection-by-token)
enable sharing of collection by map
do not enable sharing of collection by map (opposite of --sharing-collection-by-map)
permit create of token-based sharing
do not permit create of token-based sharing (opposite of --sharing-permit-create-token)
permit create of map-based sharing: true, self (to self only) or false
permit properties overlay
do not permit properties overlay (opposite of --sharing-permit-properties-overlay)
enforce properties overlay on write access
do not enforce properties overlay on write access (opposite of --sharing-enforce-properties-overlay)
default permissions for token-based sharing
default permissions for map-based sharing
conversion bday summary template
conversion bday description template
conversion bday alarm trigger template
conversion bday categories
conversion bday age max

hook:

backend specific options omitted
hook backend
dry-run (do not really trigger hook action)
do not dry-run (do not really trigger hook action) (opposite of --hook-dryrun)
endpoint where rabbitmq server is running
topic to declare queue
queue type for topic declaration
SMTP server to send emails
SMTP server port
SMTP security mode: *none*|tls|starttls
The certificate verification mode. Works for tls and starttls: NONE, OPTIONAL, default is REQUIRED
SMTP server username
SMTP server password (prefer smtp_password_file for secrets)
Path of the file containing the SMTP server password
Email address to use as sender in email notifications
Send one email to all attendees, versus one email per attendee
do not Send one email to all attendees, versus one email per attendee (opposite of --hook-mass-email)
Opt in to sending scheduling messages as iTIP (RFC 5546) over iMIP (RFC 6047), one per recipient with only that recipient listed, instead of a plain notification email with the full event attached. Defaults to False: iTIP messages are actionable invitations and cancellations, so enabling them must be deliberate. Set to False for the legacy behaviour.
do not Opt in to sending scheduling messages as iTIP (RFC 5546) over iMIP (RFC 6047), one per recipient with only that recipient listed, instead of a plain notification email with the full event attached. Defaults to False: iTIP messages are actionable invitations and cancellations, so enabling them must be deliberate. Set to False for the legacy behaviour. (opposite of --hook-itip-enabled)
Explicit actor-to-organizer-email map for iTIP, as actor=email pairs separated by commas, e.g. alice=alice@example.com. Required when itip_enabled is True. When set, only the mapped email for the authenticated actor counts as organizer ownership; unmapped actors send nothing, and an empty map with itip_enabled is a config error unless itip_organizer_is_username is True. The SMTP from_email is never used as ownership evidence. The user's own principal lists the mapped address first in calendar-user-address-set.
For iTIP, an actor whose username is an email address also owns that organizer address, without an itip_owner_map entry; an empty map is then allowed, and the user's own principal lists mailto:<username> in calendar-user-address-set. Only enable when usernames are emails the user cannot choose freely (e.g. single sign-on reverse proxy, LDAP mail as login).
do not For iTIP, an actor whose username is an email address also owns that organizer address, without an itip_owner_map entry; an empty map is then allowed, and the user's own principal lists mailto:<username> in calendar-user-address-set. Only enable when usernames are emails the user cannot choose freely (e.g. single sign-on reverse proxy, LDAP mail as login). (opposite of --hook-itip-organizer-isusername)
Template for the email sent when an event is created or attendee is added. Select placeholder words prefixed with $ will be replaced
Template for the email sent when an event is deleted or attendee is removed. Select placeholder words prefixed with $ will be replaced
Template for the email sent when an event is updated. Select placeholder words prefixed with $ will be replaced

web:

backend specific options omitted
web interface backend
prefer browser login
do not prefer browser login (opposite of --web-preferbrowser-login)

logging:

threshold for the logger
limit content of wrapped text (chars)
filter trace messages starting with '<TOKEN>'
log bad PUT request content
do not log bad PUT request content (opposite of --logging-bad-put-request-content)
log backtrace on level=debug
do not log backtrace on level=debug (opposite of --logging-backtrace-on-debug)
log request header on level=debug
do not log request header on level=debug (opposite of --logging-request-header-on-debug)
log request content on level=debug
do not log request content on level=debug (opposite of --logging-request-content-on-debug)
log response header on level=debug
do not log response header on level=debug (opposite of --logging-response-header-on-debug)
log response content on level=debug
do not log response content on level=debug (opposite of --logging-response-content-on-debug)
log request header on level=notice with condition
log request content on level=notice with condition
log response header on level=notice with condition
log response content on level=notice with condition
log rights rules which doesn't match on level=debug
do not log rights rules which doesn't match on level=debug (opposite of --logging-rights-rule-doesntmatch-on-debug)
log storage cache action on level=debug
do not log storage cache action on level=debug (opposite of --logging-storage-cache-actions-on-debug)
log profiling data level=info
log profiling data per request minimum duration (seconds)
Log profiling request body (if passing minimum duration)
do not Log profiling request body (if passing minimum duration) (opposite of --logging-profiling-perrequest-header)
Log profiling request XML (if passing minimum duration)
do not Log profiling request XML (if passing minimum duration) (opposite of --logging-profiling-perrequest-xml)
log profiling data per request method interval (seconds)
log profiling top X functions (limit)
mask passwords in logs
do not mask passwords in logs (opposite of --loggingmask-passwords)

headers:

additional options allowed (e.g. --headers-Pragma=no-cache)

reporting:

number of expand occurrences per event when reporting
number of free-busy occurrences per event when reporting
days before today in the default free-busy view
days after today in the default free-busy view
November 2026 radicale 3.9.1+ds-1