Differences

This shows you the differences between two versions of the page.

--- plugin:authphpbb3 [2017-01-29 18:57] – Eole
+++ plugin:authphpbb3 [2024-11-22 15:25] (current) – [Discussions] cactux
@@ Line 1: / Line 1: @@
-====== authphpbb3 Plugin ======
+====== AuthPHPBB3 Plugin ======
 ---- plugin ----
@@ Line 6: / Line 6: @@
 email      : eole.dev@outlook.com
 type       : auth action
-lastupdate : 2017-01-26
+lastupdate : 2019-04-17
-compatible : Binky, Ponder Stibbons, Hrun, Detritus, Elenor of Tsort
+compatible : Binky, Ponder Stibbons, Hrun, Detritus, Elenor of Tsort, Frusterick Manners, Greebo
 depends    :
 conflicts  :
 similar    :
-tags       : authentication phpbb3 SSO
+tags       : authentication phpbb phpbb3 SSO
 downloadurl: https://github.com/Eole-dev/authphpbb3/zipball/master
 bugtracker : https://github.com/Eole-dev/authphpbb3/issues
-sourcerepo : https://github.com/Eole-dev/authphpbb3/
+sourcerepo : https://github.com/Eole-dev/authphpbb3
-screenshot_img: https://raw.githubusercontent.com/Eole-dev/authphpbb3/master/authphpbb3login.jpg?700
+screenshot_img: https://raw.githubusercontent.com/Eole-dev/authphpbb3/master/authphpbb3login.jpg
 ----
 This plugin allows users to authenticate using phpBB credentials directly in DokuWiki. This plugin is a two-ways authentication meaning a user can authenticate in phpBB or DokuWiki (SSO-like system).
 Features list:
   * Authentication: you can login using DokuWiki form with phpBB credentials. A user authenticated using phpBB will be authenticated in DokuWiki and vice versa (mutual authentication).
-  * Groups: phpBB groups can be used to set ACL.
+  * Groups: phpBB groups can be used to set ACL in DokuWiki.
-  * Profile: DokuWiki user's link redirects to phpBB user's profile.
+  * Profile: DokuWiki user's profile link redirects to phpBB user's profile.
   * Cache: a cache system is used to improve performance (minimal database requests).
@@ Line 35: / Line 35: @@
 ===== Installation =====
-Search and install it in the [[plugin:Extension]] manager or install it manually by extracting the contents of the [[https://github.com/Eole-dev/authphpbb3/zipball/master|archive]] to ''lib/plugins'' and **renaming the directory** to ''authphpbb3''.
+Search and install the plugin using the [[plugin:extension|Extension Manager]].
-Please refer to http://www.dokuwiki.org/plugins for additional info on how to install plugins in DokuWiki.
+Or install it manually by extracting the contents of the [[https://github.com/Eole-dev/authphpbb3/zipball/master|archive]] to ''lib/plugins'' and **renaming the directory** to ''authphpbb3''. Please refer to [[:plugins]] for additional info on how to install plugins in DokuWiki.
 ==== Configuration ====
@@ Line 47: / Line 47: @@
     - ''Display'' -> ''showuseras'':\\ select ''User's full name as interwiki user link''.
     - ''Plugin Settings'' -> ''Authphpbb3'' -> ''plugin»authphpbb3»phpbb_root_path'':\\ relative path from DokuWiki root directory to phpbb3 root directory.\\ Default: ''../forums''.
-    - ''Plugin Settings'' -> ''Authphpbb3'' -> ''plugin»authphpbb3»phpbb_cache'':\\ cache validity period in days (0 will disable cache).\\ Default : ''1''.
+    - ''Plugin Settings'' -> ''Authphpbb3'' -> ''plugin»authphpbb3»phpbb_cache'':\\ cache validity period in days (0 will disable cache).\\ Default : ''0''.
     - ''Plugin Settings'' -> ''Authphpbb3'' -> ''plugin»authphpbb3»phpbb_inline_style'':\\ If checked, inline-style is used in HTML tags of the authentication form.\\ Default : ''1'' (checked).
@@ Line 58: / Line 58: @@
 If you are not using the default protocol (http) and the default port (80), check you have configured the server port and server protocol in your phpBB installation.
-⇒ By example, if your phpBB installation is using HTTPS, server port should be 443 and server protocol should be https:%%//%% (not empty).
+⇒ By example, if your phpBB installation is using HTTPS, server port should be 443 and server protocol should be https:%%//%% (**not empty**).
+> **NOTE**\\
+> if you change your phpBB protocol/port settings after you setup this plugin, you may run into a problem where the site redirects to a wrong URL upon login or logout.\\ In order to fix this problem, and for DokuWiki to recognize the phpBB configuration change, you need to disable the cache of the authphpbb3 plugin by setting the value to 0.\\ Then, try to login and logout from your DokuWiki, the redirection should work. Finally, you can enable the plugin cache again.
 ==== Permissions ====
-To make use of DokuWiki's [[ACL]], add the corresponding phpBB group or username to it (''@my phpBB group'' or ''my phpBB username'').
+To make use of DokuWiki's [[ACL]], add the corresponding phpBB group or username to it (''@my phpBB group'' or ''my phpBB username'').  For the built-in "Registered users" phpBB group, use the DokuWiki group name ''@REGISTERED''.
 By design, phpBB founders will be members of @admin group in DokuWiki.
@@ Line 86: / Line 89: @@
 Hello, thank you for the feedback. The plugin has been updated to handle login redirections. However, phpBB doesn't natively support logout redirection yet. --- [[user>Eole]] //2017-01-08//
+This plugin works fine, thanks! One minor thing I noticed: it seems that the group name in phpBB must not contain dash or hyphen (- and _). I had some issues (no login) and renaming the group names seems to have solved them. To confirm, though, I did not test extensively. --- [[user>cactux|cactux]] //2024-11-22//