From 8d8259ee1f5834a99ee6a3a187d1fa90a1a309cf Mon Sep 17 00:00:00 2001 From: Github Actions <> Date: Mon, 13 Dec 2021 23:28:02 +0000 Subject: [PATCH] Generate documentation --- master.html | 51 +++++++++++++++++++++++++++++---------------------- v1.html | 50 +++++++++++++++----------------------------------- 2 files changed, 44 insertions(+), 57 deletions(-) diff --git a/master.html b/master.html index 53706922..60279ee0 100644 --- a/master.html +++ b/master.html @@ -247,9 +247,9 @@

Installation

Radicale is really easy to install and works out-of-the-box.

-
$ python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
-$ python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections
-

When the server is launched, open http://localhost:5232/ in your browser! You can login with any username and password.

+
python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
+python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections
+

When the server is launched, open http://localhost:5232 in your browser! You can login with any username and password.

Want more? Check the tutorials and the documentation.

@@ -272,7 +272,7 @@ # add the --user argument to only install for the current user $ python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz $ python3 -m radicale --storage-filesystem-folder=~/.var/lib/radicale/collections -

Victory! Open http://localhost:5232/ in your browser! You can log in with any username and password.

+

Victory! Open http://localhost:5232 in your browser! You can log in with any username and password.

Windows

@@ -280,7 +280,7 @@

Launch a command prompt and type:

C:\Users\User> python -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
 C:\Users\User> python -m radicale --storage-filesystem-folder=~/radicale/collections
-

Victory! Open http://localhost:5232/ in your browser! You can log in with any username and password.

+

Victory! Open http://localhost:5232 in your browser! You can log in with any username and password.

@@ -520,8 +520,10 @@ user2:password2

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 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, the values don't 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 -nodes -days 9999
+
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 \
+        -nodes -days 9999

Use the following configuration for Radicale:

[server]
 ssl = True
@@ -551,7 +553,8 @@ user2:password2
module = radicale env = RADICALE_CONFIG=/etc/radicale/config

Example Gunicorn configuration:

-
gunicorn --bind '127.0.0.1:5232' --workers 8 --env 'RADICALE_CONFIG=/etc/radicale/config' radicale
+
gunicorn --bind '127.0.0.1:5232' --env 'RADICALE_CONFIG=/etc/radicale/config' \
+         --workers 8 radicale

Manage user accounts with the WSGI server

Set the configuration option type in the auth section to remote_user. Radicale uses the user name provided by the WSGI server and disables authentication over HTTP.

@@ -561,7 +564,7 @@ user2:password2

Versioning with Git

This tutorial describes how to keep track of all changes to calendars and address books with git (or any other version control system).

The repository must be initialized by running git init in the file system folder. Internal files of Radicale can be excluded by creating the file .gitignore with the following content:

-
.Radicale.cache
+
.Radicale.cache
 .Radicale.lock
 .Radicale.tmp-*

 
The configuration option hook in the storage section must be set to the following command:

@@ -588,7 +591,9 @@ user2:password2
filesystem_folder = ~/.var/lib/radicale/collections

Radicale tries to load configuration files from /etc/radicale/config and ~/.config/radicale/config. Custom paths can be specified with the --config /path/to/config command line argument or the RADICALE_CONFIG environment variable. Multiple configuration files can be separated by : (resp. ; on Windows). Paths that start with ? are optional.

The same example configuration via command line arguments looks like:

-
python3 -m radicale --server-hosts 0.0.0.0:5232,[::]:5232 --auth-type htpasswd --auth-htpasswd-filename ~/.config/radicale/users --auth-htpasswd-encryption md5
+
python3 -m radicale --server-hosts 0.0.0.0:5232,[::]:5232 \
+        --auth-type htpasswd --auth-htpasswd-filename ~/.config/radicale/users \
+        --auth-htpasswd-encryption md5

Add the argument --config "" to stop Radicale from loading the default configuration files. Run python3 -m radicale --help for more information.

In the following, all configuration categories and options are described.

