ソースを参照

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 <rzabaluev@provectus.com>
sti-yvi 2 年 前
コミット
4eb969000f
1 ファイル変更33 行追加3 行削除
  1. 33 3
      configuration/authentication/oauth2.md

+ 33 - 3
configuration/authentication/oauth2.md

@@ -4,7 +4,7 @@
 
 ### Cognito
 
-```
+```yaml
 kafka:
   clusters:
     - name: local
@@ -33,7 +33,7 @@ auth:
 
 ### Google
 
-```
+```yaml
 kafka:
   clusters:
     - name: local
@@ -55,13 +55,39 @@ auth:
 
 ```
 
-### Github:
+### GitHub
 
 Example of callback URL for github OAuth app settings:
 
 `https://www.kafka-ui.provectus.io/login/oauth2/code/github`
 
+For the self-hosted installation find the properties a little bit below.
+
+```yaml
+kafka:
+  clusters:
+    - name: local
+      bootstrapServers: localhost:9092
+    # ...
+
+auth:
+  type: OAUTH2
+  oauth2:
+    client:
+      github:
+        provider: github
+        clientId: xxx
+        clientSecret: yyy
+        scope:
+          - read:org
+        user-name-attribute: login
+        custom-params:
+          type: github
 ```
+
+#### Self-hosted/Cloud (GitHub Enterprise Server)
+
+```yaml
 kafka:
   clusters:
     - name: local
@@ -81,4 +107,8 @@ auth:
         user-name-attribute: login
         custom-params:
           type: github
+        authorization-uri: http(s)://HOSTNAME/login/oauth/authorize
+        token-uri: http(s)://HOSTNAME/login/oauth/access_token
+        user-info-uri: http(s)://HOSTNAME/api/v3/user
 ```
+Replace `HOSTNAME` by your self-hosted platform FQDN.