hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00
Code Issues Projects Releases Wiki Activity

add docs for jwt_secret & enable_console env (#646)

Browse Source
This commit is contained in:
Utkarsh Gupta 2018-10-04 20:05:13 +05:30 committed by Shahidh K Muhammed
parent 1e8e440bbc
commit 300684f2dc
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/graphql/manual/deployment/graphql-engine-flags/reference.rst
View File

@ -71,19 +71,27 @@ These are the environment variables which are available:
.. code-block:: none .. code-block:: none
HASURA_GRAPHQL_DATABASE_URL Postgres database URL HASURA_GRAPHQL_DATABASE_URL Postgres database URL
<postgres/postgresql>://<user>:<password>@<host>:<port>/<db- <postgres/postgresql>://<user>:<password>@<host>:<port>/<db-
name> name>
Example: postgres://admin:mypass@mydomain.com:5432/mydb Example: postgres://admin:mypass@mydomain.com:5432/mydb
HASURA_GRAPHQL_ACCESS_KEY Secret access key, required to access this instance. HASURA_GRAPHQL_ACCESS_KEY Secret access key, required to access this instance.
If specified client needs to send 'X-Hasura-Access-Key' If specified client needs to send 'X-Hasura-Access-Key'
header header
HASURA_GRAPHQL_AUTH_HOOK The authentication webhook, required to authenticate HASURA_GRAPHQL_AUTH_HOOK The authentication webhook, required to authenticate
incoming request incoming request
HASURA_GRAPHQL_CORS_DOMAIN The domain, including sheme and port, to allow CORS for HASURA_GRAPHQL_CORS_DOMAIN The domain, including sheme and port, to allow CORS for
HASURA_GRAPHQL_JWT_SECRET The JSON containing type and the JWK used for
verifying. e.g: `{"type": "HS256", "key":
"<your-hmac-shared-secret>"}`,`{"type": "RS256",
"key": "<your-PEM-RSA-public-key>"}
Enable JWT mode, the value of which is a JSON
HASURA_GRAPHQL_ENABLE_CONSOLE Enable API console. It is served at '/' and '/console'
.. note:: .. note::