@@ -772,7 +777,7 @@ user2:password2
  • Mozilla Thunderbird with CardBook and Lightning
  • InfCloud, CalDavZAP and CardDavMATE
    • -

    Many clients do not support the creation of new calendars and address books. You can use Radicale's web interface (e.g. http://localhost:5232) to create and manage address books and calendars.

    +

    Many clients do not support the creation of new calendars and address books. You can use Radicale's web interface (e.g. http://localhost:5232) to create and manage address books and calendars.

    In some clients you can just enter the URL of the Radicale server (e.g. http://localhost:5232) and your user name. In others, you have to enter the URL of the collection directly (e.g. http://localhost:5232/user/calendar).

    DAVx⁵

    @@ -840,7 +845,7 @@ user2:password2 </create>'

    The collection /USERNAME will be created automatically, when the user authenticates to Radicale for the first time. Clients with automatic discovery of collections will only show calendars and address books that are direct children of the path /USERNAME/.

    Delete the collections by running something like:

    -
    $ curl -u user -X DELETE 'http://localhost:5232/user/calendar'
    +
    curl -u user -X DELETE 'http://localhost:5232/user/calendar'
    @@ -940,33 +945,35 @@ user2:password2

    Here is a simple overview of the global architecture for reaching a calendar or an address book through network:

    - + - - + + - + + - + - - + + - + + @@ -1088,12 +1095,12 @@ user2:password2

    PyPI

    Radicale is available on PyPI. To install, just type as superuser:

    -
    $ python3 -m pip install --upgrade radicale
    +
    python3 -m pip install --upgrade radicale

    Git Repository

    If you want the development version of Radicale, take a look at the git repository on GitHub, or install it directly with:

    -
    $ python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz
    +
    python3 -m pip install --upgrade https://github.com/Kozea/Radicale/archive/master.tar.gz

    You can also download the content of the repository as an archive.

    diff --git a/v1.html b/v1.html index 101039f4..38c0d030 100644 --- a/v1.html +++ b/v1.html @@ -407,22 +407,17 @@
    Evolution
    -
    -

    Calendars

    +

    ####### Calendars

    First of all, show the calendar page in Evolution by clicking on the calendar icon at the bottom of the side pane. Then add a new calendar by choosing in the menu File → New → Calendar.

    A new window opens. The calendar type is CalDAV, and the location is something like http://localhost:5232/user/calendar.ics/, where you can replace user and calendar by some strings of your choice. Calendars are automatically created if needed. Please note that the trailing slash is important.

    You can fill other attributes like the color and the name, these are only used for Evolution and are not uploaded.

    Click on OK, and your calendar should be ready for use.

    -
    -
    -

    Contacts

    +

    ####### Contacts

    Switch to the contacts page and click File → New → Adress book. In the new window choose WebDAV as type and something like http://localhost:5232/user/addressbook.vcf/ as location. Remember to enter the correct username.

    -
    KOrganizer
    -
    -

    Calendars

    +

    ####### Calendars

    Tested with 4.8.3, you need one running on Akonadi for Cal/CarDav support.

    The procedure below can also be done trough the sidebar "Calendar Manager". But to ensure it works for everyone this examples uses the menu-bar.

      @@ -448,12 +443,9 @@

      Note

      After you created a calender in a collection you can also use http://myserver:5232/Username/ as an URL This will then list all available calendars.

      -
    -
    -

    Contacts

    +

    ####### Contacts

    You can add a address book analogously to the above instructions, just choose CardDav and http://myserver:5232/Username/AddressBook.vcf/ in step 10 and 11. Also, if you already have a calendar set up you can add an address book to its "DAV groupware resource" under Configure-Kontact → Calendar → General → Calendars → Modify. This way you don't have to enter username and password twice.

    -
    CalendarSync

    CalendarSync can be combined with any Android calendar app and can even store the calendars in existing Android calendars which are synced by other sync adapters. Of course it can also create its own calendars.

    @@ -516,8 +508,7 @@
    InfCloud, CalDavZAP & CardDavMATE

    Because settings are the same for InfCloud, CalDavZAP and CardDavMATE
    only InfCloud is used in description below.

    -
    -

    Radicale configuration

    +

    ####### Radicale configuration

    Add/Modify the following section in Radicale main configuration file:

    # Additional HTTP headers
 [headers]
@@ -538,9 +529,7 @@ only InfCloud is used in description below.
    
 # collection: ^%(login)s/.+$    # DOES NOT WORK
 collection: ^%(login)s(/.+)?$
 permission: rw
    -
    -
    -

    InfCloud configuration

    +

    ####### InfCloud configuration

    Inside InfCloud configuration file config.js you need to set globalNetworkCheckSettings like following example:

    // href: 
 // put in here your protocol, host and port where Radicale is listening
@@ -583,11 +572,9 @@ Download and accept the certificate offered by the Radicale server.
    
 After installing and accepting it you should restart your browser.
    -
    iPhone & iPad
    -
    -

    Calendars

    +

    ####### Calendars

    For iOS devices, the setup is fairly straightforward but there are a few settings that are critical for proper operation.

    1. From the Home screen, open Settings
      2. @@ -606,9 +593,7 @@ After installing and accepting it you should restart your browser.

      Warning

      In iOS 5.x, please check twice that the Sync all entries option is activated, otherwise some events may not be shown in your calendar.

      -
    -
    -

    Contacts

    +

    ####### Contacts

    In Contacts on iOS 6:

    1. From the Home screen, open Settings
      2. @@ -628,15 +613,13 @@ After installing and accepting it you should restart your browser.

      You'll need version 0.8.1 or up for this to work. Earlier versions will forget your new settings after a reboot.

    -
    OS X

    Note

    This description assumes you do not have any authentication or encryption configured. If you want to use iCal with authentication or encryption, you just have to fill in the corresponding fields in your calendar's configuration.

    -
    -

    Calendars

    +

    ####### Calendars

    In iCal 4.0 or iCal 5.0:

    1. Open the Preferences dialog and select the Accounts tab
      2. @@ -657,9 +640,7 @@ After installing and accepting it you should restart your browser.

      To add a calendar to your shiny new account you have to go to the menu and select File → New Calendar → <your shiny new account>. A new calendar appears in the left panel waiting for you to enter a name.

      This is needed because the behaviour of the big + button in the main window is confusing as you can't focus an empty account and iCal will just add a calendar to another account.

      -
    -
    -

    Contacts

    +

    ####### Contacts

    In Contacts 7 (previously known as AddressBook):

    1. Open the Preferences dialog and select the Accounts tab.
      2. @@ -677,7 +658,6 @@ After installing and accepting it you should restart your browser.

      You'll need version 0.8.1 or up for this to work. Earlier versions can read CardDAV contacts but can't add new contacts.

    -
    syncEvolution

    You can find more information about syncEvolution and Radicale on the syncEvolution wiki page.

    @@ -916,7 +896,7 @@ After installing and accepting it you should restart your browser.

    Radicale uses the default logging facility for Python. The default configuration prints the information messages to the standard output. It is possible to print debug messages thanks to:

    radicale --debug

    Radicale can also be configured to send the messages to the console, logging files, syslog, etc. For more information about the syntax of the configuration file, see: http://docs.python.org/library/logging.config.html. Here is an example of logging configuration file:

    -
    # Loggers, handlers and formatters keys
+
    ## Loggers, handlers and formatters keys
 
 [loggers]
 # Loggers names, main configuration slots
@@ -931,7 +911,7 @@ After installing and accepting it you should restart your browser.
    
 keys = simple,full
 
 
-# Loggers
+## Loggers
 
 [logger_root]
 # Root logger
@@ -939,7 +919,7 @@ After installing and accepting it you should restart your browser.
    
 handlers = console,file
 
 
-# Handlers
+## Handlers
 
 [handler_console]
 # Console handler
@@ -955,7 +935,7 @@ After installing and accepting it you should restart your browser.
    
 formatter = full
 
 
-# Formatters
+## Formatters
 
 [formatter_simple]
 # Simple output format
@@ -1091,7 +1071,7 @@ After installing and accepting it you should restart your browser.
    
 # configuration files. Using these examples together in the same configuration
 # file is meaningless.
 #
-# The first rule matching both user and collection patterns will be returned.
+## The first rule matching both user and collection patterns will be returned.
 
 # This means all users starting with "admin" may read any collection
 [admin]
    Part Layer Protocol or Format
    Server
    Server Calendar/Contact Storage iCal/vCard
    '' Calendar/Contact Server CalDAV/CardDAV Server
    Transfer Network CalDAV/CardDAV (HTTP + TLS)
    Client
    Client Calendar/Contact Client CalDAV/CardDAV Client
    '' GUI Terminal, GTK, Web interface, etc.