Skip to content

[Docs] INDEXER_HEALTH_LAG_LIMIT and PORT are read by the backend but documented nowhere #1212

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Why this matters

INDEXER_HEALTH_LAG_LIMIT is consumed in backend/src/app.ts:204-205 and PORT in backend/src/index.ts:36, but neither appears in backend/.env.example nor in docs/ENVIRONMENT.md. check-env-docs.mjs only compares .env.example keys to the doc, so code-only env vars are never flagged.

Acceptance criteria

  • Add INDEXER_HEALTH_LAG_LIMIT (default 100) and PORT (default 3001) to docs/ENVIRONMENT.md
  • Add both to backend/.env.example with their defaults and a comment

Files to touch

  • docs/ENVIRONMENT.md
  • backend/.env.example
  • backend/src/app.ts
  • backend/src/index.ts

Out of scope

  • Build-time GIT_SHA/BUILD_TIME (already documented in code comments)

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocsDocumentationdocumentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions