mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-17 12:31:52 +03:00
dada14b1ad
* add $ before commands in server flag reference docs * add deploy to AWS RDS blog link to guides in docs * fix pagination expressionin reference docs * update many-to-many relationship docs * add _not operator + filtering over relationships docs
102 lines
4.3 KiB
ReStructuredText
102 lines
4.3 KiB
ReStructuredText
GraphQL engine server flags reference
|
|
=====================================
|
|
|
|
Every GraphQL engine command is structured as:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ graphql-engine <server-flags> serve <command-flags>
|
|
|
|
Server flags
|
|
^^^^^^^^^^^^
|
|
|
|
For ``graphql-engine`` command these are the flags available
|
|
|
|
.. code-block:: none
|
|
|
|
--database-url Postgres database URL
|
|
<postgres/postgresql>://<user>:<password>@<host>:<port>/<db-name>
|
|
Example: postgres://admin:mypass@mydomain.com:5432/mydb
|
|
|
|
Or either you can specify following options
|
|
|
|
--host Postgres server host
|
|
-p, --port Postgres server port
|
|
-u, --user Database user name
|
|
-p, --password Password of the user
|
|
-d, --dbname Database name to connect to
|
|
|
|
Command flags
|
|
^^^^^^^^^^^^^
|
|
|
|
For ``serve`` subcommand these are the flags available
|
|
|
|
.. code-block:: none
|
|
|
|
--server-port Port on which graphql-engine should be served (default: 8080)
|
|
--access-key Secret access key, required to access this instance.
|
|
If specified client needs to send 'X-Hasura-Access-Key'
|
|
header
|
|
--cors-domain The domain, including sheme and port, to allow CORS for
|
|
--disable-cors Disable CORS handling
|
|
--auth-hook The authentication webhook, required to authenticate
|
|
incoming request
|
|
--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>"}
|
|
--unauthorized-role Unauthorized role, used when access-key is not sent in access-key
|
|
only mode or "Authorization" header is absent in JWT mode
|
|
-s, --stripes Number of stripes
|
|
-c, --connections Number of connections that need to be opened to Postgres
|
|
--timeout Each connection's idle time before it is closed
|
|
-i, --tx-iso Transaction isolation. read-commited / repeatable-read /
|
|
serializable
|
|
--root-dir This static dir is served at / and takes precedence over
|
|
all routes
|
|
--enable-console Enable API console. It is served at '/' and '/console'
|
|
|
|
|
|
Default environment variables
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
You can use environment variables to configure defaults instead of using flags:
|
|
|
|
.. note::
|
|
When the equivalent flags for environment variables are used, the flags will take precedence.
|
|
|
|
For example:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ HASURA_GRAPHQL_DATABASE_URL=postgres://user:pass@host:5432/dbname graphql-engine serve
|
|
|
|
|
|
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: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_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_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_ENABLE_CONSOLE Enable API console. It is served at '/' and '/console'
|