RADICALE(1)

📦
version 3.7.8 · 7 versions
, in ubuntu stonking

💖 NAME 💖

radicale — bestie, it's literally a simple calendar server 💅 (this is the radicale(1) page from User Commands, and yes she ate)

✨ DESCRIPTION ✨

okay so here's the whole vibe, the entire invocation of this thing is:

usage: radicale [OPTIONS]

that's it, that's the shape of it 🫶 now let's get into the good stuff.

🎀 options: 🎀

the general-usage girlies, the ones who apply no matter what:

  • -h, --help — shows you this exact help message and then dips, exits. iconic behaviour tbh 🎀
  • --version — prints the program's version number and yeets itself out, exits ✨
  • --verify-storage — goes through the storage looking for errors, then exits. a little wellness check for your data 💖
  • --verify-item VERIFY_ITEM — same energy but for one specific item file you point at, checks it for errors and exits 🔍
  • --verify-sharing — runs an error check over the sharing database and exits 🦋
  • -C, --config [CONFIG ...] — use specific configuration files, plural, you can pass a whole list bestie 📂
  • -D, --debug — spills the debug information, the juicy behind-the-scenes tea ☕

🖥️ server: 🖥️

the main-character section, this is where the server itself gets configured:

  • -H, --hosts, --server-hosts VALUE — sets the server hostnames, ports included, don't forget the ports 👑
  • --server-max-connections VALUE — the maximum number of parallel connections allowed at once, no crowding the function 💅
  • --server-max-content-length VALUE — biggest allowed request body size in bytes (default: 100 Mbyte) 📏
  • --server-delay-on-error VALUE — the base delay used when a 5xx error response happens, in seconds ⏳
  • --server-max-resource-size VALUE — max size of a resource (default: 10 Mbyte) 🌸
  • --server-max-vevent-rrule-occurrence VALUE — max occurrence by an RRULE (default: 10000). yes the recurring events have a limit, periodt 🔁
  • --server-timeout VALUE — the socket timeout ⏱️
  • -s, --ssl, --server-ssl [VALUE] — use an SSL connection, secure-girl behaviour 🔒
  • -S, --no-ssl, --no-server-ssl — do not use an SSL connection (it's the exact opposite of --server-ssl) 🙈
  • --server-protocol VALUE — the SSL/TLS protocol, written in Apache SSLProtocol format 🌈
  • --server-ciphersuite VALUE — the SSL/TLS Cipher Suite, in OpenSSL cipher list format 🔐
  • -c, --certificate, --server-certificate VALUE — set the certificate file 🎀
  • -k, --key, --server-key VALUE — set the private key file 🗝️
  • --certificate-authority, --server-certificate-authority VALUE — set the CA certificate used for validating clients, so you know who's at the door 👀
  • --server-script-name VALUE — the script name to strip from the URI when you're being called by a reverse proxy (default is taken from HTTP_X_SCRIPT_NAME or SCRIPT_NAME) 🧚
  • --server-validate-user-value VALUE — validates the user value. options are: none | minimal | unicodeletter | unicode-none | strict ✅
  • --server-validate-path-value VALUE — validates the path value. same menu: none | minimal | unicodeletter | unicode-none | strict ✅

🔤 encoding: 🔤

  • --encoding-request VALUE — the encoding used for responding to requests 💬
  • --encoding-stock VALUE — the encoding used for storing local collections 🗄️

🔑 auth: 🔑 (authentication, the bouncer at the club)

backend specific options omitted — yes bestie, they really are omitted in this listing, i don't make the rules 🙈
  • --auth-type VALUE — which authentication method you want: none | remote_user | http_x_remote_user | http_remote_user | denyall | htpasswd | ldap | imap | oauth2 | pam | dovecot 💅
  • --auth-cache-logins [VALUE] — caches successful and failed logins until the expiration time hits 🕰️
  • --no-auth-cache-logins — do not cache successful/failed logins until expiration time (the opposite of --auth-cache-logins) 🚫
  • --auth-cache-successful-logins-expiry VALUE — expiration time in seconds for the cached successful logins ⏲️
  • --auth-cache-failed-logins-expiry VALUE — expiration time in seconds for the cached failed logins 💀
  • --auth-htpasswd-filename VALUE — the htpasswd filename 📄
  • --auth-htpasswd-encryption VALUE — the htpasswd encryption method 🔐
  • --auth-htpasswd-cache [VALUE] — turns on caching of the htpasswd file ⚡
  • --no-auth-htpasswd-cache — does not enable caching of the htpasswd file (opposite of --auth-htpasswd-cache) 🚫
  • --auth-dovecot-connection-type VALUE — the Connection type for dovecot authentication 🕊️
  • --auth-dovecot-socket VALUE — the dovecot auth AF_UNIX socket 🔌
  • --auth-dovecot-host VALUE — the dovecot auth AF_INET or AF_INET6 host 🌐
  • --auth-dovecot-port VALUE — the dovecot auth port 🚪
  • --auth-remote-ip-source VALUE — the remote address source, so it can get passed along to the auth method 📬
  • --auth-realm VALUE — the message that gets displayed when a password is needed 🗣️
  • --auth-delay VALUE — the delay on an incorrect authentication ⏳
  • --auth-ldap-uri VALUE — URI pointing at the LDAP server 🧭
  • --auth-ldap-base VALUE — the Base DN of the LDAP server 🌳
  • --auth-ldap-reader-dn VALUE — DN of an LDAP user with read access to users anmd — if defined — groups (yes, "anmd", we keep it exactly as written, no notes 💀)
  • --auth-ldap-secret VALUE — the Password of ldap_reader_dn (but honestly bestie: use ldap_secret_file instead, it's the safer glow-up) 🔒
  • --auth-ldap-secret-file VALUE — Path to the file containing the password of ldap_reader_dn 📁
  • --auth-ldap-filter VALUE — the Filter used to search for the LDAP entry of the user you're authenticating 🔎
  • --auth-ldap-user-attribute VALUE — the Attribute that gets used as username after authentication 🏷️
  • --auth-ldap-security VALUE — the Encryption mode to use: *none* | tls | starttls 🛡️
  • --auth-ldap-ssl-verify-mode VALUE — Certificate verification mode for tls and starttls. Options are NONE, OPTIONAL, and the default is REQUIRED 👀
  • --auth-ldap-ssl-ca-file VALUE — Path to the CA file in PEM format, the one used to certify the server certificate 📜
  • --auth-ldap-groups-attribute VALUE — the Attribute in the user's LDAP entry that the group memberships get read from 👥
  • --auth-ldap-group-members-attribute VALUE — the Attribute in the group entries that the group's members get read from 🫂
  • --auth-ldap-group-base VALUE — Base DN to search for groups. Only used if it differs from ldap_base and if ldap_group_members_attribute is set 🧩
  • --auth-ldap-group-filter VALUE — Search filter for finding groups that have the user as a member. Only used if ldap_group_members_attribute is set 🔍
  • --auth-ldap-ignore-attribute-create-modify-timestamp [VALUE] — a Quirk for the Authentik LDAP server: it makes you ignore the modifyTimestamp and createTimestamp attributes 🙃
  • --no-auth-ldap-ignore-attribute-create-modify-timestamp — does not Quirk for Authentik LDAP server: ignore modifyTimestamp and createTimestamp attributes. (this is the opposite of --auth-ldap-ignore-attribute-createmodify-timestamp) 🚫
  • --auth-imap-host VALUE — the IMAP server hostname, in the form address | address:port | [address]:port | *localhost* 📮
  • --auth-imap-security VALUE — secures the IMAP connection: *tls* | starttls | none 🔒
  • --auth-imap-append-domain VALUE — appends '@' + domain to the login before it even tries the IMAP connection ➕
  • --auth-oauth2-token-endpoint VALUE — the OAuth2 token endpoint URL 🔗
  • --auth-oauth2-client-id VALUE — the OAuth2 client id 🪪
  • --auth-oauth2-client-secret VALUE — the OAuth2 client secret 🤫
  • --auth-pam-group-membership VALUE — the PAM group the user should be a member of 👯
  • --auth-pam-service VALUE — the PAM service 🛎️
  • --auth-strip-domain [VALUE] — strips the domain from the username ✂️
  • --no-auth-strip-domain — does not strip the domain from the username (opposite of --authstrip-domain) 🚫
  • --auth-uc-username [VALUE] — converts the username to uppercase, must be true for caseinsensitive auth providers ⬆️
  • --no-auth-uc-username — does not convert the username to uppercase, must be true for case-insensitive auth providers (opposite of --authuc-username) 🚫
  • --auth-lc-username [VALUE] — converts the username to lowercase, must be true for caseinsensitive auth providers ⬇️
  • --no-auth-lc-username — does not convert the username to lowercase, must be true for case-insensitive auth providers (opposite of --authlc-username) 🚫
  • --auth-urldecode-username [VALUE] — url-decodes the username. set this to True when clients send a url-encoded email address as the username 📧
  • --no-auth-urldecode-username — does not url-decode the username. set to True when clients send a url-encoded email address as username (opposite of --auth-urldecode-username) 🚫

🛂 rights: 🛂

who's allowed to do what, the rules of the group chat:

backend specific options omitted — again bestie, that's just what the page says 🙈
  • --rights-type VALUE — the rights backend 🏗️
  • --rights-permit-delete-collection [VALUE] — permits deleting of a collection 🗑️
  • --no-rights-permit-delete-collection — does not permit delete of a collection (opposite of --rights-permit-delete-collection) 🚫
  • --rights-permit-overwrite-collection [VALUE] — permits overwriting of a collection ♻️
  • --no-rights-permit-overwrite-collection — does not permit overwrite of a collection (opposite of --rights-permit-overwrite-collection) 🚫
  • --rights-file VALUE — the file used for rights management from_file 📁

📦 storage: 📦

where all your precious data actually lives:

backend specific options omitted — one more time, that's the word from the page ✨
  • --storage-type VALUE — the storage backend 🏗️
  • --storage-filesystem-folder VALUE — the path where collections are stored 📂
  • --storage-filesystem-cache-folder VALUE — the path where the cache of collections is stored in case any of the use_cache_subfolder_* options are active 🗃️
  • --storage-use-cache-subfolder-for-item [VALUE] — uses the subfolder 'collection-cache' for the 'item' cache file structure instead of keeping it inside the collection folder 🗂️
  • --no-storage-use-cache-subfolder-for-item — does not use the subfolder 'collection-cache' for the 'item' cache file structure instead of inside the collection folder (opposite of --storage-use-cache-subfolder-foritem) 🚫
  • --storage-use-cache-subfolder-for-history [VALUE] — uses the subfolder 'collection-cache' for the 'history' cache file structure instead of inside the collection folder ⏳
  • --no-storage-use-cache-subfolder-for-history — does not use the subfolder 'collection-cache' for the 'history' cache file structure instead of inside the collection folder (opposite of --storage-use-cache-subfolder-forhistory) 🚫
  • --storage-use-cache-subfolder-for-synctoken [VALUE] — uses the subfolder 'collection-cache' for the 'sync-token' cache file structure instead of inside the collection folder 🔄
  • --no-storage-use-cache-subfolder-for-synctoken — does not use the subfolder 'collection-cache' for the 'synctoken' cache file structure instead of inside the collection folder (opposite of --storage-use-cachesubfolder-for-synctoken) 🚫
  • --storage-use-mtime-and-size-for-item-cache [VALUE] — uses mtime and file size instead of SHA256 for the 'item' cache (it improves speed, lowkey a glow-up) ⚡
  • --no-storage-use-mtime-and-size-for-item-cache — does not use mtime and file size instead of SHA256 for 'item' cache (improves speed) (opposite of --storageuse-mtime-and-size-for-item-cache) 🚫
  • --storage-folder-umask VALUE — the umask for folder creation (empty means: system default) 🎭
  • --storage-max-sync-token-age VALUE — deletes sync token that are older 🕰️
  • --storage-skip-broken-item [VALUE] — skips broken item instead of triggering an exception 🩹
  • --no-storage-skip-broken-item — does not skip broken item instead of triggering exception (opposite of --storage-skip-broken-item) 🚫
  • --storage-hook VALUE — the command that is run after changes to storage 🪝

okay bestie that's part one, don't go anywhere, there's more coming 💜

  • --storage-strict-preconditions [VALUE] — strict preconditions check on PUT, bestie. It's giving "no shortcuts" energy. 💅
  • --no-storage-strict-preconditions — do not strict preconditions check on PUT (opposite of --storage-strict-preconditions) 🙈
  • --storage-predefined-collections VALUE — predefined user collections, slay. ✨

🌸 sharing: 🌸

backend specific options omitted (iykyk, they're just not here)

  • --sharing-type VALUE — sharing database type
  • --sharing-database-path VALUE — database path
  • --sharing-collection-by-token [VALUE] — enable sharing of collection by token
  • --no-sharing-collection-by-token — do not enable sharing of collection by token (opposite of --sharing-collection-by-token)
  • --sharing-collection-by-map [VALUE] — enable sharing of collection by map
  • --no-sharing-collection-by-map — do not enable sharing of collection by map (opposite of --sharing-collection-by-map)
  • --sharing-permit-create-token [VALUE] — permit create of token-based sharing
  • --no-sharing-permit-create-token — do not permit create of token-based sharing (opposite of --sharing-permit-create-token)
  • --sharing-permit-create-map [VALUE] — permit create of map-based sharing
  • --no-sharing-permit-create-map — do not permit create of map-based sharing (opposite of --sharing-permit-create-map)
  • --sharing-permit-properties-overlay [VALUE] — permit properties overlay
  • --no-sharing-permit-properties-overlay — do not permit properties overlay (opposite of --sharing-permit-properties-overlay)
  • --sharing-enforce-properties-overlay [VALUE] — enforce properties overlay on write access
  • --no-sharing-enforce-properties-overlay — do not enforce properties overlay on write access (opposite of --sharing-enforce-properties-overlay)
  • --sharing-default-permissions-create-token VALUE — default permissions for token-based sharing
  • --sharing-default-permissions-create-map VALUE — default permissions for map-based sharing
  • --sharing-conversion-bday-summary-template VALUE — conversion bday summary template
  • --sharing-conversion-bday-description-template VALUE — conversion bday description template
  • --sharing-conversion-bday-alarm-trigger-template VALUE — conversion bday alarm trigger template
  • --sharing-conversion-bday-categories VALUE — conversion bday categories
  • --sharing-conversion-bday-age-max VALUE — conversion bday age max

🦋 hook: 🦋

backend specific options omitted (again, not here but they exist)

  • --hook-type VALUE — hook backend
  • --hook-dryrun [VALUE] — dry-run (do not really trigger hook action)
  • --no-hook-dryrun — do not dry-run (do not really trigger hook action) (opposite of --hook-dryrun)
  • --hook-rabbitmq-endpoint VALUE — endpoint where rabbitmq server is running
  • --hook-rabbitmq-topic VALUE — topic to declare queue
  • --hook-rabbitmq-queue-type VALUE — queue type for topic declaration
  • --hook-smtp-server VALUE — SMTP server to send emails
  • --hook-smtp-port VALUE — SMTP server port
  • --hook-smtp-security VALUE — SMTP security mode: none|tls|starttls
  • --hook-smtp-ssl-verify-mode VALUE — The certificate verification mode. Works for tls and starttls: NONE, OPTIONAL, default is REQUIRED
  • --hook-smtp-username VALUE — SMTP server username
  • --hook-smtp-password VALUE — SMTP server password
  • --hook-from-email VALUE — SMTP server password (yes, same description, we don't make the rules lol)
  • --hook-mass-email [VALUE] — Send one email to all attendees, versus one email per attendee
  • --no-hook-mass-email — do not Send one email to all attendees, versus one email per attendee (opposite of --hook-mass-email)
  • --hook-new-or-added-to-event-template VALUE — Template for the email sent when an event is created or attendee is added. Select placeholder words prefixed with $ will be replaced
  • --hook-deleted-or-removed-from-event-template VALUE — Template for the email sent when an event is deleted or attendee is removed. Select placeholder words prefixed with $ will be replaced
  • --hook-updated-event-template VALUE — Template for the email sent when an event is updated. Select placeholder words prefixed with $ will be replaced

🌈 web: 🌈

backend specific options omitted (you know the drill)

  • --web-type VALUE — web interface backend
  • --web-prefer-browser-login [VALUE] — prefer browser login
  • --no-web-prefer-browser-login — do not prefer browser login (opposite of --web-preferbrowser-login) (yep, typo in the original, we keep it fr fr)

✨ logging: ✨

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

🎀 headers: 🎀

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

👑 reporting: 👑

  • --reporting-max-expand-occurrence VALUE — number of expand occurrences per event when reporting
  • --reporting-max-freebusy-occurrence VALUE — number of free-busy occurrences per event when reporting

That's the whole vibe for radicale 3.7.8+ds-3, dated August 2026. Stay iconic, bestie! 🫶✨

📦 where this page comes from