summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2024-04-18 15:23:42 +0200
committerGitHub <noreply@github.com>2024-04-18 15:23:42 +0200
commite176d0d5480d8c3a5a51ddcc0fccd17d6605ec8e (patch)
tree4c0db460fa158a0d22d1ccf1c2ada04809e6d447 /docs
parent70f2258424aec50fb415ba6a3b8779ecb37ba997 (diff)
parenta32ff6ec894450c17538af514a5f9cf64c546504 (diff)
downloadvyos-documentation-e176d0d5480d8c3a5a51ddcc0fccd17d6605ec8e.tar.gz
vyos-documentation-e176d0d5480d8c3a5a51ddcc0fccd17d6605ec8e.zip
Merge pull request #1389 from Embezzle/https
https: Added information on configuring graphql, cors & request-body-size-limit
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration/service/https.rst37
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