diff --git a/pages/user_documentation.rst b/pages/user_documentation.rst index ef3ed771..f55d3dc3 100644 --- a/pages/user_documentation.rst +++ b/pages/user_documentation.rst @@ -824,6 +824,47 @@ behind a real HTTP server and use its authentication and rights management 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 `_. + + +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 -----------------