mirror of
https://github.com/openziti/zrok.git
synced 2025-08-17 19:31:12 +02:00
docs (#968)
This commit is contained in:
@@ -1 +1,45 @@
|
||||
# Github
|
||||
---
|
||||
sidebar_position: 20
|
||||
---
|
||||
|
||||
# GitHub OAuth Setup
|
||||
|
||||
This guide covers setting up GitHub OAuth for your zrok public frontend.
|
||||
|
||||
## Register OAuth Application
|
||||
|
||||
Navigate to your GitHub account settings: **Settings > Developer Settings > OAuth Apps > Register a new application**
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
Configure the **Authorization callback URL** to match your OAuth frontend address with `/github/oauth` appended:
|
||||
|
||||

|
||||
|
||||
Create a new client secret:
|
||||
|
||||

|
||||
|
||||
Save the client ID and client secret for your frontend configuration.
|
||||
|
||||
## Frontend Configuration
|
||||
|
||||
Add the GitHub provider to your `frontend.yml`:
|
||||
|
||||
```yaml
|
||||
oauth:
|
||||
providers:
|
||||
- name: "github"
|
||||
type: "github"
|
||||
client_id: "<your-github-client-id>"
|
||||
client_secret: "<your-github-client-secret>"
|
||||
```
|
||||
|
||||
## Redirect URL Format
|
||||
|
||||
For GitHub OAuth, the redirect URL should be:
|
||||
```
|
||||
https://your-oauth-frontend-domain:port/github/oauth
|
||||
```
|
||||
|
Reference in New Issue
Block a user