oss/Radicale
oss/Radicale
1
0
Fork 0
mirror of https://github.com/Kozea/Radicale.git synced 2025-08-22 19:20:54 +00:00
Code Wiki Activity

Minor fixes

Browse source
This commit is contained in:
Guillaume Ayoub 2017-05-27 12:06:41 +02:00
parent ad72c218c3
commit e69970ed56
10 changed files with 108 additions and 107 deletions
Download patch file Download diff file Expand all files Collapse all files

26
plugins.md
View file

@ -14,7 +14,7 @@ plugin, that accepts login attempts if the username and password are equal.
The easiest way to develop and install **python** modules is
[Distutils](https://docs.python.org/3/distutils/setupscript.html).
For a minimal setup create the file **setup.py** with the following content
For a minimal setup create the file `setup.py` with the following content
in an empty folder:
```python
@ -25,10 +25,10 @@ from distutils.core import setup
setup(packages=["silly_auth_plugin"])
```
In the same folder create the sub-folder **silly_auth_plugin**. The folder
must have the same name as specified in ``packages`` above.
In the same folder create the sub-folder `silly_auth_plugin`. The folder
must have the same name as specified in `packages` above.
Create the file **\_\_init\_\_.py** in the **silly_auth_plugin** folder with the
Create the file `\_\_init\_\_.py` in the `silly_auth_plugin` folder with the
following content:
```python
@ -42,28 +42,28 @@ class Auth(BaseAuth):
```
Install the python module by running the following command in the same folder
as **setup.py**:
```sh
as `setup.py`:
```shell
python3 -m pip install --upgrade .
```
To make use this great creation in Radicale, set the configuration option
``type`` in the ``auth`` section to ``silly_auth_plugin``.
`type` in the `auth` section to `silly_auth_plugin`.
## Authentication plugins
This plugin type is used to check login credentials.
The module must contain a class ``Auth`` that extends
``radicale.auth.BaseAuth``. Take a look at the file *radicale/auth.py* in
The module must contain a class `Auth` that extends
`radicale.auth.BaseAuth`. Take a look at the file `radicale/auth.py` in
Radicale's source code for more information.
## Rights management plugins
This plugin type is used to check if a user has access to a path.
The module must contain a class ``Rights`` that extends
``radicale.auth.BaseAuth``. Take a look at the file *radicale/rights.py* in
The module must contain a class `Rights` that extends
`radicale.auth.BaseAuth`. Take a look at the file `radicale/rights.py` in
Radicale's source code for more information.
## Storage plugins
This plugin is used to store collections and items.
The module must contain a class ``Storage`` that extends
``radicale.auth.BaseStorage``. Take a look at the file *radicale/storage.py* in
The module must contain a class `Storage` that extends
`radicale.auth.BaseStorage`. Take a look at the file `radicale/storage.py` in
Radicale's source code for more information.