Skip to content

Commit

Permalink
docs: add proxy_opts attribute for openid-connect.md (#9922)
Browse files Browse the repository at this point in the history
  • Loading branch information
darksheep404 committed Aug 2, 2023
1 parent 521d6c0 commit 2af32a1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/en/latest/plugins/openid-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ description: OpenID Connect allows the client to obtain user information from th
| session | object | False | | | When bearer_only is set to false, openid-connect will use Authorization Code flow to authenticate on the IDP, so you need to set the session-related configuration. |
| session.secret | string | True | Automatic generation | 16 or more characters | The key used for session encrypt and HMAC operation. |
| unauth_action | string | False | "auth" | | Specify the response type on unauthenticated requests. "auth" redirects to identity provider, "deny" results in a 401 response, "pass" will allow the request without authentication. |
| proxy_opts | object | False | | {<br/> http_proxy: http://your-proxy.com:your-proxy-port,<br/> https_proxy: http://your-proxy.com:your-proxy-port<br/> } | domain and port of the proxy server |

NOTE: `encrypt_fields = {"client_secret"}` is also defined in the schema, which means that the field will be stored encrypted in etcd. See [encrypted storage fields](../plugin-develop.md#encrypted-storage-fields).

Expand Down
1 change: 1 addition & 0 deletions docs/zh/latest/plugins/openid-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ description: OpenID Connect(OIDC)是基于 OAuth 2.0 的身份认证协议
| set_refresh_token_header | boolean || false | | 当设置为 `true` 并且刷新令牌可用时,则会将该属性设置在`X-Refresh-Token`请求头中。 |
| session | object || | | 当设置 bearer_only 为 false 时,openid-connect 插件将使用 Authorization Code 在 IDP 上进行认证,因此你必须设置 session 相关设置。 |
| session.secret | string || 自动生成 | 16 个以上字符 | 用于 session 加密和 HMAC 计算的密钥。 |
| proxy_opts | object || | {<br/> http_proxy: http://your-proxy.com:your-proxy-port,<br/> https_proxy: http://your-proxy.com:your-proxy-port<br/> } | 用于设置代理服务器域名与端口 |

注意:schema 中还定义了 `encrypt_fields = {"client_secret"}`,这意味着该字段将会被加密存储在 etcd 中。具体参考 [加密存储字段](../plugin-develop.md#加密存储字段)

Expand Down

0 comments on commit 2af32a1

Please sign in to comment.