diff --git a/docs/metatype.dev/docs/reference/typegate/index.mdx b/docs/metatype.dev/docs/reference/typegate/index.mdx index dc181ed38..d0eb0a581 100644 --- a/docs/metatype.dev/docs/reference/typegate/index.mdx +++ b/docs/metatype.dev/docs/reference/typegate/index.mdx @@ -53,38 +53,38 @@ GraphQL, being a query language, offers a great asset for Metatype's philosophy: The following environment variables can be used to configure the typegate. `SYNC_*` variables have special semantics which you can read about [here](/docs/reference/typegate/synchronization). -| Environment variables | Desc | Default | Examples | -| -------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------ | ---------------------------------------------------------------------------------------- | -| HOSTNAME | Hostname that typegate is deployed on. | `getHostname()` result. | `typegate-123` | -| TG_PORT | Tcp port to serve typegate APIs at. | 7890 | 7891 | -| TG_ADMIN_PASSWORD | Password use by the CLI/SDK to configure the typegate. | **Required** | My5up3r53cr37 | -| TG_SECRET | Symmetric key used to encrypt cookies and other things (64-byte binary string encoded in base64). | **Required**. | 0p64wJCpQCTiPqPOEze92HLBieszD3sGLtnx6tWm67kqo1tCYcNZ17rjFjEzMl7HJ/SOFZsTVWU0fUjndMrhsQ== | -| TMP_DIR | Top-level temporary directory. | `$PWD/tmp` | `/tmp/typegate-tmp-dir` | -| DEBUG | Enable debug output and other development paths. | false | true | -| TIMER_MAX_TIMEOUT_MS | Timeout for custom runtime functions and other proccesses. | 3000 | 5000 | -| TIMER_POLICY_EVAL_RETRIES | Number of retries when evaluating policies that have timed out | 1 | 3 | -| TIMER_DESTROY_RESOURCES | Force abort and attempt to restart operations that did not respond after multiple retries | true | false | -| JWT_MAX_DURATION_SEC | The lifetime of generated JWT access tokens. | `30 * 24 * 3600` | `604800` | -| JWT_REFRESH_DURATION_SEC | The lifetime of generated JWT refresh tokens. | `5 * 60` | `600` | -| SENTRY_DSN | Data source name for sentry | `null` | `https://public@sentry.example.com/1` | -| SENTRY_SAMPLE_RATE | The rate of error events to be sent to Sentry (between 0.0 and 1.0) | 1.0 | 0.5 | -| SENTRY_TRACES_SAMPLE_RATE | The rate of transactions be sent to Sentry (between 0.0 and 1.0) | 1.0 | 0.2 | -| TRUST_PROXY | Whether to accept proxy headers when resolving request contexts. | false | true | -| TRUST_HEADER_IP | The header key on which to resolve request origin addresses. | X-Forwarded-For | X-Forwarded-For | -| DENO_V8_FLAGS | Flags for tuning the v8 javascript engine. Use the `--help` flag here to see what options are available. | | `--stack-size=1968` | -| SYNC_REDIS_URL | URL to the Redis database. Must include the database number. | \*\*Required (sync mode) | `http://:password@localhost:6379/0` | -| SYNC_S3_HOST | Hostname of the S3 store. | \*\*Required (sync mode) | `play.min.io:9000` | -| SYNC_S3_REGION | S3 region. | **Required (sync mode)** | `us-west-2` | -| SYNC_S3_ACCESS_KEY | Access key for the S3 store credentials. | **Required (sync mode)** | user | -| SYNC_S3_SECRET_KEY | Access key secret for the S3 store credentials. | **Required (sync mode)** | password | -| SYNC_S3_PATH_STYLE | `true` or `false`, force path style if `true`. | `false` | `true` | -| SYNC_S3_BUCKET | The bucket to be used for the system (dedicated). | **Required (sync mode)** | `mybucket` | -| SUBSTANTIAL_POLL_INTERVAL_SEC | Rate at which new schedules are read. | 1.0 | 0.6 | -| SUBSTANTIAL_LEASE_LIFESPAN_SEC | Lease duration associated to a workflow run | 2.0 | 6 | -| SUBSTANTIAL_MAX_ACQUIRE_PER_TICK | Max amount of new acquired replay requests per tick | 3 | 5 | -| MIN_DENO_WORKERS | Minimal number of available deno workers | 2 | 4 | -| MAX_DENO_WORKERS | Maximal number of available deno workers | 8 | 16 | -| DENO_WORKER_WAIT_TIMEOUT_MS | Timeout for waiting for a free deno worker | 5000 | 2000 | -| MIN_SUBSTANTIAL_WORKERS | Minimal number of available substantial workers | 2 | 4 | -| MAX_SUBSTANTIAL_WORKERS | Maximal number of available substantial workers | 8 | 16 | -| SUBSTANTIAL_WORKER_WAIT_TIMEOUT_MS | Timeout for waiting for a free substantial worker | 15000 | 2000 | +| Environment variables | Desc | Default | Examples | +| ---------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------ | ---------------------------------------------------------------------------------------- | +| HOSTNAME | Hostname that typegate is deployed on. | `getHostname()` result. | `typegate-123` | +| TG_PORT | Tcp port to serve typegate APIs at. | 7890 | 7891 | +| TG_ADMIN_PASSWORD | Password use by the CLI/SDK to configure the typegate. | **Required** | My5up3r53cr37 | +| TG_SECRET | Symmetric key used to encrypt cookies and other things (64-byte binary string encoded in base64). | **Required**. | 0p64wJCpQCTiPqPOEze92HLBieszD3sGLtnx6tWm67kqo1tCYcNZ17rjFjEzMl7HJ/SOFZsTVWU0fUjndMrhsQ== | +| TMP_DIR | Top-level temporary directory. | `$PWD/tmp` | `/tmp/typegate-tmp-dir` | +| DEBUG | Enable debug output and other development paths. | false | true | +| TIMER_MAX_TIMEOUT_MS | Timeout for custom runtime functions and other proccesses. | 3000 | 5000 | +| TIMER_POLICY_EVAL_RETRIES | Number of retries when evaluating policies that have timed out | 1 | 3 | +| TIMER_DESTROY_RESOURCES | Force abort and attempt to restart operations that did not respond after multiple retries | true | false | +| JWT_MAX_DURATION_SEC | The lifetime of generated JWT access tokens. | `30 * 24 * 3600` | `604800` | +| JWT_REFRESH_DURATION_SEC | The lifetime of generated JWT refresh tokens. | `5 * 60` | `600` | +| SENTRY_DSN | Data source name for sentry | `null` | `https://public@sentry.example.com/1` | +| SENTRY_SAMPLE_RATE | The rate of error events to be sent to Sentry (between 0.0 and 1.0) | 1.0 | 0.5 | +| SENTRY_TRACES_SAMPLE_RATE | The rate of transactions be sent to Sentry (between 0.0 and 1.0) | 1.0 | 0.2 | +| TRUST_PROXY | Whether to accept proxy headers when resolving request contexts. | false | true | +| TRUST_HEADER_IP | The header key on which to resolve request origin addresses. | X-Forwarded-For | X-Forwarded-For | +| DENO_V8_FLAGS | Flags for tuning the v8 javascript engine. Use the `--help` flag here to see what options are available. | | `--stack-size=1968` | +| SYNC_REDIS_URL | URL to the Redis database. Must include the database number. | \*\*Required (sync mode) | `http://:password@localhost:6379/0` | +| SYNC_S3_HOST | Hostname of the S3 store. | \*\*Required (sync mode) | `play.min.io:9000` | +| SYNC_S3_REGION | S3 region. | **Required (sync mode)** | `us-west-2` | +| SYNC_S3_ACCESS_KEY | Access key for the S3 store credentials. | **Required (sync mode)** | user | +| SYNC_S3_SECRET_KEY | Access key secret for the S3 store credentials. | **Required (sync mode)** | password | +| SYNC_S3_PATH_STYLE | `true` or `false`, force path style if `true`. | `false` | `true` | +| SYNC_S3_BUCKET | The bucket to be used for the system (dedicated). | **Required (sync mode)** | `mybucket` | +| SUBSTANTIAL_POLL_INTERVAL_SEC | Rate at which new schedules are read. | 1.0 | 0.6 | +| SUBSTANTIAL_LEASE_LIFESPAN_SEC | Lease duration associated to a workflow run | 2.0 | 6 | +| SUBSTANTIAL_MAX_ACQUIRE_PER_TICK | Max amount of new acquired replay requests per tick | 3 | 5 | +| MIN_DENO_WORKERS | Minimal number of available deno workers | 2 | 4 | +| MAX_DENO_WORKERS | Maximal number of available deno workers | 8 | 16 | +| DENO_WORKER_WAIT_TIMEOUT_MS | Timeout for waiting for a free deno worker | 5000 | 2000 | +| MIN_SUBSTANTIAL_WORKERS | Minimal number of available substantial workers | 2 | 4 | +| MAX_SUBSTANTIAL_WORKERS | Maximal number of available substantial workers | 8 | 16 | +| SUBSTANTIAL_WORKER_WAIT_TIMEOUT_MS | Timeout for waiting for a free substantial worker | 15000 | 2000 |