GitHub Single Sign-On SSO Joomla Guide | GitHub Login

If you want users to log in to your Joomla site using their GitHub credentials, you can do it using our Joomla GitHub OAuth plugin. Once you configure the GitHub with the Joomla OAuth plugin, you can allow GitHub users to SSO into your Joomla site using GitHub.
Similarly, you can map your Joomla roles based on your GitHub attributes/groups. To know more about other features we provide in Joomla OAuth  plugin, you can download by click here.

Download And Installation

  • Log into your Joomla instance as an admin.
  • Go to the Joomla Dashboard -> Extensions -> Manage and click on Install.
  • Seach for a Joomla OAuth Client plugin and click on Install.

Step 1: Setup 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
  • Joomla GitHub OAuth SSO, register app
  • You will be shown a form where you have to enter Application Name and Callback URI. Fill the form with appropriate information and click on the Register Application.
  • Joomla GitHub OAuth SSO, Enter appnameURL

    NOTE: Callback URI is the URI where the user will be sent after authorization.

  • After registering the application, you will be given Client ID and Client Secret.
  • Joomla GitHub OAuth SSO, get clientidsecret
  • Copy these credentials in Joomla OAuth Client Plugin configuration on corresponding fields.

  • 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

Step 2: Configure miniOrange Joomla OAuth Client plugin.

  • Download the zip file for the miniOrange OAuth Client plugin for Joomla from the link here.
  • oauth provider the zip for Joomla
  • Login into your Joomla site’s administrator console.
  • Go to Extension Manage Install in the top navigation bar to install the plugin.
  • joomla oauth provider plugin
  • Upload the downloaded zip file to install the OAuth Client plugin.
  • joomla oauth provider zip
  • Navigate to Extensions Manage Manage and search for miniorange in the Search bar provided to see the list of the components.
  • Go to Components MiniOrange OAuth Client in the top navigation bar to go to the configuration page of the plugin.
  • joomla oauth provider OAuth Client
  • Register/ Login with miniOrange.
  • Go to the Configure OAuth tab in the plugin. FIll in the details you received from your OAuth Provider and click on the Save Settings button.
  • joomla oauth provider OAuth tab

    Select your OAuth Provider from the Select Application dropdown. In case your OAuth Provider is not listed in the drop down, please select Custom OAuth Provider to continue.

  • Copy the Redirect/Callback URL given in the plugin and save it in your OAuth Provider.
  • Click on the Test Configuration button and copy the email and name attributes and save these attributes in Email Attribute and Name Attribute text field respectively. Now click on the Save Attribute Mapping button to save your configurations.
  • joomla oauth provider Application joomla oauth provider Attribute Mapping
  • Add a button on your site login page with the following URL:your_home_page/base_url/?morequest=oauthredirect&app_name=xxxxxxxxx
  • You would find appropriate URL in Instructions to configure in the bellow section of Attribute Mapping (After completing test configuration please choose URL and Add a button on your site login page).

  • Now logout and go to your site. You will see a login link where you placed that button.
  • Click on the Licensing Plans Tab to check out our complete list of features and various licensing plans.
  • 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 dialog box in the Account Setup and Configure OAuth tabs.
  • joomla oauth provider server sso submit query

    Congratulations, you have successfully configured the miniOrange OAuth Client plugin with your desired OAuth Provider. In case you have any questions in mind, you can always mail us at joomlasupport@xecurify.com .

Free Trial

If you are looking for anything which you cannot find, please drop us an email on joomlasupport@xecurify.com

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com