From 74fbcc4cbc29837ca0f18d768aa90990c365e917 Mon Sep 17 00:00:00 2001 From: "David J. Allen" Date: Wed, 21 Feb 2024 20:27:57 -0700 Subject: [PATCH] Added README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d9da3ad --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file