diff options
| author | Alex W <embezzle.dev@proton.me> | 2024-04-17 23:08:38 +0100 |
|---|---|---|
| committer | Alex W <embezzle.dev@proton.me> | 2024-04-17 23:08:38 +0100 |
| commit | a32ff6ec894450c17538af514a5f9cf64c546504 (patch) | |
| tree | ae718bbc3928ba34c9583d52c50fa3d5f061f1e4 | |
| parent | a5fcebd11b19577e082c344fd2532e8689719d9e (diff) | |
| download | vyos-documentation-a32ff6ec894450c17538af514a5f9cf64c546504.tar.gz vyos-documentation-a32ff6ec894450c17538af514a5f9cf64c546504.zip | |
https: Added information on configuring graphql, cors & request-body-size-limit
| -rw-r--r-- | docs/configuration/service/https.rst | 37 |
1 files changed, 35 insertions, 2 deletions
diff --git a/docs/configuration/service/https.rst b/docs/configuration/service/https.rst index 973c5355..af397456 100644 --- a/docs/configuration/service/https.rst +++ b/docs/configuration/service/https.rst @@ -53,7 +53,11 @@ Configuration .. cfgcmd:: set service https vrf <name> - Start Webserver in given VRF. + Start Webserver in given VRF. + +.. cfgcmd:: set service https request-body-size-limit <size> + + Set the maximum request body size in megabytes. Default is 1MB. API === @@ -70,7 +74,36 @@ API .. cfgcmd:: set service https api strict - Enforce strict path checking + Enforce strict path checking. + +.. cfgcmd:: set service https api cors allow-origin <origin> + + Allow cross-origin requests from `<origin>`. + +GraphQL +======= + +.. cfgcmd:: set service https api graphql introspection + + Enable GraphQL Schema introspection. + +.. note:: Do not leave introspection enabled in production, it is a security risk. + +.. cfgcmd:: set service https api graphql authentication type <key | token> + + Set the authentication type for GraphQL, default option is key. Available options are: + + * ``key`` use API keys configured in ``service https api keys`` + + * ``token`` use JWT tokens. + +.. cfgcmd:: set service https api graphql authentication expiration + + Set the lifetime for JWT tokens in seconds. Default is 3600 seconds. + +.. cfgcmd:: set service https api graphql authentication secret-length + + Set the byte length of the JWT secret. Default is 32. ********************* Example Configuration |