1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-07-02 16:58:30 +00:00

Merge pull request #57 from cristen/website

Added the doc for the git support in Radicale
This commit is contained in:
Guillaume Ayoub 2014-08-13 13:15:47 +02:00
commit dd73e7238d

View file

@ -824,6 +824,47 @@ 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
----------------- -----------------