Turnkey Plugins \ Single Sign-On SSO for phpBB 3.3.5+ Fork on Github

Single Sign-On/SSO for phpBB 3.3.5+

Single Sign-On for phpBB is a professional extension that automatically creates accounts and signs users in as they browse between multiple and independent phpBB websites in your network. Take away the need for your users to create accounts or re-enter their authentication credentials when they switch from one of your websites to another.

This extension requires a OneAll site with an enterprise plan that includes the Single Sign-On service.

1. Installation

The installation takes only a few minutes. Please follow the instructions carefully and do not skip any steps.

a. Download the extension

Download Single Sign On for phpBB 3.3.5+

b. Upload the extension

Copy the folder oneall included in the downloaded .ZIP file to the folder ext of your phpBB forum. After having copied the folder you must see the folder ext/oneall/singlesignon in your phpBB directory.

phpBB 3.3.5+ : Single Sign On Archive

c. Enable the extension

Login to your phpBB administration contral panel (ACP) and open the Customise tab. Then look for the OneAll Single Sign On extension and click on the Enable link to activate it.

phpBB 3.3.5+ : Enable Single Sign On

d. Clear your phpBB cache

phpBB features a cache system that creates static copies of the used files. One of the most common reasons that something doesn't work or a change isn't reflected is because your phpBB is displaying an old, cached version of a changed file.

Login to your phpBB administration contral panel (ACP) and on the index page of that area, you will see your Board statistics. Below that is an area titled Resynchronise or reset statistics. This area features a series of Run now buttons. Press the button next to Purge the cache, confirm your decision and your cache will be refreshed.

phpBB 3.3.5+ : Purge Cache

2. Configuration

a. Open the configuration panel

Login to your phpBB administration control panel (ACP), navigate to the Extensions tab and click on the Settings link in the ONEAL SOCIAL LOGIN group.

phpBB 3.3.5+ :  Social Login Settings

b. Setup the API connection handler

Click on the Autodetect API Connection button. You should receive a green success message if your server is able to communicate with the OneAll API. Your firewall must allow outbound requests on either port 80 or 443.

phpBB 3.3.5+ : Social Login API Connection

c. Enter your API credentials

To obtain your API credentials, please login to your OneAll account and open the page Site Settings \ API Settings & Credentials of a Site.

Fill out the API Credentials and then click on the Verify API Settings button. You should receive a green success message if your credentials are correct.

phpBB 3.3.5+ : Social Login Verify Configuration

d. Setup Single Sign-On on your other websites

Now repeat the installation for each of your phpBB websites. Single Sign-On will automatically create accounts and sign users in as they browse between multiple and independent websites, databases and domains. The plugin is fully compatible with our other Single Sign-On plugins like per example for WordPress, OpenCart or Magento.

3. Troubleshooting

a. The API communication does not seem to work correctly

Please make sure that your firewall does not block outbound requests on both ports 80 and 443. One of these ports must allow outgoing requests (from your server to ours) so that the plugin can establish a communication with our API.

If you have access to the console of your server you can test if outbound requests are allowed by using this command: telnet ping.api.oneall.com 443. If the port is open then you should obtain a result like this:

		~$ telnet ping.api.oneall.com 443
		Trying 136.243.63.184...
		Connected to ping.api.oneall.com.
		Escape character is '^]'.
	

b. You are not authorized to access this page

If you encounter this error when Single Sign-On tries to log you in, then you might have installed a phpBB module (e.g. Security Kit) which blocks offsite POST requests from our API to your server. To fix the issue please whitelist the following domain for offsite requests:

		*.api.oneall.com
	

4. Fork on Github

Feel free to fork phpBB Single Sign-On on Github to contribute to the development of this module.

User Contributed Notes