@@ -31,7 +31,7 @@ to http://localhost:5232/ with your browser!
31
31
You can login with any username and password.
32
32
33
33
Want more? Why don't you check our wonderful
34
- [ documentation] ( #documentation ) ?
34
+ [ documentation] ( #documentation-1 ) ?
35
35
36
36
#### What's New?
37
37
@@ -45,41 +45,41 @@ released on May 19, 2020
45
45
46
46
This documentation page is written for version 2.x.x. If you want to update
47
47
Radicale from 1.x.x to 2.x.x, please follow
48
- our [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) . You can find on GitHub the
48
+ our [ migration guide] ( #migration-from-1xx-to-2xx ) . You can find on GitHub the
49
49
[ documentation page for the 1.1.x versions] ( 1.1.x.html ) .
50
50
51
51
#### Install and Set Up
52
52
53
53
You're new to Radicale and you want to know how to use it? Welcome aboard!
54
54
55
55
- [ What is Radicale?] ( #about )
56
- - [ A really simple 5-minute tutorial.] ( #documentation/ tutorial )
57
- - [ A simple but solid setup.] ( #documentation/ basic-setup )
58
- - [ Run behind a reverse proxy.] ( #documentation/ reverse-proxy )
59
- - [ Run with a WSGI server.] ( #documentation/ wsgi )
60
- - [ Track all changes to calendars and address books with Git.] ( #documentation/ versioning )
56
+ - [ A really simple 5-minute tutorial.] ( #tutorial )
57
+ - [ A simple but solid setup.] ( #basic-setup )
58
+ - [ Run behind a reverse proxy.] ( #reverse-proxy )
59
+ - [ Run with a WSGI server.] ( #wsgi )
60
+ - [ Track all changes to calendars and address books with Git.] ( #versioning )
61
61
62
62
#### Use
63
63
64
- - [ Which clients are supported?] ( #documentation/ clients )
64
+ - [ Which clients are supported?] ( #clients )
65
65
66
66
#### Configure
67
67
68
68
Now that you have Radicale running, let's see what we can configure to make it
69
69
fit your needs.
70
70
71
- - [ What can I configure?] ( #documentation/ configuration )
72
- - [ Authentication & Rights.] ( #documentation/ authentication-and-rights )
73
- - [ Storage.] ( #documentation/ storage )
74
- - [ Logging.] ( #documentation/ logging )
71
+ - [ What can I configure?] ( #configuration-1 )
72
+ - [ Authentication & Rights.] ( #authentication-and-rights )
73
+ - [ Storage.] ( #storage-2 )
74
+ - [ Logging.] ( #logging-1 )
75
75
76
76
#### Hack
77
77
78
78
Using is fun, but hacking is soooooooo coooooool. Radicale is a really small
79
79
and simple piece of code, it may be the perfect project to start hacking!
80
80
81
- - [ How does Radicale work?] ( #documentation/ architecture )
82
- - [ Plugins.] ( #documentation/ plugins )
81
+ - [ How does Radicale work?] ( #architecture )
82
+ - [ Plugins.] ( #plugins )
83
83
- [ Adding or fixing documentation.] ( #contribute )
84
84
85
85
### Tutorial
@@ -88,11 +88,11 @@ You want to try Radicale but only have 5 minutes free in your calendar? Let's
88
88
go right now! You won't have the best installation ever, but it will be enough
89
89
to play a little bit with Radicale.
90
90
91
- When everything works, you can get a [ client] ( #documentation/ clients ) and
91
+ When everything works, you can get a [ client] ( #clients ) and
92
92
start creating calendars and address books. The server ** only** binds to
93
93
localhost (is ** not** reachable over the network) and you can log in with any
94
94
user name and password. If Radicale fits your needs, it may be time for
95
- [ some basic configuration] ( #documentation/ basic-setup ) .
95
+ [ some basic configuration] ( #basic-setup ) .
96
96
97
97
Follow one of the chapters below depending on your operating system.
98
98
@@ -141,7 +141,7 @@ You can login with any username and password.
141
141
### Basic Setup
142
142
143
143
Installation instructions can be found on the
144
- [ Tutorial] ( #documentation/ tutorial ) page.
144
+ [ Tutorial] ( #tutorial ) page.
145
145
146
146
#### Configuration
147
147
@@ -155,7 +155,7 @@ You should create a new configuration file at the desired location.
155
155
passed via command line arguments.)
156
156
157
157
All configuration options are described in detail on the
158
- [ Configuration] ( #documentation/ configuration ) page.
158
+ [ Configuration] ( #configuration-1 ) page.
159
159
160
160
#### Authentication
161
161
@@ -359,7 +359,7 @@ Set the configuration option `daemon` in the section `server` to `True`.
359
359
You may want to set the option ` pid ` to the path of a PID file.
360
360
361
361
After daemonization the server will not log anything. You have to configure
362
- [ Logging] ( #documentation/ logging ) .
362
+ [ Logging] ( #logging-1 ) .
363
363
364
364
If you start Radicale now, it will initialize and fork into the background.
365
365
The main process exits, after the PID file is written.
@@ -969,7 +969,7 @@ Default: `owner_only`
969
969
##### file
970
970
971
971
File for the rights backend ` from_file ` . See the
972
- [ Rights] ( #documentation/ authentication-and-rights ) page.
972
+ [ Rights] ( #authentication-and-rights ) page.
973
973
974
974
#### storage
975
975
##### type
@@ -1014,7 +1014,7 @@ Default: `True`
1014
1014
##### hook
1015
1015
1016
1016
Command that is run after changes to storage. Take a look at the
1017
- [ Versioning] ( #documentation/ versioning ) page for an example.
1017
+ [ Versioning] ( #versioning ) page for an example.
1018
1018
1019
1019
Default:
1020
1020
@@ -1054,7 +1054,7 @@ Default: `True`
1054
1054
1055
1055
##### config
1056
1056
1057
- Logging configuration file. See the [ Logging] ( #documentation/ logging ) page.
1057
+ Logging configuration file. See the [ Logging] ( #logging-1 ) page.
1058
1058
1059
1059
Default:
1060
1060
@@ -1132,7 +1132,7 @@ It's safe to access and manipulate the data by hand or with scripts.
1132
1132
Scripts can be invoked manually, periodically (e.g. with
1133
1133
[ cron] ( https://manpages.debian.org/unstable/cron/cron.8.en.html ) ) or after each
1134
1134
change to the storage with the configuration option ` hook ` in the ` storage `
1135
- section (e.g. [ Git Versioning] ( #documentation/ versioning ) ).
1135
+ section (e.g. [ Git Versioning] ( #versioning ) ).
1136
1136
1137
1137
#### Layout
1138
1138
@@ -1538,7 +1538,7 @@ There's now only one way to store data in Radicale: collections are stored as
1538
1538
folders and events / contacts are stored in files. This new storage is close to
1539
1539
the ` multifilesystem ` , but ** it's now thread-safe, with atomic writes and file
1540
1540
locks** . Other storage types can be used by creating
1541
- [ plugins] ( #documentation/ plugins ) .
1541
+ [ plugins] ( #plugins ) .
1542
1542
1543
1543
To migrate data to Radicale 2.x.x the command line argument
1544
1544
`` --export-storage `` was added to Radicale 1.1.x.
@@ -1564,23 +1564,23 @@ $ python3 -m pip install --upgrade radicale==1.1.*
1564
1564
1565
1565
** Radicale 2.x.x only provides htpasswd authentication out-of-the-box.** Other
1566
1566
authentication methods can be added by creating or using
1567
- [ plugins] ( #documentation/ plugins ) .
1567
+ [ plugins] ( #plugins ) .
1568
1568
1569
1569
#### Rights
1570
1570
1571
1571
In Radicale 2.x.x, rights are managed using regex-based rules based on the
1572
1572
login of the authenticated user and the URL of the resource. Default
1573
1573
configurations are built in for common cases, you'll find more about this on
1574
- the [ Authentication & Rights] ( #documentation/ authentication-and-rights ) page.
1574
+ the [ Authentication & Rights] ( #authentication-and-rights ) page.
1575
1575
1576
1576
Other rights managers can be added by creating
1577
- [ plugins] ( #documentation/ plugins ) .
1577
+ [ plugins] ( #plugins ) .
1578
1578
1579
1579
#### Versioning
1580
1580
1581
1581
Support for versioning with ** git** was removed from Radicale 2.x.x.
1582
1582
Instead, the configuration option `` hook `` in the `` storage `` section was added,
1583
- the [ Collection Versioning] ( #documentation/ versioning ) page explains its
1583
+ the [ Collection Versioning] ( #versioning ) page explains its
1584
1584
usage for version control.
1585
1585
1586
1586
## Contribute
@@ -1755,7 +1755,7 @@ steps to have a simple remote calendar and contact access.
1755
1755
Contrary to other servers that are often complicated, require high privileges
1756
1756
or need a strong configuration, the Radicale Server can (sometimes, if not
1757
1757
often) be launched in a couple of minutes, if you follow the
1758
- [ tutorial] ( #documentation/ tutorial ) .
1758
+ [ tutorial] ( #tutorial ) .
1759
1759
1760
1760
##### Lazy
1761
1761
@@ -1798,7 +1798,7 @@ Radicale 2.1.12 is out!
1798
1798
#### 2.1.12 - Wild Radish
1799
1799
1800
1800
This release is compatible with version 2.0.0. Follow our
1801
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1801
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1802
1802
from 1.x.x to 2.x.x.
1803
1803
1804
1804
* Include documentation in source archive
@@ -1810,7 +1810,7 @@ Radicale 2.1.11 is out!
1810
1810
#### 2.1.11 - Wild Radish
1811
1811
1812
1812
This release is compatible with version 2.0.0. Follow our
1813
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1813
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1814
1814
from 1.x.x to 2.x.x.
1815
1815
1816
1816
* Fix moving items between collections
@@ -1822,7 +1822,7 @@ Radicale 2.1.10 is out!
1822
1822
#### 2.1.10 - Wild Radish
1823
1823
1824
1824
This release is compatible with version 2.0.0. Follow our
1825
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1825
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1826
1826
from 1.x.x to 2.x.x.
1827
1827
1828
1828
* Update required versions for dependencies
@@ -1839,7 +1839,7 @@ Radicale 2.1.9 is out!
1839
1839
#### 2.1.9 - Wild Radish
1840
1840
1841
1841
This release is compatible with version 2.0.0. Follow our
1842
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1842
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1843
1843
from 1.x.x to 2.x.x.
1844
1844
1845
1845
* Specify versions for dependencies
@@ -1857,7 +1857,7 @@ Radicale 2.1.8 is out!
1857
1857
#### 2.1.8 - Wild Radish
1858
1858
1859
1859
This release is compatible with version 2.0.0. Follow our
1860
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1860
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1861
1861
from 1.x.x to 2.x.x.
1862
1862
1863
1863
* Flush files before fsync'ing
@@ -1869,7 +1869,7 @@ Radicale 2.1.7 is out!
1869
1869
#### 2.1.7 - Wild Radish
1870
1870
1871
1871
This release is compatible with version 2.0.0. Follow our
1872
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1872
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1873
1873
from 1.x.x to 2.x.x.
1874
1874
1875
1875
* Don't print warning when cache format changes
@@ -1895,7 +1895,7 @@ Radicale 2.1.6 is out!
1895
1895
#### 2.1.6 - Wild Radish
1896
1896
1897
1897
This release is compatible with version 2.0.0. Follow our
1898
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1898
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1899
1899
from 1.x.x to 2.x.x.
1900
1900
1901
1901
* Fix content-type of VLIST
@@ -1914,7 +1914,7 @@ Radicale 2.1.5 is out!
1914
1914
#### 2.1.5 - Wild Radish
1915
1915
1916
1916
This release is compatible with version 2.0.0. Follow our
1917
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1917
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1918
1918
from 1.x.x to 2.x.x.
1919
1919
1920
1920
* Add `` --verify-storage `` command-line argument
@@ -1931,7 +1931,7 @@ Radicale 2.1.4 is out!
1931
1931
#### 2.1.4 - Wild Radish
1932
1932
1933
1933
This release is compatible with version 2.0.0. Follow our
1934
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1934
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1935
1935
from 1.x.x to 2.x.x.
1936
1936
1937
1937
* Fix incorrect time range matching and calculation for some edge-cases with
@@ -1945,7 +1945,7 @@ Radicale 2.1.3 is out!
1945
1945
#### 2.1.3 - Wild Radish
1946
1946
1947
1947
This release is compatible with version 2.0.0. Follow our
1948
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1948
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1949
1949
from 1.x.x to 2.x.x.
1950
1950
1951
1951
* Enable timeout for SSL handshakes and move them out of the main thread
@@ -1960,7 +1960,7 @@ Radicale 2.1.2 is out!
1960
1960
#### 2.1.2 - Wild Radish
1961
1961
1962
1962
This release is compatible with version 2.0.0. Follow our
1963
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1963
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1964
1964
from 1.x.x to 2.x.x.
1965
1965
1966
1966
* Remove workarounds for bugs in VObject < 0.9.5
@@ -1976,7 +1976,7 @@ Radicale 2.1.1 is out!
1976
1976
#### 2.1.1 - Wild Radish Again
1977
1977
1978
1978
This release is compatible with version 2.0.0. Follow our
1979
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1979
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1980
1980
from 1.x.x to 2.x.x.
1981
1981
1982
1982
* Add missing UIDs instead of failing
@@ -1990,7 +1990,7 @@ Radicale 2.1.0 is out!
1990
1990
#### 2.1.0 - Wild Radish
1991
1991
1992
1992
This release is compatible with version 2.0.0. Follow our
1993
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
1993
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
1994
1994
from 1.x.x to 2.1.0.
1995
1995
1996
1996
* Built-in web interface for creating and managing address books and calendars
@@ -2029,7 +2029,7 @@ Radicale 2.0.0 is out!
2029
2029
#### 2.0.0 - Little Big Radish
2030
2030
2031
2031
This feature is not compatible with the 1.x.x versions. Follow our
2032
- [ migration guide] ( #documentation/ migration-from-1xx-to-2xx ) if you want to switch
2032
+ [ migration guide] ( #migration-from-1xx-to-2xx ) if you want to switch
2033
2033
from 1.x.x to 2.0.0.
2034
2034
2035
2035
- Support Python 3.3+ only, Python 2 is not supported anymore
@@ -2651,7 +2651,7 @@ After a lot of help and testing work from Andrew, Björn, Anders, Dorian and
2651
2651
Pete (and other ones we could have forgotten), a simple iPhone support has been
2652
2652
added in the git repository. If you are interested, you can test this feature
2653
2653
* right now* by
2654
- [ downloading the latest git version] ( #download// git-repository )
2654
+ [ downloading the latest git version] ( #git-repository )
2655
2655
(a tarball is even available too if you don't want or know how to use git).
2656
2656
2657
2657
No documentation has been written yet, but using the right URL in the
0 commit comments