From 07407e3918edd4ef7f00ad1ce4026a3d7ce49c56 Mon Sep 17 00:00:00 2001 From: Github Actions <> Date: Tue, 23 Sep 2025 05:56:26 +0000 Subject: [PATCH] Generate documentation --- master.html | 45 +++++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/master.html b/master.html index 06ac6f3e..0319a9b9 100644 --- a/master.html +++ b/master.html @@ -416,10 +416,11 @@ file.

The users file can be created and managed with htpasswd:

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). 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).

+SHA-512 (e.g. Ubuntu LTS 22). 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).

Note: support of SHA-256 and SHA-512 was introduced with 3.1.9

# Create a new htpasswd file with the user "user1" using SHA-512 as hash method
 $ htpasswd -5 -c /path/to/users user1
@@ -501,11 +502,11 @@ instead of manual setup / initial configuration.

 
Create the radicale user and group for the Radicale
 service by running (as root:

 
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):

 
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), it also
-must be also writable by radicale. To achieva that, run
+must be made writable by radicale. To achieve that, run
 (as root):

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

 

@@ -754,11 +755,11 @@ listening to the loopback interface only or local firewall rules.

 

 
Secure connection between Radicale and the reverse proxy 

 
SSL certificates can be used to encrypt and authenticate the
-connection between Radicale and the reverse proxy. First you have to
+connection between Radicale and the reverse proxy. First you need to
 generate a certificate for Radicale and a certificate for the reverse
 proxy. The following commands generate self-signed certificates. You
 will be asked to enter additional information about the certificate,
-these values do not really matter and you can keep the defaults.

+these values do not really matter, and you can keep the defaults.

 
openssl req -x509 -newkey rsa:4096 -keyout server_key.pem -out server_cert.pem \
         -nodes -days 9999
 openssl req -x509 -newkey rsa:4096 -keyout client_key.pem -out client_cert.pem \
@@ -944,7 +945,7 @@ option

 

 

 
certificate 

-
Path of the SSL certifcate.

+
Path of the SSL certificate.

 
Default: /etc/ssl/radicale.cert.pem

 

 

@@ -1073,7 +1074,7 @@ avoid overload of authentication backends.

 

 
htpasswd_encryption 

 
The encryption method that is used in the htpasswd file. Use htpasswd
-or similar to generate this files.

+or similar to generate this file.

 
Available methods:

 
    
 
  • plain
    
@@ -1227,8 +1228,8 @@ alikes, groupMembership on Novell eDirectory, ...
    
 
    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 user's group names can be used later on to define rights. They
-also give you access to the group calendars, if those exist.
    
+
    The user's group names can be used later to define rights. They also
+give you access to the group calendars, if those exist.
    
 
      
 
    • Group calendars are placed directly under
 collection_root_folder/GROUPS/ with the
@@ -1583,7 +1584,7 @@ seconds).
      
 

 

 
hook 

-
Command that is run after changes to storage. Take a look at the Versioning collections with
+
Command that is run after changes to storage. See the Versioning collections with
 Git tutorial for an example.

 
Default: (unset)

 
Supported placeholders:

@@ -1984,8 +1985,8 @@ ones.

 

 

 
OneCalendar 

-
When adding account, select CalDAV account type, then enter user
-name, password and the Radicale server (e.g.
+
When adding account, select CalDAV account type, then enter username,
+password and the Radicale server (e.g.
 https://yourdomain:5232). OneCalendar will show all
 existing calendars and (FIXME: address books), you need to select which
 ones you want to see. OneCalendar supports many other server types
@@ -2035,8 +2036,8 @@ username and password. It will list your existing address books.

 

 
InfCloud, CalDavZAP and CardDavMATE 

 
You can integrate InfCloud into Radicale's web interface with by
-simply download latest package from InfCloud
-and extract content to new folder infcloud in
+simply downloading the latest package from InfCloud
+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).

@@ -2152,13 +2153,13 @@ expensive search requests)
 
  • W: write collections (excluding address books and
 calendars)
    • 
 
  • w: write address book and calendar collections
    • 
-
  • D: permit delete of collection in case
+
  • D: allow deleting a collection in case
 permit_delete_collection=False (>= 3.3.0)
    • 
-
  • d: forbid delete of collection in case
+
  • d: deny deleting a collection in case
 permit_delete_collection=True (>= 3.3.0)
    • 
-
  • O: permit overwrite of collection in case
+
  • O: allow overwriting a collection in case
 permit_overwrite_collection=False
    • 
-
  • o: forbid overwrite of collection in case
+
  • o: deny overwriting a collection in case
 permit_overwrite_collection=True
    •