Configure GitHub Single Sign-On (SSO) with Joomla OAuth Client Plugin
Overview
Set up Single Sign-On (SSO) on your Joomla site via GitHub OAuth provider with the help of Joomla OAuth & OpenID Connect plugin. Integrating GitHub Single Sign-On (SSO) into Joomla using OAuth 2.0 authentication protocol allows your users to securely login into your Joomla websites and applications by authenticating with GitHub OAuth provider. The GitHub OAuth Joomla plugin also provides advanced features such as, Auto create users, Attribute Mapping, Group Mapping etc. Visit our Joomla OAuth Client Plugin page to learn more about the features and Pricing plans we offer for the Joomla OAuth Single Sign-on (OAuth & OpenID connect) plugin.
Configuration Steps
In this configuration, GitHub functions as the OAuth server, while Joomla allows users to log in with their GitHub credentials by utilizing the Joomla OAuth Client Plugin.
Step 1: Install Joomla OAuth Client Plugin
- Login into your Joomla site’s Administrator console.
- From left toggle menu, click on System, then under Install section click on Extensions.
- Now click on Or Browse for file button to locate and install the plugin file downloaded earlier.
- Installation of plugin is successful. Now click on Get Started!
- Under Configure OAuth -> Pre-Configured Apps tab, select your OAuth Provider. You can also search for custom OAuth or custom OpenID application in the search bar, and configure your own custom provider.
- After selecting your OAuth provider, you will be redirected to the Step 1 [Redirect URL] tab. Now copy the Callback/Redirect URL which we will use to configure GitHub as OAuth Server, then click on the Save & Next button.
Step 2: Configure GitHub as OAuth Server
- First of all, go to GitHub and log into your GitHub account.
- You will be presented with the following screen. Click on Register a new application.
- You will be shown a form where you have to enter Application Name and Callback URL which we copied earlier Fill the form with appropriate information and click on the Register Application.
- After registering the application, you will be given Client ID and Client Secret.
Step 3: Configure Client ID & Secret
- Go back to your Joomla Dashboard. Then go to Step 2 [Client ID & Secret].
- Paste the Client ID, Client Secret and Domain. Also Set Client Credentials In header then click on Save Settings. Once Settings are saved then click on Save Configuration.
- Scope & Endpoints are given below, which are required for configuring Joomla as OAuth Client plugin to configure GitHub as a custom OAuth or OIDC provider.
| Scope | user repo |
| Authorize Endpoint | https://github.com/login/oauth/authorize |
| Access Token Endpoint | https://github.com/login/oauth/access_token |
| Get User Info Endpoint | https://api.github.com/user |
| Set Client Credentials | In Both (In Header and In Body) |
Step 4: Configure Attribute Mapping
- User Attribute Mapping is mandatory for enabling users to successfully login into Joomla. We will be setting up user profile attributes for Joomla using below settings.
- Go to Step 3 [Attribute Mapping] tab and click on Test Configuration button.
- You will be able to see the attributes in the Test Configuration output as follows.
- Now go to the Step 3 [Attribute Mapping] tab and Select the attribute name for Email and Username from dropdown. Then click on Finish Configuration button.
Step 5: Setup Login/SSO URL
- Now go to Step 4 [SSO URL] tab, here copy the Login/SSO URL and add it to your Site by following the given steps.
- Now logout and go to your Joomla site's pages where you have added this link. You will see a login link where you placed that button. Click on this button to perform SSO.
