From 0752cdd9167aa5a44b65bdc84df0f2e8174aa5b2 Mon Sep 17 00:00:00 2001 From: rikinsk Date: Thu, 29 Nov 2018 15:57:31 +0530 Subject: [PATCH] fix table in server flag docs --- .../graphql-engine-flags/reference.rst | 44 +++++++++++-------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst b/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst index 18eb8e1cf3353..be1e127e79ad8 100644 --- a/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst +++ b/docs/graphql/manual/deployment/graphql-engine-flags/reference.rst @@ -18,7 +18,9 @@ For ``graphql-engine`` command these are the flags available ://:@:/ Example: postgres://admin:mypass@mydomain.com:5432/mydb - Or either you can specify following options +Or either you can specify following options + +.. code-block:: none --host Postgres server host -p, --port Postgres server port @@ -76,26 +78,30 @@ 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_SERVER_PORT Port on which graphql-engine should be served + HASURA_GRAPHQL_DATABASE_URL Postgres database URL + ://:@: + / + Example: postgres://admin:mypass@mydomain.com:5432/mydb + + HASURA_GRAPHQL_SERVER_PORT Port on which graphql-engine should be served + + 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_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_UNAUTHORIZED_ROLE Unauthorized role, used when access-key is not sent in + access-key only mode or "Authorization" header is absent + in JWT mode - HASURA_GRAPHQL_UNAUTHORIZED_ROLE Unauthorized role, used when access-key is not sent in access-key - only mode or "Authorization" header is absent in JWT mode - HASURA_GRAPHQL_ENABLE_CONSOLE Enable API console. It is served at '/' and '/console' + HASURA_GRAPHQL_ENABLE_CONSOLE Enable API console. It is served at '/' and '/console'