README.md
1# authwordpress - an authentication plugin for DokuWiki
2
3Provides authentication against a WordPress MySQL database backend.
4
5Copyright (c) 2015 Damien Regad <dregad@mantisbt.org>
6
7
8## License
9
10This program is free software; you can redistribute it and/or modify
11it under the terms of the
12[GNU General Public License, version 2](http://www.gnu.org/licenses/gpl-2.0.html)
13or later.
14
15This program is distributed in the hope that it will be useful,
16but WITHOUT ANY WARRANTY; without even the implied warranty of
17MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18GNU General Public License for more details.
19
20
21## Installation and Configuration
22
23Please refer to the [plugin's documentation](http://www.dokuwiki.org/plugin:authwordpress)
24for information on how to install and configure this plugin in DokuWiki.
25
26If you install this plugin manually, make sure it is installed in
27`lib/plugins/authwordpress/` - if the folder is called differently,
28it will not work!
29
30
31## Compatibility
32
33### DokuWiki
34
35This plugin has been tested with the following DokuWiki releases:
36
37- 2023-04-04a “Jack Jackrum”
38- 2022-07-31b “Igor”
39
40Plugin version 2023-06-06 drops support for older DokuWiki releases;
41use version 2020-03-14 if you're using:
42
43- 2020-07-29a “Hogfather”
44- 2018-04-22b “Greebo”
45- 2017-02-19e “Frusterick Manners”
46- 2016-06-26e “Elenor of Tsort”
47- 2015-08-10a “Detritus”
48
49It will probably also work with *2013-05-10 “Weatherwax”* and later.
50
51### WordPress
52
53On the back-end side, the plugin supports WordPress releases 4.x to 6.x.
54It has been tested and confirmed to work on versions 4.3 to 4.9, 5.1 to 5.3, 6.0 to 6.2.
55
56
57## Support
58
59Source code and support for this plugin can be found at
60https://github.com/dregad/dokuwiki-plugin-authwordpress
61