From 300684f2dcd5d9c8f3e3b164bfa494bac0bbcf28 Mon Sep 17 00:00:00 2001 From: Utkarsh Gupta Date: Thu, 4 Oct 2018 20:05:13 +0530 Subject: [PATCH] add docs for jwt_secret & enable_console env (#646) --- .../graphql-engine-flags/reference.rst | 28 ++++++++++++------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst b/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst index 21fc12bd695..70cacd705de 100644 --- a/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst +++ b/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst @@ -71,19 +71,27 @@ These are the environment variables which are available: .. code-block:: none - HASURA_GRAPHQL_DATABASE_URL Postgres database URL - ://:@:/ - Example: postgres://admin:mypass@mydomain.com:5432/mydb + HASURA_GRAPHQL_DATABASE_URL Postgres database URL + ://:@:/ + Example: postgres://admin:mypass@mydomain.com:5432/mydb - HASURA_GRAPHQL_ACCESS_KEY Secret access key, required to access this instance. - If specified client needs to send 'X-Hasura-Access-Key' - header + HASURA_GRAPHQL_ACCESS_KEY Secret access key, required to access this instance. + If specified client needs to send 'X-Hasura-Access-Key' + header - HASURA_GRAPHQL_AUTH_HOOK The authentication webhook, required to authenticate - incoming request + HASURA_GRAPHQL_AUTH_HOOK The authentication webhook, required to authenticate + 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": + ""}`,`{"type": "RS256", + "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::