vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

https: Added information on configuring graphql, cors & request-body-size-limit

Browse Source
This commit is contained in:
Alex W 2024-04-17 23:08:38 +01:00
parent a5fcebd11b
commit a32ff6ec89
1 changed files with 35 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/configuration/service/https.rst
View File

@ -55,6 +55,10 @@ Configuration
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 API
=== ===
@ -70,7 +74,36 @@ API
.. cfgcmd:: set service https api strict .. 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 Example Configuration