Tao Chen 1 год назад
Родитель
Сommit
e838d5bcd2
4 измененных файлов с 8 добавлено и 4 удалено
  1. 4 2
      README.md
  2. 4 2
      README_EN.md
  3. BIN
      docs/en_img/web_admin_oauth.png
  4. BIN
      docs/web_admin_oauth.png

+ 4 - 2
README.md

@@ -92,7 +92,7 @@
92
 
92
 
93
 #### 登录
93
 #### 登录
94
 
94
 
95
-- 添加了`github`和`google`授权登录,需要在后台配置好就可以用了,具体可看后台OAuth配置
95
+- 添加了`github`, `google` 以及`OIDC`授权登录,需要在后台配置好就可以用了,具体可看后台OAuth配置
96
 - 添加了web后台授权登录,点击后直接登录后台就自动登录客户端了
96
 - 添加了web后台授权登录,点击后直接登录后台就自动登录客户端了
97
 
97
 
98
 ![pc_login](docs/pc_login.png)
98
 ![pc_login](docs/pc_login.png)
@@ -124,8 +124,10 @@
124
 4. 可以直接打开webclient,方便使用;也可以分享给游客,游客可以直接通过webclient远程到设备
124
 4. 可以直接打开webclient,方便使用;也可以分享给游客,游客可以直接通过webclient远程到设备
125
 
125
 
126
    ![web_webclient](docs/admin_webclient.png)
126
    ![web_webclient](docs/admin_webclient.png)
127
-5. Oauth,暂时只支持了`Github`和`Google`, 需要创建一个`OAuth App`,然后配置到后台
127
+5. Oauth,支持了`Github`, `Google` 以及 `OIDC`, 需要创建一个`OAuth App`,然后配置到后台
128
    ![web_admin_oauth](docs/web_admin_oauth.png)
128
    ![web_admin_oauth](docs/web_admin_oauth.png)
129
+    - 对于`Google` 和 `Github`, `Issuer` 和 `Scopes`不需要填写.
130
+    - 对于`OIDC`, `Issuer`是必须的。`Scopes`是可选的,默认为 `openid,profile,email`. 确保可以获取 `sub`,`email` 和`preferred_username`
129
     - `github oauth app`在`Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App`
131
     - `github oauth app`在`Settings`->`Developer settings`->`OAuth Apps`->`New OAuth App`
130
       中创建,地址 [https://github.com/settings/developers](https://github.com/settings/developers)
132
       中创建,地址 [https://github.com/settings/developers](https://github.com/settings/developers)
131
     - `Authorization callback URL`填写`http://<your server[:port]>/api/oauth/callback`
133
     - `Authorization callback URL`填写`http://<your server[:port]>/api/oauth/callback`

+ 4 - 2
README_EN.md

@@ -93,7 +93,7 @@ Basic implementation of the PC client's primary interfaces.Supports the Personal
93
 
93
 
94
 #### Login
94
 #### Login
95
 
95
 
96
-- Added `GitHub` and `Google` login, which can be used after configuration in the admin panel. See the OAuth
96
+- Added `GitHub`, `Google` and `OIDC` login, which can be used after configuration in the admin panel. See the OAuth
97
   configuration section for details.
97
   configuration section for details.
98
 - Added authorization login for the web admin panel.
98
 - Added authorization login for the web admin panel.
99
 
99
 
@@ -128,9 +128,11 @@ installation are `admin` `admin`, please change the password immediately.
128
 4. You can directly launch the client or open the web client for convenience; you can also share it with guests, who can remotely access the device via the web client.
128
 4. You can directly launch the client or open the web client for convenience; you can also share it with guests, who can remotely access the device via the web client.
129
 
129
 
130
    ![web_webclient](docs/en_img/admin_webclient.png)
130
    ![web_webclient](docs/en_img/admin_webclient.png)
131
-5. OAuth support: Currently, `GitHub` and `Google`  is supported. You need to create an `OAuth App` and configure it in
131
+5. OAuth support: Currently, `GitHub`, `Google` and `OIDC`  are supported. You need to create an `OAuth App` and configure it in
132
    the admin panel.
132
    the admin panel.
133
    ![web_admin_oauth](docs/en_img/web_admin_oauth.png)
133
    ![web_admin_oauth](docs/en_img/web_admin_oauth.png)
134
+    - For `Google` and `Github`, you don't need to fill the `Issuer` and `Scpoes`
135
+    - For `OIDC`, you must set the `Issuer`. And `Scopes` is optional which default is `openid,email,profile`, please make sure this `Oauth App` can access `sub`, `email` and `preferred_username`
134
     - Create a `GitHub OAuth App`
136
     - Create a `GitHub OAuth App`
135
       at `Settings` -> `Developer settings` -> `OAuth Apps` -> `New OAuth App` [here](https://github.com/settings/developers).
137
       at `Settings` -> `Developer settings` -> `OAuth Apps` -> `New OAuth App` [here](https://github.com/settings/developers).
136
     - Set the `Authorization callback URL` to `http://<your server[:port]>/api/oauth/callback`,
138
     - Set the `Authorization callback URL` to `http://<your server[:port]>/api/oauth/callback`,

BIN
docs/en_img/web_admin_oauth.png


BIN
docs/web_admin_oauth.png