From c5599f0825c1a26a58db0bad5be97d6beb231624 Mon Sep 17 00:00:00 2001 From: denhampreen Date: Wed, 20 Aug 2025 05:31:19 -0600 Subject: [PATCH 1/2] feat: documentation on different env vars available --- docs/HyperIndex/Guides/environment-variables.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/HyperIndex/Guides/environment-variables.md b/docs/HyperIndex/Guides/environment-variables.md index 39d62207..884ede01 100644 --- a/docs/HyperIndex/Guides/environment-variables.md +++ b/docs/HyperIndex/Guides/environment-variables.md @@ -24,6 +24,20 @@ To ensure continued access to HyperSync, set an Envio API token in your environm - Use `ENVIO_API_TOKEN` to provide your token at runtime - See the API Tokens guide for how to generate a token: [API Tokens](/docs/HyperSync/api-tokens) +## Envio-specific environment variables + +The following variables are used by HyperIndex: + +- `ENVIO_API_TOKEN`: API token for HyperSync access (required for continued access in self-hosted deployments) +- `ENVIO_HASURA`: Set to `false` to disable Hasura integration for self-hosted indexers +- `ENVIO_SAVE_BENCHMARK_DATA`: When `true`, saves benchmark data during runs for later summary + +- `ENVIO_PG_PORT`: Port for the Postgres service used by HyperIndex during local development +- `ENVIO_PG_PASSWORD`: Postgres password (self-hosted) +- `ENVIO_PG_USER`: Postgres username (self-hosted) +- `ENVIO_PG_DATABASE`: Postgres database name (self-hosted) +- `ENVIO_PG_PUBLIC_SCHEMA`: Postgres schema name override for the generated/public schema + ## Example Environment Variables Here are some commonly used environment variables: From 91f8fdbdcfd1bbdeb3f62392527c4d621bfe7bc0 Mon Sep 17 00:00:00 2001 From: Denham Preen Date: Wed, 20 Aug 2025 06:28:13 -0600 Subject: [PATCH 2/2] Apply suggestion from @DenhamPreen --- docs/HyperIndex/Guides/environment-variables.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/HyperIndex/Guides/environment-variables.md b/docs/HyperIndex/Guides/environment-variables.md index 884ede01..fd1a528a 100644 --- a/docs/HyperIndex/Guides/environment-variables.md +++ b/docs/HyperIndex/Guides/environment-variables.md @@ -30,7 +30,6 @@ The following variables are used by HyperIndex: - `ENVIO_API_TOKEN`: API token for HyperSync access (required for continued access in self-hosted deployments) - `ENVIO_HASURA`: Set to `false` to disable Hasura integration for self-hosted indexers -- `ENVIO_SAVE_BENCHMARK_DATA`: When `true`, saves benchmark data during runs for later summary - `ENVIO_PG_PORT`: Port for the Postgres service used by HyperIndex during local development - `ENVIO_PG_PASSWORD`: Postgres password (self-hosted)