towk/opaal
1
0
Fork 0
mirror of https://github.com/davidallendj/opaal.git synced 2025-12-20 03:27:02 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added README.md

Browse source
This commit is contained in:
David Allen 2024-02-21 20:27:57 -07:00
parent 5bae300daa
commit 74fbcc4cbc
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md Normal file
View file

@ -0,0 +1,12 @@
# OpenID Connect Authentication Helper
This is a small, simple, experimental helper tool that automates the authorization code flow for logging in with an identity provider like GitHub or GitLab. To use this tool, you will have to register an OAuth2 application with you identity provider. Make sure you register the application first before proceeding, then set the callback URL to `{your host}/oauth/callback`.
To get started with the authentication flow, run the following commands:
```bash
./oidc config ./config.yaml
./oidc login --config config.yaml
```
These commands will create a default config, then start the login process. Initially, you'll have to click on the link created based on you configuration, login with your IdP, then authorize the client to within the set scope.