From d0a935387261d1a32eba673bee980cf43df7224f Mon Sep 17 00:00:00 2001 From: Michael Quigley Date: Tue, 3 Oct 2023 17:01:29 -0400 Subject: [PATCH] working through oauth client id creation; notes and tweaks (#404) --- .../self-hosting/oauth/configuring-oauth.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/guides/self-hosting/oauth/configuring-oauth.md b/docs/guides/self-hosting/oauth/configuring-oauth.md index 5261f295..6659b4ab 100644 --- a/docs/guides/self-hosting/oauth/configuring-oauth.md +++ b/docs/guides/self-hosting/oauth/configuring-oauth.md @@ -1,3 +1,27 @@ +# OAuth Configuration + +As of `v0.4.7`, `zrok` includes OAuth integration for both Google and GitHub for `zrok access public` public frontends. + +This integration allows you to create public shares and request that the public frontend authenticate your users against either the Google or GitHub OAuth endpoints (using the user's Google or GitHub accounts). Additionally, you can restrict the email address domain associated with the count to a list of domains that you provide when you create the share. + +This is a first step towards a more comprehensive portfolio of user authentication strategies in future `zrok` releases. + +## Planning for the OAuth Frontend + +The current implementation of the public frontend OAuth integration uses a separate listening address and port from the public frontend itself. + +After this frontend is configured, we'll use the OAuth frontend address when creating the OAuth clients for Google and GitHub. + +## Configuring a Google OAuth Client + +### OAuth Content Screen + +Configure the application in the OAuth Content Screen. + +### Create the OAuth 2.0 Client ID + + + ## Enabling Oauth on Access Point There is a new stanza in the access point configuration.