oss/Radicale
oss/Radicale
1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-07-23 17:48:30 +00:00
Code Wiki Activity

Small fixes

Browse source
This commit is contained in:
Guillaume Ayoub 2014-08-13 13:56:51 +02:00
parent 9b9009ca62
commit 7c0c254b16
1 changed files with 52 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

100
pages/user_documentation.rst
View file

@ -829,6 +829,7 @@ Authentication is possible through:
- IMAP - IMAP
- LDAP - LDAP
- PAM - PAM
- Remote user given by HTTP server
Check the ``[auth]`` section of your configuration file to know the different Check the ``[auth]`` section of your configuration file to know the different
options offered by these authentication modules. options offered by these authentication modules.
@ -836,53 +837,15 @@ options offered by these authentication modules.
Some authentication methods need additional modules, see `Python Versions and Some authentication methods need additional modules, see `Python Versions and
OS Support`_ for further information. OS Support`_ for further information.
You can also write and use a custom module handle authentication if you use a
different technology.
Please note that these modules have not been verified by security experts. If Please note that these modules have not been verified by security experts. If
you need a really secure way to handle authentication, you should put Radicale you need a really secure way to handle authentication, you should put Radicale
behind a real HTTP server and use its authentication and rights management behind a real HTTP server and use its authentication and rights management
methods. methods.
Git Support
-----------
.. note::
If the project doesn't comply with the requirements to use Git, Radicale will still work.
Your collections will run fine but without the versionning system.
Git is now automatically supported on Radicale. It depends on `dulwich <https://github.com/jelmer/dulwich>`_.
Configure Radicale
~~~~~~~~~~~~~~~~~~
Radicale automatically detects the *.git* folder in the path you configured for
the filesystem_folder variable in the ``[storage]`` section of your configuration file.
Make sure a repository is created at this location or create one (using *git init
.* for instance) else it won't work.
To summarize : 
- Configure your Git installation
- Get Radicale and dulwich
- Create the repository where your collections are stored
- Run Radicale and it should work
How it works
~~~~~~~~~~~~
Radicale will automatically commit any changes on your collections. It
will use your git config to find parameters such as the committer and that's all.
Issues
~~~~~~
A dulwich project ported on Python 3 exists but it seems that it doesn't follow the
current api (committer is mandatory and not retrieved from the git config by
default). Until this problem isn't fixed, the Git support for Radicale on
Python 3 will not be ensured.
Rights Management Rights Management
----------------- -----------------
@ -895,8 +858,9 @@ called ``anna``.
The *authenticated user* is the login used for authentication. The *authenticated user* is the login used for authentication.
4 different configurations are available, you can choose the one you want in 5 different configurations are available, you can choose the one you want in
your configuration file. your configuration file. You can also write and use a custom module handle
rights management if you need a specific pattern.
None None
~~~~ ~~~~
@ -912,16 +876,15 @@ users have no access to these collections.
Owner Only Owner Only
~~~~~~~~~~ ~~~~~~~~~~
Only owners have read and write access to their own collections (path is Only owners have read and write access to their own collections. The other
`/username/*`). The other users, authenticated or anonymous, have no access to users, authenticated or anonymous, have no access to these collections.
these collections.
Owner Write Owner Write
~~~~~~~~~~~ ~~~~~~~~~~~
Authenticated users have read access to all collections, but only owners have Authenticated users have read access to all collections, but only owners have
write access to their own collections (path is `/username/*`). Anonymous users write access to their own collections. Anonymous users have no access to
have no access to collections. collections.
From File From File
~~~~~~~~~ ~~~~~~~~~
@ -978,6 +941,47 @@ Example:
permission: w permission: w
Git Support
-----------
.. note::
If the project doesn't comply with the requirements to use Git, Radicale will still work.
Your collections will run fine but without the versionning system.
Git is now automatically supported on Radicale. It depends on `dulwich <https://github.com/jelmer/dulwich>`_.
Configure Radicale
~~~~~~~~~~~~~~~~~~
Radicale automatically detects the *.git* folder in the path you configured for
the filesystem_folder variable in the ``[storage]`` section of your configuration file.
Make sure a repository is created at this location or create one (using *git init
.* for instance) else it won't work.
To summarize : 
- Configure your Git installation
- Get Radicale and dulwich
- Create the repository where your collections are stored
- Run Radicale and it should work
How it works
~~~~~~~~~~~~
Radicale will automatically commit any changes on your collections. It
will use your git config to find parameters such as the committer and that's all.
Issues
~~~~~~
A dulwich project ported on Python 3 exists but it seems that it doesn't follow the
current api (committer is mandatory and not retrieved from the git config by
default). Until this problem isn't fixed, the Git support for Radicale on
Python 3 will not be ensured.
Python Versions and OS Support Python Versions and OS Support
============================== ==============================