@luigi-project/plugin-auth-oauth2

OAuth2 - Authorization Plugin for Luigi Core

Overview

This project contains a library that allows your application to extend the Luigi framework with an OAuth2 authorization provider. Further configuration details can be found in the main documentation.

Installation

Install the plugin in your project using npm:

npm install @luigi-project/plugin-auth-oauth2

Import the plugin in places where you want to use it, depending on the environment of your choice:

var oAuth2ImplicitGrant = require('@luigi-project/plugin-auth-oauth2');

or

import oAuth2ImplicitGrant from '@luigi-project/plugin-auth-oauth2';

Then, integrate it as an authorization provider in your Luigi configuration file:

Luigi.setConfig({
  auth: {
    use: 'myProviderConfig',
    myProviderConfig: {
      idpProvider: oAuth2ImplicitGrant,
      // ... configuration data comes here
      redirect_uri: '/assets/auth-oauth2/callback.html'
    }
  }
})

The callback.html needs to be copied to a folder in your Luigi Core installation, which is the return path for the IdP provider, configured through the redirect_uri setting. The default location of redirect_uri is /assets/auth-oauth2/callback.html.

const CopyWebpackPlugin = require('copy-webpack-plugin');

{
  plugins: [
    new CopyWebpackPlugin([{
      from: 'node_modules/@luigi-project/plugin-auth-oauth2/callback.html',
      to: 'src/assets/auth-oauth2'
    }])
  ]
}

Changelog

v1.7.0 (2020-12-04)

:rocket: Added

• #1756 Feature - Angular supporting library (@legteodav)
• #1751 Feature - WebComponents support (@hardl)

:bug: Fixed

• #1720 Fix withoutSync() history behaviour (@andrei-scripcaru)

:house: Internal

• #1734 Documentation website using Luigi.globalSearch() API (#1690) (@legteodav)