Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughAdds a new “Envio-specific environment variables” section to docs/HyperIndex/Guides/environment-variables.md, documenting seven ENVIO_* variables (API token, Hasura toggle, and Postgres settings). Inserted after the Envio API Token section and before Example Environment Variables. No code changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
| ## 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 | ||
|
|
There was a problem hiding this comment.
I think there are some more too, such as for aggregate queries etc we can consider adding here too
|
|
||
| - `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 |
There was a problem hiding this comment.
Let's remove this. I'm keen on deprecating the feature in the future.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/HyperIndex/Guides/environment-variables.md (4)
27-29: Consider renaming the section to “HyperIndex-specific environment variables.”The list that follows is scoped to HyperIndex usage. Renaming reduces ambiguity with other Envio-wide vars.
-## Envio-specific environment variables +## HyperIndex-specific environment variables
29-33: Avoid duplicating ENVIO_API_TOKEN—cross-reference the section above instead.ENVIO_API_TOKEN is already documented just above; keeping it in the list can be redundant and cause divergent copy later.
-The following variables are used by HyperIndex: +The following variables are used by HyperIndex: +This list excludes `ENVIO_API_TOKEN`, which is documented in the section above. -- `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
32-32: Clarify ENVIO_HASURA semantics (type, default, and potential deprecation).Please specify:
- accepted values (e.g., "true"/"false", case sensitivity),
- default behavior if unset,
- whether this toggle is slated for deprecation (a previous review mentioned deprecating related functionality).
If deprecation is planned, mark it as deprecated here to guide users.
I can update the wording once you confirm default behavior and deprecation status.
34-37: Align scope wording across Postgres variables and verify completeness.
- ENVIO_PG_PORT mentions “local development,” while the others say “self-hosted.” Recommend consistent phrasing.
- Confirm whether an ENVIO_PG_HOST (or similar) exists and should be documented alongside these.
-- `ENVIO_PG_PORT`: Port for the Postgres service used by HyperIndex during local development +- `ENVIO_PG_PORT`: Postgres port (self-hosted)If these vars also apply to local development, consider “(self-hosted/local development)” for all PG bullets instead.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/HyperIndex/Guides/environment-variables.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/HyperIndex/Guides/environment-variables.md
[grammar] ~31-~31: There might be a mistake here.
Context: ...inued access in self-hosted deployments) - ENVIO_HASURA: Set to false to disable Hasura integ...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...d by HyperIndex during local development - ENVIO_PG_PASSWORD: Postgres password (self-hosted) - `ENV...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...SSWORD: Postgres password (self-hosted) - ENVIO_PG_USER: Postgres username (self-hosted) - ENV...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...G_USER: Postgres username (self-hosted) - ENVIO_PG_DATABASE`: Postgres database name (self-hosted) -...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...E: Postgres database name (self-hosted) - ENVIO_PG_PUBLIC_SCHEMA`: Postgres schema name override for the ...
(QB_NEW_EN)
🔇 Additional comments (3)
docs/HyperIndex/Guides/environment-variables.md (3)
27-39: Nice addition—clear, concise, and well-placed.This section is helpful and sits in the right place between the token guidance and examples.
38-38: Clarify what “generated/public schema” means and document the default.Please clarify whether this overrides the target schema for generated tables (and whether the default is “public”). An example value would also help users.
27-39: Document all ENVIO_ environment variables referenced in the repo*I ran a scan across the repository and found these unique ENVIO_* names:
• ENVIO_API_TOKEN (documented)
• ENVIO_CHAIN_ID (missing)
• ENVIO_COINGECKO_API_KEY (documented)
• ENVIO_GREETER_ADDRESS (missing)
• ENVIO_GREETER_ADDRESSES (missing)
• ENVIO_HASURA (documented)
• ENVIO_MAINNET_API_KEY (missing)
• ENVIO_PG_DATABASE (documented)
• ENVIO_PG_PASSWORD (documented)
• ENVIO_PG_PORT (documented)
• ENVIO_PG_PUBLIC_SCHEMA (documented)
• ENVIO_PG_USER (documented)
• ENVIO_RPC_URL (documented)
• ENVIO_SAVE_BENCHMARK_DATA (missing)
• ENVIO_START_BLOCK (documented)
• ENVIO_VAR (unspecified)Please confirm which of these are actually consumed by HyperIndex (versus other components like HyperIndex-LLM or community scripts) and update docs/HyperIndex/Guides/environment-variables.md to:
- Add any missing, relevant variables.
- Remove or annotate any variables no longer in use.
- Ensure naming consistency (e.g. “RPC_URL” vs. “RPC-URL”, presence/absence of “MAINNET” vs. “CHAIN_ID”).
This will keep your environment-variables guide in sync with real code usage.
2 participants
Summary by CodeRabbit