Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Apr 18, 2024
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions docs/configuration/service/https.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,11 @@

.. 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 @@

.. 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
Loading