Search
START TYPING AND PRESS ENTER TO SEARCH

OAuth / OpenID Connect Single Sign-On (SSO) into Joomla using GitHub | GitHub SSO Login

Download Plugin



What is OAuth / OpenID?

OAuth Server / OpenID Connect Server (OAuth 2.0 Server) also known as Authorization Server, It is the modern standard for securing access to APIs & implements network protocol flows which allow a client (OAuth Client) to act on behalf of a user. OAuth Server allows clients to verify the identity of end-users based on the authentication performed by an Authorization Server and also to obtain basic profile (Scope) information about the end-users in an interoperable and REST-like manner.


How does OAuth / OpenID work?

OAuth 2.0 Server is used to set up any Application as Identity Server to allow users to Single Sign-On / Login into their client site/application with login using OAuth / OpenID Connect protocol flows. The primary goal of this OAuth 2.0 server / Oauth Provider is to allow users to interact with multiple apps without requiring them to store sensitive credentials. You can easily configure an OAuth 2.0 / OpenID Connect server to protect your API with access tokens, or allow clients to request new access tokens and refresh them.


Joomla OAuth & OpenID Connect Single Sign-On (SSO) plugin enables secure login into Joomla using GitHub as OAuth and OpenID Connect provider. You can also configure the plugin using different Oauth providers such as Azure B2C, Office 365, and other custom providers. It supports advanced Single Sign-On (SSO) features such as user profile Attribute mapping, Role mapping, multi-tenant login, etc. Here we will go through a guide to configure SSO between Joomla and GitHub. By the end of this guide, users should be able to login to Joomla from GitHub.

click here to know more about other features we provide in Joomla OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin

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