Skip to content

Commit 4eb9690

Browse files
sti-yviHaarolean
andauthored
Update GitHub OAuth configuration for GitHub Enterprise Server (#3577)
* Update GitHub OAuth configuration for GitHub Enterprise Server * Update oauth2.md Lil updates --------- Co-authored-by: Roman Zabaluev <[email protected]>
1 parent c6e46dc commit 4eb9690

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

configuration/authentication/oauth2.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Cognito
66

7-
```
7+
```yaml
88
kafka:
99
clusters:
1010
- name: local
@@ -33,7 +33,7 @@ auth:
3333
3434
### Google
3535
36-
```
36+
```yaml
3737
kafka:
3838
clusters:
3939
- name: local
@@ -55,13 +55,39 @@ auth:
5555

5656
```
5757

58-
### Github:
58+
### GitHub
5959

6060
Example of callback URL for github OAuth app settings:
6161

6262
`https://www.kafka-ui.provectus.io/login/oauth2/code/github`
6363

64+
For the self-hosted installation find the properties a little bit below.
65+
66+
```yaml
67+
kafka:
68+
clusters:
69+
- name: local
70+
bootstrapServers: localhost:9092
71+
# ...
72+
73+
auth:
74+
type: OAUTH2
75+
oauth2:
76+
client:
77+
github:
78+
provider: github
79+
clientId: xxx
80+
clientSecret: yyy
81+
scope:
82+
- read:org
83+
user-name-attribute: login
84+
custom-params:
85+
type: github
6486
```
87+
88+
#### Self-hosted/Cloud (GitHub Enterprise Server)
89+
90+
```yaml
6591
kafka:
6692
clusters:
6793
- name: local
@@ -81,4 +107,8 @@ auth:
81107
user-name-attribute: login
82108
custom-params:
83109
type: github
110+
authorization-uri: http(s)://HOSTNAME/login/oauth/authorize
111+
token-uri: http(s)://HOSTNAME/login/oauth/access_token
112+
user-info-uri: http(s)://HOSTNAME/api/v3/user
84113
```
114+
Replace `HOSTNAME` by your self-hosted platform FQDN.

0 commit comments

Comments
 (0)