feat: add example environment variables for server package

[justin-phxm]

Environment variables can be accessed here if you have the correct permissions. Reach out to your team lead if you are missing some.

Summary by CodeRabbit

• Chores
  • Added a server environment configuration template with placeholders and guidance for database names, logging integration (Loki), MQTT settings, application secrets, maps API key, log options, and Node/DVEL environment flags to simplify local and deployment configuration.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
helios-telemetry	Ready	Preview	Comment	Nov 22, 2025 9:51pm

[coderabbitai]

Walkthrough

Adds a new example environment file at packages/server/.env.example containing placeholder variables and explanatory comments for database table names, Loki logging, MQTT, application secrets, Maps API key, logging options, and runtime flags.

Changes

Cohort / File(s)	Summary
Environment Configuration Template packages/server/.env.example	New example .env file with placeholder environment variables and explanatory comments covering database table names, Loki integration (URL, auth, labels, options), MQTT settings, application secrets, Maps API key, logging configuration, and Node/DVEL runtime flags.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Static configuration file only; no executable logic.
• Review focus: confirm variable names, clarity of comments, and ensure no real secrets were committed.

Poem

A rabbit typed envs with care,
Keys and comments nested there,
Loki, MQTT, DB names to keep,
Placeholders snug for secrets to sleep,
Hop forth, devs — replace and share. 🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: add example environment variables for server package' accurately and concisely describes the main change—adding a .env.example file with placeholder environment variables for the server package.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch env.example

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75fc736 and ee25369.

📒 Files selected for processing (1)

• packages/server/.env.example (1 hunks)

🧰 Additional context used

🪛 dotenv-linter (4.0.0)

packages/server/.env.example

[warning] 8-8: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 9-9: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 10-10: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 10-10: [UnorderedKey] The DRIVER_TABLE_NAME key should go before the LAP_TABLE_NAME key

(UnorderedKey)

---

[warning] 11-11: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 11-11: [UnorderedKey] The GPS_CALCULATED_LAP_DATA_TABLE key should go before the LAP_TABLE_NAME key

(UnorderedKey)

---

[warning] 12-12: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 12-12: [UnorderedKey] The GPS_TABLE_NAME key should go before the LAP_TABLE_NAME key

(UnorderedKey)

---

[warning] 25-25: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 26-26: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 26-26: [UnorderedKey] The LOKI_PASSWORD key should go before the LOKI_USERNAME key

(UnorderedKey)

---

[warning] 30-30: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 35-35: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 36-36: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 36-36: [UnorderedKey] The MQTT_PASSWORD key should go before the MQTT_USERNAME key

(UnorderedKey)

---

[warning] 41-41: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 42-42: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 47-47: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 48-48: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 50-50: [UnorderedKey] The LOG_ERROR_STACK key should go before the LOG_FILE key

(UnorderedKey)

---

[warning] 56-56: [QuoteCharacter] The value has quote characters (', ")

(QuoteCharacter)

---

[warning] 56-56: [UnorderedKey] The ENV key should go before the LOG_DIR key

(UnorderedKey)

🔇 Additional comments (1)

packages/server/.env.example (1)

1-56: Excellent work—critical issues from the previous review are now resolved. ✅

The file has been significantly improved and is now a well-structured, valid .env.example template:

• ✅ Structural corruption fixed: No more merged comments or concatenated lines
• ✅ Duplicate keys eliminated: Each variable (LOKI_BASIC_AUTH, LOG_LEVEL, ENV, etc.) appears exactly once
• ✅ Values properly quoted: All example values use quotes, preventing parsing issues
• ✅ Logical organization: Variables grouped by domain (Database → Loki → MQTT → Secrets → Logging → Environment) improves usability

Regarding static analysis warnings: The dotenv-linter flags ~16 QuoteCharacter and 6 UnorderedKey warnings. These are not problems in this context:

1. QuoteCharacter warnings: Quoting example values is intentional and good practice—it clarifies value boundaries and prevents parsing edge cases.
2. UnorderedKey warnings: Alphabetical ordering conflicts with the intentional logical grouping by section, which is more useful for configuration examples than scatter-sorted keys.

Optional enhancement: If you want to silence these linter warnings (since they don't reflect actual issues), add a .dotenv-linter.toml at the repo root and configure it to ignore UnorderedKey and QuoteCharacter for .env.example files, or disable them globally since they're style preferences, not correctness issues.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 36a9f11 and 22831e6.

📒 Files selected for processing (1)

• packages/server/.env.example (1 hunks)

🧰 Additional context used

🪛 dotenv-linter (4.0.0)

packages/server/.env.example

[warning] 5-5: [ExtraBlankLine] Extra blank line detected

(ExtraBlankLine)

---

[warning] 6-6: [ExtraBlankLine] Extra blank line detected

(ExtraBlankLine)

---

[warning] 9-9: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)

---

[warning] 15-15: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)

---

[warning] 17-17: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)

---

[warning] 27-27: [ExtraBlankLine] Extra blank line detected

(ExtraBlankLine)

---

[warning] 28-28: [ExtraBlankLine] Extra blank line detected

(ExtraBlankLine)

---

[warning] 31-31: [ValueWithoutQuotes] This value needs to be surrounded in quotes

(ValueWithoutQuotes)

---

[warning] 59-59: [DuplicatedKey] The LOKI_BASIC_AUTH key is duplicated

(DuplicatedKey)

---

[warning] 62-62: [UnorderedKey] The LOKI_PASSWORD key should go before the LOKI_USERNAME key

(UnorderedKey)

---

[warning] 71-71: [DuplicatedKey] The LOG_LEVEL key is duplicated

(DuplicatedKey)

---

[warning] 73-73: [UnorderedKey] The LOG_ERROR_STACK key should go before the LOG_FILE key

(UnorderedKey)

---

[warning] 77-77: [DuplicatedKey] The ENV key is duplicated

(DuplicatedKey)

---

[warning] 77-77: [UnorderedKey] The ENV key should go before the NODE_ENV key

(UnorderedKey)

[promatty]

hooray

[alexwhelan12]

LGTM!