Joomla OAuth Client Integration with GitHub Single Sign-On (SSO)
Integration of GitHub Single Sign-on (GitHub SSO) with Joomla using OAuth 2.0 Protocol. The miniOrange Joomla OAuth / OpenID Connect Single Sign-on (SSO) plugin makes it simple to set up GitHub SSO into Joomla and enable secure login into Joomla. As a result, users can log in to Joomla and access the site by authenticating with their GitHub OAuth Provider credentials.
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.
Joomla OAuth Client Handbook
Please refer our detailed Handbook for the Joomla OAuth/OpenID Single Sign-On plugin, which gives an in-depth explanation of the various features of the plugin. You can get to the handbook at anytime directly from the plugin's UI for quicker access.
Pre-requisites : Download And Installation
Setup GitHub as OAuth Provider with Joomla OAuth Client
Follow the steps given below to setup the Joomla OAuth Client plugin. You can also refer to this Setup video for configuring the plugin.
1. Download and Setup Joomla OAuth Client
- Download the zip file for the miniOrange OAuth Client plugin for Joomla from the given link.
- Login into your Joomla site’s administrator console.
- From left toggle menu, click on System, then under Install section click on Extensions.
- Upload the downloaded zip file to install the Joomla OAuth Client plugin.
- After successful installation of plugin, click on Start Using miniOrange OAuth Client plugin button.
- Under Configure OAuth tab. Select GitHub as an OAuth Provider.
- Copy the Callback/Redirect URL from Configure OAuth tab of Joomla OAuth Client plugin.
2. Configure GitHub as OAuth Provider
- First of all, go to https://github.com/settings/developers 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 URI which is copied from here. 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.
- Copy these credentials in Joomla OAuth Client Plugin configuration on corresponding fields.
NOTE: Callback URI is the URI where the user will be sent after authorization.
3. Integrating Joomla with GitHub
- Go back to your Joomla Dashboard. Then go to Components.
- Now go to the Joomla OAuth Client plugin, under Configure OAuth tab, enter the all the details. Then click on Save Settings and then click on Test Configuration.
GitHub Endpoints and Scope:
| Client ID : | from the above step |
| Client Secret : | from the above step |
| 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) |
4. Test SSO and Attribute Mapping
- Once you click on Test Configuration button, You will be able to see the attributes in the Test Configuration output as follows.
- Now you have to do Attribute Mapping to perform SSO. Select the attribute name for Email and Username from dropdown. Then click on Save Attribute Mapping button.
- Now you can use Login / SSO URL to perform SSO.
- 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.
- Congratulations, you have successfully configured the miniOrange OAuth Client plugin with your GitHub OAuth Provider.
- Click on the Upgrade Plans tab to check out our complete list of features and various licensing plans. OR you can click here to check features and licensing plans.
- If you want to purchase any of the paid version of the plugin, you have to register/login with us in Account Setup tab. OR you can register/login Here .
- In case, you are facing some issue or have any question in mind, you can reach out to us by sending us your query through the Support button in the plugin or by sending us a mail at joomlasupport@xecurify.com
You have successfully configured Joomla as OAuth Client for achieving Joomla GitHub Single Sign-On (SSO) with Joomla for user authentication.
In this guide, you have successfully configured Joomla GitHub Single Sign-On (SSO) by configuring GitHub as OAuth Provider and Joomla as OAuth Client using our Joomla OAuth Client plugin.This solution ensures that you are ready to roll out secure access to your Joomla site using GitHub login credentials within minutes.
Additional Resources
- What is OAuth 2.0?
- Frequently Asked Questions (FAQs)
- How to configure OAuth / OpenID Connect SSO with Azure AD
- How to configure OAuth / OpenID Connect SSO with Salesforce
- How to configure OAuth / OpenID Connect SSO with AWS Cognito
- How to configure OAuth / OpenID Connect SSO with Discord
- How to configure OAuth / OpenID Connect SSO with Facebook
- How to configure OAuth / OpenID Connect SSO with Google Apps
- How to configure OAuth / OpenID Connect SSO with Instagram
- How to configure OAuth / OpenID Connect SSO with Keycloak
Mail us on joomlasupport@xecurify.com for quick guidance(via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.
Need Help? We are right here!
