====== WordPress Authentication Plugin ======

---- plugin ----
description: Provides authentication against a WordPress MySQL database backend
author     : Damien Regad 
email      : dregad@mantisbt.org 
type       : auth
lastupdate : 2024-03-06
compatible : Detritus, Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum, Kaos+
depends    : 
conflicts  : 
similar    : 
tags       : wordpress, authentication

downloadurl: https://github.com/dregad/dokuwiki-plugin-authwordpress/zipball/master
bugtracker : https://github.com/dregad/dokuwiki-plugin-authwordpress/issues
sourcerepo : https://github.com/dregad/dokuwiki-plugin-authwordpress/
donationurl: https://github.com/sponsors/dregad

screenshot_img : 
----

===== Installation =====

==== Prerequisites ====

This plugin requires access to a WordPress site's MySQL database. See [[#configuration_and_settings|Configuration and settings section below]] for further information.

PHP's PDO extension is required.


=== Wordpress compatibility ===

The plugin supports WordPress releases 4.x 5.x and 6.x.
It has been tested and confirmed to work on versions 4.3 to 4.9, 5.1 to 5.3 and 6.0 to 6.2.


==== Setup ====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.


==== Configuration and Settings ====

  - Login to DokuWiki as administrator
  - Go to your site's [[config|Configuration Manager]]
  - In the //Authentication// section
    * Set //Authentication backend// to **authwordpress**
    * Add **@administrator** to the //Superuser// list((This will turn Wordpress administrators into DokuWiki super users)).\\ :!: **failure to do so may leave you without any users having admin rights**, requiring you to manually edit the configuration file to fix the problem.
  - Scroll down to the //Authwordpress// Plugin section
    * Provide the required configuration information
      * hostname((mandatory))
      * port number
      * database name((mandatory))
      * username((mandatory))
      * password((mandatory))
      * table prefix
  - Save settings


===== Usage =====

Navigate to your DokuWiki's //Login page//, and enter your WordPress credentials to login.

Logged in users' will have the following group memberships:
  * DokuWiki //default group// (as defined in configuration), 
  * a group matching their //Wordpress role//, i.e. one of
    * administrator
    * editor
    * author
    * contributor
    * subscriber
These groups can be used to setup [[:ACL]] as appropriate.

The **plugin does not allow new users to sign up,** accounts must be created on the WordPress side.


===== Development =====


=== Revision history (Github releases) ===

{{rss>https://github.com/dregad/dokuwiki-plugin-authwordpress/releases.atom 5}}

The complete [[https://github.com/dregad/dokuwiki-plugin-authwordpress/releases|list of releases and change log]] is available on Github.


=== Recent commits ===

{{rss>https://github.com/dregad/dokuwiki-plugin-authwordpress/commits/master.atom 5 author date}}


Full [[https://github.com/dregad/dokuwiki-plugin-authwordpress/commits/master|Git log]].

=== Known Bugs and Issues ===

Please refer to the plugin's [[https://github.com/dregad/dokuwiki-plugin-authwordpress/issues|Issue tracker on Github]].


=== ToDo/Wish List ===

  * Provide transparent authentication / single sign-on.\\ If user is already logged in WordPress, then they won't have to login again in DokuWiki, and vice-versa. Same thing for logout.


===== FAQ =====

==== I locked myself out, what do I do now? ====

  - Edit your local configuration file ''./conf/local.php''
  - Reset authentication to **authplain** <code>
$conf['authtype'] = 'authplain';
</code>
  - Save the file