table of contents
other versions
- trixie 3.5.3-1
- testing 3.5.3-1
- unstable 3.5.3-1
- experimental 3.5.4-1
RADICALE(1) | User Commands | RADICALE(1) |
NAME¶
radicale - a simple calendar server
DESCRIPTION¶
usage: radicale [OPTIONS]
options:¶
- -h, --help
- show this help message and exit
- --version
- show program's version number and exit
- --verify-storage
- check the storage for errors and exit
- -C [CONFIG ...], --config [CONFIG ...]
- use specific configuration files
- -D, --debug
- print debug information
server:¶
- -H VALUE, --hosts VALUE, --server-hosts VALUE
- set server hostnames including ports
- --server-max-connections VALUE
- maximum number of parallel connections
- --server-max-content-length VALUE
- maximum size of request body in bytes
- --server-timeout VALUE
- socket timeout
- -s [VALUE], --ssl [VALUE], --server-ssl [VALUE]
- use SSL connection
- -S, --no-ssl, --no-server-ssl
- do not use SSL connection (opposite of --server-ssl)
- -c VALUE, --certificate VALUE, --server-certificate VALUE
- set certificate file
- -k VALUE, --key VALUE, --server-key VALUE
- set private key file
- --certificate-authority VALUE, --server-certificate-authority VALUE
- set CA certificate for validating clients
encoding:¶
- --encoding-request VALUE
- encoding for responding requests
- --encoding-stock VALUE
- encoding for storing local collections
auth:¶
- backend specific options omitted
- --auth-type VALUE
- authentication method
- --auth-htpasswd-filename VALUE
- htpasswd filename
- --auth-htpasswd-encryption VALUE
- htpasswd encryption method
- --auth-realm VALUE
- message displayed when a password is needed
- --auth-delay VALUE
- incorrect authentication delay
- --auth-ldap-uri VALUE
- URI to the ldap server
- --auth-ldap-base VALUE
- LDAP base DN of the ldap server
- --auth-ldap-reader-dn VALUE
- the DN of a ldap user with read access to get the user accounts
- --auth-ldap-secret VALUE
- the password of the ldap_reader_dn
- --auth-ldap-filter VALUE
- the search filter to find the user DN to authenticate by the username
- --auth-ldap-load-groups [VALUE]
- load the ldap groups of the authenticated user
- --no-auth-ldap-load-groups
- do not load the ldap groups of the authenticated user (opposite of --auth-ldap-load-groups)
- --auth-ldap-use-ssl [VALUE]
- Use ssl on the ldap connection
- --no-auth-ldap-use-ssl
- do not Use ssl on the ldap connection (opposite of --auth-ldap-use-ssl)
- --auth-ldap-ssl-verify-mode VALUE
- The certifikat verification mode. NONE, OPTIONAL, default is REQUIRED
- --auth-ldap-ssl-ca-file VALUE
- The path to the CA file in pem format which is used to certificate the server certificate
- --auth-strip-domain [VALUE]
- strip domain from username
- --no-auth-strip-domain
- do not strip domain from username (opposite of --authstrip-domain)
- --auth-lc-username [VALUE]
- convert username to lowercase, must be true for caseinsensitive auth providers
- --no-auth-lc-username
- do not convert username to lowercase, must be true for case-insensitive auth providers (opposite of --authlc-username)
rights:¶
- backend specific options omitted
- --rights-type VALUE
- rights backend
- --rights-permit-delete-collection [VALUE]
- permit delete of a collection
- --no-rights-permit-delete-collection
- do not permit delete of a collection (opposite of --rights-permit-delete-collection)
- --rights-permit-overwrite-collection [VALUE]
- permit overwrite of a collection
- --no-rights-permit-overwrite-collection
- do not permit overwrite of a collection (opposite of --rights-permit-overwrite-collection)
- --rights-file VALUE
- file for rights management from_file
storage:¶
- backend specific options omitted
- --storage-type VALUE
- storage backend
- --storage-filesystem-folder VALUE
- path where collections are stored
- --storage-max-sync-token-age VALUE
- delete sync token that are older
- --storage-skip-broken-item [VALUE]
- skip broken item instead of triggering exception
- --no-storage-skip-broken-item
- do not skip broken item instead of triggering exception (opposite of --storage-skip-broken-item)
- --storage-hook VALUE
- command that is run after changes to storage
- --storage-predefined-collections VALUE
- predefined user collections
hook:¶
- backend specific options omitted
- --hook-type VALUE
- hook backend
- --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
web:¶
- backend specific options omitted
- --web-type VALUE
- web interface backend
logging:¶
- --logging-level VALUE
- threshold for the logger
- --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-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-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)
- --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-freebusy-occurrence VALUE
- number of occurrences per event when reporting
October 2024 | radicale 3.3.0-1 |