Skip to content

Commit

Permalink
[TT-13742] Update documentation for master (#5840)
Browse files Browse the repository at this point in the history
  • Loading branch information
buger authored Dec 31, 2024
1 parent 8deca94 commit 8e2fc71
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 3 deletions.
2 changes: 1 addition & 1 deletion tyk-docs/assets/others/dashboard-swagger.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ info:
name: Mozilla Public License Version 2.0
url: https://github.com/TykTechnologies/tyk/blob/master/LICENSE.md
title: Tyk Dashboard API
version: 5.7.0
version: 5.7.1
servers:
- url: https://{tenant}
variables:
Expand Down
4 changes: 2 additions & 2 deletions tyk-docs/assets/others/gateway-swagger.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ info:
name: Mozilla Public License Version 2.0
url: https://github.com/TykTechnologies/tyk/blob/master/LICENSE.md
title: Tyk Gateway API
version: 5.7.0
version: 5.7.1
servers:
- url: https://{tenant}
variables:
Expand Down Expand Up @@ -8142,4 +8142,4 @@ components:
description: Api key
in: header
name: X-Tyk-Authorization
type: apiKey
type: apiKey
12 changes: 12 additions & 0 deletions tyk-docs/content/shared/dashboard-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -838,6 +838,18 @@ Type: `string`<br />

When using SAML with embedded identity broker, is required to upload a certificate that is encoded by the gateway to store it safely, TIB needs the private key as well, hence it needs the same encoding secret so the information is decoded successfully. This value should match with the encoding secret set in the gateway config file, if not set then it will use by default tyk_api_config.secret to attempt to decode the certificate.

### security.forbid_admin_view_access_token
ENV: <b>TYK_DB_SECURITY_FORBIDADMINVIEWACCESSTOKEN</b><br />
Type: `bool`<br />

ForbidAdminViewAccessToken is a security feature that allows you to prevent the admin user from viewing the access token of a user. The default is false.

### security.forbid_admin_reset_access_token
ENV: <b>TYK_DB_SECURITY_FORBIDADMINRESETACCESSTOKEN</b><br />
Type: `bool`<br />

ForbidAdminResetAccessToken is a security feature that allows you to prevent the admin user from resetting the access token of a user. The default is false.

### ui
This section controls various settings for the look and feel of the Dashboard UI.

Expand Down
3 changes: 3 additions & 0 deletions tyk-docs/content/shared/gateway-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -725,6 +725,9 @@ If set to `true`, distributed rate limiter will be disabled for this node, and i
If you set `db_app_conf_options.node_is_segmented` to `true` for multiple Gateway nodes, you should ensure that `management_node` is set to `false`.
This is to ensure visibility for the management node across all APIs.
{{< /note >}}
For pro installations, `management_node` is not a valid configuration option.
Always set `management_node` to `false` in pro environments.


### auth_override
This is used as part of the RPC / Hybrid back-end configuration in a Tyk Enterprise installation and isn’t used anywhere else.
Expand Down

0 comments on commit 8e2fc71

Please sign in to comment.