Skip to content

Commit

Permalink
https: Added information on configuring graphql, cors & request-body-…
Browse files Browse the repository at this point in the history
…size-limit
  • Loading branch information
Embezzle committed Apr 17, 2024
1 parent a5fcebd commit a32ff6e
Showing 1 changed file with 35 additions and 2 deletions.
37 changes: 35 additions & 2 deletions docs/configuration/service/https.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===
Expand All @@ -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.

Check warning on line 90 in docs/configuration/service/https.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=82

.. cfgcmd:: set service https api graphql authentication type <key | token>

Set the authentication type for GraphQL, default option is key. Available options are:

Check warning on line 94 in docs/configuration/service/https.rst

View workflow job for this annotation

GitHub Actions / lint

Line too long: len=89

* ``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
Expand Down

0 comments on commit a32ff6e

Please sign in to comment.