https://github.com/lgdd/openid-connect-single-button

A Liferay Fragment to configure and display and single "Sign in" button to an OpenId Connect Provider.
https://github.com/lgdd/openid-connect-single-button

fragment liferay liferay-dxp liferay-portal

Last synced: 3 months ago
JSON representation

A Liferay Fragment to configure and display and single "Sign in" button to an OpenId Connect Provider.

• Host: GitHub
• URL: https://github.com/lgdd/openid-connect-single-button
• Owner: lgdd
• License: mit
• Created: 2020-12-07T17:42:53.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T11:20:19.000Z (over 1 year ago)
• Last Synced: 2025-03-12T22:18:11.071Z (7 months ago)
• Topics: fragment, liferay, liferay-dxp, liferay-portal
• Language: JavaScript
• Homepage:
• Size: 6.84 KB
• Stars: 1
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# OpenID Connect Single Button

A Liferay Fragment to configure and display and single "Sign in" button to an OpenId Connect Provider.

![demo](https://github.com/lgdd/doc-assets/blob/main/openid-connect-single-button/liferay-oidc-single-button-fragment.gif?raw=true)

## Example

You enable OpenID Connect (OIDC) and add a provider under `Instance Settings > SSO > OpenID Connect Provider`.

Now the default login display a link to `OpenID Connect` redirecting you to a form where you can choose an OpenID Connect Provider and sign in with it.

With this fragment, you can give to end users a single button to sign in to an OIDC Provider (e.g. `Sign in with GitHub`).

You might have recognized Keycloak in the GIF above. If you're interested in this setup, take a look at this repo: https://github.com/lgdd/liferay-keycloak-demo.

## How to import into Liferay

Run `npm run import` and follow instructions or `npm run compress` to create a zip file and import from Liferay UI.

## Notes

This project has been created with [generator-liferay-fragments][1]. You can read

how to manage this project in the [generator documentation][2].

[1]: https://www.npmjs.com/package/generator-liferay-fragments

[2]: https://www.npmjs.com/package/generator-liferay-fragments#usage

## License

[MIT](LICENSE)