oss/Radicale
oss/Radicale
1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-09-30 21:12:05 +00:00
Code Wiki Activity

Merge pull request #1876 from marschap/tiny-doc-fixes

Browse source 
DOCUMENTATION.md: fix small glitches: typos, ...
This commit is contained in:
Peter Bieringer 2025-09-23 07:54:14 +02:00 • committed by GitHub
commit fd955c967c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

30
DOCUMENTATION.md
View file

@ -166,7 +166,7 @@ The `users` file can be created and managed with
Note: some OSes or distributions contain outdated versions of `htpasswd` (< 2.4.59) without Note: some OSes or distributions contain outdated versions of `htpasswd` (< 2.4.59) without
support for SHA-256 or SHA-512 (e.g. Ubuntu LTS 22). support for SHA-256 or SHA-512 (e.g. Ubuntu LTS 22).
In these cases use `htpasswd`'s command line option `-B` for the `bcrypt` hash method (recommended), In these cases, use `htpasswd`'s command line option `-B` for the `bcrypt` hash method (recommended),
or stay with the insecure (not recommended) MD5 (default) or SHA-1 (command line option `-s`). or stay with the insecure (not recommended) MD5 (default) or SHA-1 (command line option `-s`).
Note: support of SHA-256 and SHA-512 was introduced with 3.1.9 Note: support of SHA-256 and SHA-512 was introduced with 3.1.9
@ -273,13 +273,13 @@ Create the **radicale** user and group for the Radicale service by running (as `
useradd --system --user-group --home-dir / --shell /sbin/nologin radicale useradd --system --user-group --home-dir / --shell /sbin/nologin radicale
``` ```
The storage folder must be writable by the **radicale** user by running (as `root`): The storage folder must be made writable by the **radicale** user by running (as `root`):
```bash ```bash
mkdir -p /var/lib/radicale/collections && chown -R radicale:radicale /var/lib/radicale/collections mkdir -p /var/lib/radicale/collections && chown -R radicale:radicale /var/lib/radicale/collections
``` ```
If a dedicated cache folder is configured (see option [filesystem_cache_folder](#filesystem_cache_folder)), If a dedicated cache folder is configured (see option [filesystem_cache_folder](#filesystem_cache_folder)),
it also must be also writable by **radicale**. To achieva that, run (as `root`): it also must be made writable by **radicale**. To achieve that, run (as `root`):
```bash ```bash
mkdir -p /var/cache/radicale && chown -R radicale:radicale /var/cache/radicale mkdir -p /var/cache/radicale && chown -R radicale:radicale /var/cache/radicale
```` ````
@ -573,10 +573,10 @@ RequestHeader set X-Remote-User expr=%{REMOTE_USER}
#### Secure connection between Radicale and the reverse proxy #### Secure connection between Radicale and the reverse proxy
SSL certificates can be used to encrypt and authenticate the connection between SSL certificates can be used to encrypt and authenticate the connection between
Radicale and the reverse proxy. First you have to generate a certificate for Radicale and the reverse proxy. First you need to generate a certificate for
Radicale and a certificate for the reverse proxy. The following commands Radicale and a certificate for the reverse proxy. The following commands
generate self-signed certificates. You will be asked to enter additional generate self-signed certificates. You will be asked to enter additional
information about the certificate, these values do not really matter and you can information about the certificate, these values do not really matter, and you can
keep the defaults. keep the defaults.
```bash ```bash
@ -811,7 +811,7 @@ Default: `False`
##### certificate ##### certificate
Path of the SSL certifcate. Path of the SSL certificate.
Default: `/etc/ssl/radicale.cert.pem` Default: `/etc/ssl/radicale.cert.pem`
@ -959,7 +959,7 @@ Default: `/etc/radicale/users`
The encryption method that is used in the htpasswd file. Use The encryption method that is used in the htpasswd file. Use
[htpasswd](https://httpd.apache.org/docs/current/programs/htpasswd.html) [htpasswd](https://httpd.apache.org/docs/current/programs/htpasswd.html)
or similar to generate this files. or similar to generate this file.
Available methods: Available methods:
@ -1140,7 +1140,7 @@ If set, get the user's LDAP groups from the attribute given.
For DN-valued attributes, the value of the RDN is used to determine the group names. For DN-valued attributes, the value of the RDN is used to determine the group names.
The implementation also supports non-DN-valued attributes: their values are taken directly. The implementation also supports non-DN-valued attributes: their values are taken directly.
The user's group names can be used later on to define rights. The user's group names can be used later to define rights.
They also give you access to the group calendars, if those exist. They also give you access to the group calendars, if those exist.
* Group calendars are placed directly under *collection_root_folder*`/GROUPS/` * Group calendars are placed directly under *collection_root_folder*`/GROUPS/`
with the base64-encoded group name as the calendar folder name. with the base64-encoded group name as the calendar folder name.
@ -1525,7 +1525,7 @@ Default: `True`
##### hook ##### hook
Command that is run after changes to storage. Take a look at the Command that is run after changes to storage. See the
[Versioning collections with Git](#versioning-collections-with-git) [Versioning collections with Git](#versioning-collections-with-git)
tutorial for an example. tutorial for an example.
@ -2006,8 +2006,8 @@ It will list your existing address books.
#### InfCloud, CalDavZAP and CardDavMATE #### InfCloud, CalDavZAP and CardDavMATE
You can integrate InfCloud into Radicale's web interface with by simply You can integrate InfCloud into Radicale's web interface with by simply
download latest package from [InfCloud](https://www.inf-it.com/open-source/clients/infcloud/) downloading the latest package from [InfCloud](https://www.inf-it.com/open-source/clients/infcloud/)
and extract content to new folder `infcloud` in `radicale/web/internal_data/`. and extract the content into a folder named `infcloud` in `radicale/web/internal_data/`.
No further adjustments are required as content is adjusted on the fly (tested with 0.13.1). No further adjustments are required as content is adjusted on the fly (tested with 0.13.1).
@ -2137,10 +2137,10 @@ The following `permissions` are recognized:
(CalDAV/CardDAV is susceptible to expensive search requests) (CalDAV/CardDAV is susceptible to expensive search requests)
* **W:** write collections (excluding address books and calendars) * **W:** write collections (excluding address books and calendars)
* **w:** write address book and calendar collections * **w:** write address book and calendar collections
* **D:** permit delete of collection in case `permit_delete_collection=False` _(>= 3.3.0)_ * **D:** allow deleting a collection in case `permit_delete_collection=False` _(>= 3.3.0)_
* **d:** forbid delete of collection in case `permit_delete_collection=True` _(>= 3.3.0)_ * **d:** deny deleting a collection in case `permit_delete_collection=True` _(>= 3.3.0)_
* **O:** permit overwrite of collection in case `permit_overwrite_collection=False` * **O:** allow overwriting a collection in case `permit_overwrite_collection=False`
* **o:** forbid overwrite of collection in case `permit_overwrite_collection=True` * **o:** deny overwriting a collection in case `permit_overwrite_collection=True`
### Storage ### Storage