mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-16 18:42:30 +03:00
76ceb707f4
This PR builds console static assets into the server docker image at `/srv/console-assets`. When env var `HASURA_GRAPHQL_CONSOLE_ASSETS_DIR=/srv/console-assets` or flag `--console-assets-dir=/srv/console-assets` is set on the server, the files in this directory are served at `/console/assets/*`.
The console html template will have a variable called `cdnAssets: false` when this flag is set and it loads assets from server itself instead of CDN.
The assets are moved to a new bucket with a new naming scheme:
```
graphql-engine-cdn.hasura.io/console/assets/
/common/{}
/versioned/<version/{}
/channel/<channel>/<version>/{}
```
Console served by CLI will still load assets from CDN - will fix that in the next release.
191 lines
6.5 KiB
ReStructuredText
191 lines
6.5 KiB
ReStructuredText
GraphQL engine server flags reference
|
|
=====================================
|
|
|
|
.. contents:: Table of contents
|
|
:backlinks: none
|
|
:depth: 1
|
|
:local:
|
|
|
|
Every GraphQL engine command is structured as:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ graphql-engine <server-flags> serve <command-flags>
|
|
|
|
The flags can be passed as ENV variables as well.
|
|
|
|
Server flags
|
|
^^^^^^^^^^^^
|
|
|
|
For ``graphql-engine`` command these are the flags and ENV variables available:
|
|
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
:widths: 15 20 30
|
|
|
|
* - Flag
|
|
- ENV variable
|
|
- Description
|
|
|
|
* - ``--database-url <DB_URL>``
|
|
- ``HASURA_GRAPHQL_DATABASE_URL``
|
|
- Postgres database URL:
|
|
|
|
``postgres://<user>:<password>@<host>:<port>/<db-name>``
|
|
|
|
Example: ``postgres://admin:mypass@mydomain.com:5432/mydb``
|
|
|
|
Or you can specify following options *(only via flags)*
|
|
|
|
.. code-block:: none
|
|
|
|
--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:
|
|
|
|
Command flags
|
|
^^^^^^^^^^^^^
|
|
|
|
For ``serve`` sub-command these are the flags and ENV variables available:
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
:widths: 15 20 30
|
|
|
|
* - Flag
|
|
- ENV variable
|
|
- Description
|
|
|
|
* - ``--server-port <PORT>``
|
|
- ``HASURA_GRAPHQL_SERVER_PORT``
|
|
- Port on which graphql-engine should be served (default: 8080)
|
|
|
|
* - ``--server-host <HOST>``
|
|
- ``HASURA_GRAPHQL_SERVER_HOST``
|
|
- Host on which graphql-engine will listen (default: ``*``)
|
|
|
|
* - ``--enable-console <true|false>``
|
|
- ``HASURA_GRAPHQL_ENABLE_CONSOLE``
|
|
- Enable the Hasura Console (served by the server on ``/`` and ``/console``)
|
|
|
|
* - ``--admin-secret <ADMIN_SECRET_KEY>``
|
|
- ``HASURA_GRAPHQL_ADMIN_SECRET``
|
|
- Admin secret key, required to access this instance. This is mandatory
|
|
when you use webhook or JWT.
|
|
|
|
* - ``--auth-hook <WEBHOOK_URL>``
|
|
- ``HASURA_GRAPHQL_AUTH_HOOK``
|
|
- URL of the authorization webhook required to authorize requests.
|
|
See auth webhooks docs for more details.
|
|
|
|
* - ``--auth-hook-mode <GET|POST>``
|
|
- ``HASURA_GRAPHQL_AUTH_HOOK_MODE``
|
|
- HTTP method to use for the authorization webhook (default: GET)
|
|
|
|
* - ``--jwt-secret <JSON_CONFIG>``
|
|
- ``HASURA_GRAPHQL_JWT_SECRET``
|
|
- A JSON string containing type and the JWK used for verifying (and other
|
|
optional details).
|
|
Example: ``{"type": "HS256", "key": "3bd561c37d214b4496d09049fadc542c"}``.
|
|
See the JWT docs for more details.
|
|
|
|
* - ``--unauthorized-role <ROLE>``
|
|
- ``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.
|
|
Example: ``anonymous``. Now whenever "Authorization" header is
|
|
absent, request's role will default to "anonymous".
|
|
|
|
* - ``--cors-domain <DOMAINS>``
|
|
- ``HASURA_GRAPHQL_CORS_DOMAIN``
|
|
- CSV of list of domains, excluding scheme (http/https) and including port,
|
|
to allow CORS for. Wildcard domains are allowed.
|
|
|
|
* - ``--disable-cors``
|
|
- N/A
|
|
- Disable CORS. Do not send any CORS headers on any request.
|
|
|
|
* - ``--ws-read-cookie <true|false>``
|
|
- ``HASURA_GRAPHQL_WS_READ_COOKIE``
|
|
- Read cookie on WebSocket initial handshake even when CORS is disabled.
|
|
This can be a potential security flaw! Please make sure you know what
|
|
you're doing. This configuration is only applicable when CORS is disabled.
|
|
(default: false)
|
|
|
|
* - ``--enable-telemetry <true|false>``
|
|
- ``HASURA_GRAPHQL_ENABLE_TELEMETRY``
|
|
- Enable anonymous telemetry (default: true)
|
|
|
|
* - N/A
|
|
- ``HASURA_GRAPHQL_EVENTS_HTTP_POOL_SIZE``
|
|
- Max event threads
|
|
|
|
* - N/A
|
|
- ``HASURA_GRAPHQL_EVENTS_FETCH_INTERVAL``
|
|
- Postgres events polling interval
|
|
|
|
* - ``-s, --stripes <NO_OF_STRIPES>``
|
|
- ``HASURA_GRAPHQL_PG_STRIPES``
|
|
- Number of conns that need to be opened to Postgres (default: 1)
|
|
|
|
* - ``-c, --connections <NO_OF_CONNS>``
|
|
- ``HASURA_GRAPHQL_PG_CONNECTIONS``
|
|
- Number of conns that need to be opened to Postgres (default: 50)
|
|
|
|
* - ``--timeout <SECONDS>``
|
|
- ``HASURA_GRAPHQL_PG_TIMEOUT``
|
|
- Each connection's idle time before it is closed (default: 180 sec)
|
|
|
|
* - ``--use-prepared-statements <true|false>``
|
|
- ``HASURA_GRAPHQL_USE_PREPARED_STATEMENTS``
|
|
- Use prepared statements for queries (default: true)
|
|
|
|
* - ``-i, --tx-iso <TXISO>``
|
|
- ``HASURA_GRAPHQL_TX_ISOLATION``
|
|
- transaction isolation. read-committed / repeatable-read / serializable (default: read-commited)
|
|
|
|
* - ``--stringify-numeric-types``
|
|
- ``HASURA_GRAPHQL_STRINGIFY_NUMERIC_TYPES``
|
|
- Stringify certain Postgres numeric types, specifically ``bigint``, ``numeric``, ``decimal`` and
|
|
``double precision`` as they don't fit into the ``IEEE-754`` spec for JSON encoding-decoding.
|
|
(default: false)
|
|
|
|
* - ``--enabled-apis <APIS>``
|
|
- ``HASURA_GRAPHQL_ENABLED_APIS``
|
|
- Comma separated list of APIs (options: ``metadata``, ``graphql``, ``pgdump``) to be enabled.
|
|
(default: ``metadata,graphql,pgdump``)
|
|
|
|
* - ``--live-queries-fallback-refetch-interval``
|
|
- ``HASURA_GRAPHQL_LIVE_QUERIES_FALLBACK_REFETCH_INTERVAL``
|
|
- updated results (if any) will be sent at most once in this interval (in milliseconds) for live queries
|
|
which cannot be multiplexed. Default: 1000 (1sec)
|
|
|
|
* - ``live-queries-multiplexed-refetch-interval``
|
|
- ``HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_REFETCH_INTERVAL``
|
|
- updated results (if any) will be sent at most once in this interval (in milliseconds) for live queries
|
|
which can be multiplexed. Default: 1000 (1sec)
|
|
|
|
* - ``live-quries-multiplexed-batch-size``
|
|
- ``HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_BATCH_SIZE``
|
|
- multiplexed live queries are split into batches of the specified size. Default 100.
|
|
|
|
* - ``enable-allowlist``
|
|
- ``HASURA_GRAPHQL_ENABLE_ALLOWLIST``
|
|
- Restrict queries allowed to be executed by GraphQL engine to those that are part of the configured
|
|
allow-list. Default ``false``. *(Available for versions > v1.0.0-beta.01)*
|
|
|
|
* - ``console-assets-dir``
|
|
- ``HASURA_GRAPHQL_CONSOLE_ASSETS_DIR``
|
|
- Set the value to ``/srv/console-assets`` for the console to load assets from the server itself
|
|
instead of CDN. *(Available for versions > v1.0.0-beta.01)*
|
|
|
|
.. note::
|
|
|
|
When the equivalent flags for environment variables are used, the flags will take precedence.
|