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

Jump to bottom

fix table in server flag docs #1142

Merged
merged 1 commit into from
Nov 29, 2018
Merged

fix table in server flag docs #1142

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
44 changes: 25 additions & 19 deletions docs/graphql/manual/deployment/graphql-engine-flags/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ For ``graphql-engine`` command these are the flags available
<postgres/postgresql>://<user>:<password>@<host>:<port>/<db-name>
Example: postgres://admin:[email protected]: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
Expand Down Expand Up @@ -76,26 +78,30 @@ These are the environment variables which are available:

.. code-block:: none

HASURA_GRAPHQL_DATABASE_URL Postgres database URL
<postgres/postgresql>://<user>:<password>@<host>:<port>/<db-name>
Example: postgres://admin:[email protected]:5432/mydb
HASURA_GRAPHQL_SERVER_PORT Port on which graphql-engine should be served
HASURA_GRAPHQL_DATABASE_URL Postgres database URL
<postgres/postgresql>://<user>:<password>@<host>:
<port>/<db-name>
Example: postgres://admin:[email protected]: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":
"<your-hmac-shared-secret>"}`,`{"type": "RS256",
"key": "<your-PEM-RSA-public-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":
"<your-hmac-shared-secret>"}`,`{"type": "RS256",
"key": "<your-PEM-RSA-public-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'