Skip to content

docs: keep store env example in sync - #219

Open
Soumoditya wants to merge 2 commits into
gnt-ai:mainfrom
Soumoditya:docs/store-env-example
Open

Soumoditya wants to merge 2 commits into
gnt-ai:mainfrom
Soumoditya:docs/store-env-example

Conversation

@Soumoditya

@Soumoditya Soumoditya commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

Summary\n\nKeep �pps/store/.env.example aligned with the documented runtime variables.\n\n## Changes\n\n- Add STORE_BACKEND and the public-domain guard to the example.\n- Provide the persistent clone-directory setting as a deployable example.\n- Remove the documentation note that the example omits runtime variables.\n\nCloses #192

Summary by CodeRabbit

  • Documentation
    • Documented the supported native storage backend configuration.
    • Added an example setting for optionally exposing the store through a public domain.

@Soumoditya
Soumoditya requested a review from lukaadzic as a code owner August 22, 2026 20:18
@coderabbitai

coderabbitai Bot commented Aug 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 2c55f8e7-3e0f-4ebe-b04f-6c56c24a1b33

📥 Commits

Reviewing files that changed from the base of the PR and between 59a743d and b52fe3e.

📒 Files selected for processing (1)
  • apps/store/.env.example

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The store environment example documents the supported native backend and adds an opt-in flag for public-domain exposure. The changes do not alter runtime behavior.

Changes

Store environment examples

Layer / File(s) Summary
Document store settings
apps/store/.env.example
Adds the STORE_BACKEND=native example and a commented GNT_STORE_ALLOW_PUBLIC_DOMAIN=1 example with usage conditions.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to b52fe

This updates store environment-variable documentation without changing runtime behavior. The example settings and review-requested documentation details are in place, with no current merge-readiness risk identified.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the purpose and lists the intended changes, but it omits the required Test plan section and the checklist confirmations from the repository template. It also contains a malfor… Add a Test plan section that states which validation was run or why no test was needed. Complete the required checklist items, including sign-off and relevant apps/store validation. Correct the malformed apps/store/.env.example path referen…
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the primary change: synchronizing the store environment example with documented variables.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description explains the purpose and lists the intended changes, but it omits the required Test plan section and the checklist confirmations from the repository template. It also contains a malformed path reference to apps/store/.env.example.

Resolution

Add a Test plan section that states which validation was run or why no test was needed. Complete the required checklist items, including sign-off and relevant apps/store validation. Correct the malformed apps/store/.env.example path reference.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Soumoditya
Soumoditya force-pushed the docs/store-env-example branch from 0e5210d to 5dffad7 Compare August 31, 2026 17:49
@lukaadzic

Copy link
Copy Markdown
Member

Thanks for this one — the two genuinely-missing vars (STORE_BACKEND, GNT_STORE_ALLOW_PUBLIC_DOMAIN) are right and I want them. Three things before I merge:

  1. GNT_STORE_CLONES_DIR gets uncommented to /data/gnt-store-clones. Anyone who copies .env.example for local dev now points clones at a path that doesn't exist on their machine. docs/self-hosting/env-vars.md documents the default as a tmpdir and notes compose deliberately doesn't set it — please leave that line commented.
  2. ZEROENTROPY_API_KEY is still missing. env-vars.md marks it "yes, for real search" — it's the biggest gap issue apps/store/.env.example is missing real vars documented in env-vars.md #192 is about, so it should be in the example (commented, with the "embed/rerank throws at request time without it" note).
  3. The env-vars.md edit replaces "hand-enumerated from the actual process.env.X reads … not from .env.example" with "the example file mirrors the deployable variables below". That sentence was deliberate — it's what keeps the table honest against the source rather than against the example. And with ZEROENTROPY_API_KEY absent the new claim isn't true yet. I'd drop that hunk entirely.

Fix 1 and 2 and I'll merge it.

Signed-off-by: Soumoditya <soumodityapramanik@gmail.com>
Signed-off-by: Soumoditya <soumodityapramanik@gmail.com>
@Soumoditya
Soumoditya force-pushed the docs/store-env-example branch from 5dffad7 to b52fe3e Compare September 3, 2026 14:17
@Soumoditya

Copy link
Copy Markdown
Contributor Author

Addressed the requested changes: the clone directory stays commented, the ZeroEntropy key is included, and the documentation retains the source-read wording.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants