extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-08-15 18:42:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

screenshots for oauth client creation for both github and google (#404)

Browse Source
This commit is contained in:
Michael Quigley
2023-10-04 14:22:33 -04:00
parent a532a3e42a
commit 202613d9cd
16 changed files with 27 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/guides/self-hosting/oauth/configuring-oauth.md
View File

@ -1,4 +1,4 @@
# OAuth Configuration
# OAuth Public Frontend Configuration
As of `v0.4.7`, `zrok` includes OAuth integration for both Google and GitHub for `zrok access public` public frontends.
@ -18,32 +18,56 @@ After this frontend is configured, we'll use the OAuth frontend address when cre
`APIs & Services > Credentials > OAuth content screen`
Configure the application in the OAuth Content Screen.
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/google_oauth_content_screen_2.png)
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/google_oauth_content_screen_3.png)
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/google_oauth_content_screen_4.png)
Add a non-sensitive scope for `../auth/userinfo.email`.
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/google_oauth_content_screen_5.png)
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/google_oauth_content_screen_6.png)
### Create the OAuth 2.0 Client ID
`APIs & Services > Credentials > + Create Credentials`
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/google_create_credentials_1.png)
Select `OAuth client ID`
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/google_create_credentials_2.png)
Application type is `Web Application`
Name it whatever you'd like
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/google_create_credentials_3.png)
Authorized redirect URIs:
Use the address of the OAuth frontend you configured above, but you're going to add `/google/oauth` to the end of the URL.
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/google_create_credentials_4.png)
Save the client ID and the client secret. You'll configure these into your `frontend.yml`.
## Configuring a GitHub Client ID
`Settings > Developer Settings > OAuth Apps > Register a new application`
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/github_create_oauth_application_1.png)
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/github_create_oauth_application_2.png)
Authorization Callback URL: Use the address of the OAuth frontend you configured above, but add `/github/oauth` to the end of the URL.
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/github_create_oauth_application_3.png)
![](/home/michael/Repos/nf/zrok/docs/guides/self-hosting/oauth/images/github_create_oauth_application_4.png)
Save the client ID and the client secret. You'll configure these into your `frontend.yml`.
## Enabling Oauth on Access Point
There is a new stanza in the access point configuration.