Installation

There are three ways to install Drupal OAuth & OpenID connect Login - OAuth2 Client SSO Login module.

  1. Using Composer:
    Pre-requisite - Composer is installed on the local machine, and the Drupal site is managed by the Composer.
    • Download and Install module: composer require Drupal / miniorange_oauth_client
    • Navigate to the Extend menu on your Drupal admin console and search for miniOrange OAuth Client using the search box.
    • Enable the module by checking the checkbox and clicking on the Install button.
    • You can configure the module at {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
       
  2. Using Drush:
    • Download the module: composer require drupal/miniorange_oauth_client
    • Install the module: drush en miniorange_oauth_client
    • Clear the cache: drush cr
    • You can configure the module at {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
       
  3. Using DDEV:
    • From the command prompt go to the directory where you keep projects (in this example, "home/drupal" is assumed). You may need to create it if you haven’t already. E.g.: mkdir -p ~/home/drupal && cd ~/home/drupal
    • Create a new directory for the miniOrange OAuth Client. Note, you should pick a folder name that can form a valid domain name. Underscores are not allowed. E.g.: mkdir minioauth && cd minioauth
    • Initialize the DDEV project: ddev config --project-type=drupal10 --docroot=web --create-docroot
    • Start DDEV: start ddev
    • Next, we need to install the Drupal core: ddev composer create "drupal/recommended-project"
    • Install the miniOrange OAuth Client module with Composer: ddev composer require 'drupal/miniorange_oauth_client'
    • Now, we’ll need to launch Drupal in the browser to install. Run from the command prompt: ddev launch
    • Follow the prompts in the browser to install Drupal.
    • When logged in as admin (which you should be on completion of installation), select Extend from the top menu bar.
    • Use the filter box to find miniOrange OAuth, select it, and click Install.
    • You can configure the module at: {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
       
  4. Manual Installation:
    Pre-requisite - The core Update Manager module must be installed.
    • Go to the Extend menu on your Drupal admin console and click on Install new module.
    • Install the Drupal OAuth & OpenID Connect Login - OAuth2 Client SSO Login module either by downloading the zip or from the URL of the package(tar/zip).
    • Click on Enable newly added modules.
    • Enable the module.
    • You can configure the module at {BaseURL}/admin/config/people/miniorange_oauth_client/config_clc