README.md
1## authnc Plugin for DokuWiki
2
3This small authentication plugin for the [DokuWiki](http://www.dokuwiki.org)
4which uses a Nextcloud instance as authentication backend.
5
6**This is mostly work in progress**
7
8##### Remarks
9
10* This plugin uses the [`OCS-API`](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html) from Nextcloud to authorize new users.
11* At the moment only `trustExternal`, `logout`, `getGroups` and `getUserCount` are implemented
12* `getUsers` is somewhat broken, atm (too many requests)
13* The API may behave slowly
14* ATM, there are no tests, it was programmed against a live instance with a simple dw instance, see submodules (do not checkout)
15* ~The login form throws a `failure 998` invalid syntax, see [this](https://www.freedesktop.org/wiki/Specifications/open-collaboration-services/)~
16
17##### ToDo
18
19* [x] Only allow login for enabled users
20* allow only specific groups to login
21* allow bidirectional user changes
22
23##### Usage notes
24
25* To use ACL create the appropriate groups within your NC instance and assign it to your users
26* Set the groups within the DokuWiki config to manager or users
27* Use the ACL as usually
28
29#### Installation notes
30
31If you install this plugin manually, make sure it is installed in
32lib/plugins/authnc/ - if the folder is called different it
33will not work!
34
35Please refer to http://www.dokuwiki.org/plugins for additional info
36on how to install plugins in DokuWiki.
37
38#### Collaboration
39
40* Pull request are highly welcome
41* Issues, feature requests, testing and hints are also welcome
42
43 Please use the bug tracker for any of them.
44
45----
46Copyright (C) Henrik Jürges <ratzeputz@rtzptz.xyz>
47
48This program is free software; you can redistribute it and/or modify
49it under the terms of the GNU General Public License as published by
50the Free Software Foundation; version 2 of the License
51
52This program is distributed in the hope that it will be useful,
53but WITHOUT ANY WARRANTY; without even the implied warranty of
54MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
55GNU General Public License for more details.
56
57See the LICENSING file for details
58