refactor: deduplicate addon env vars — single source of truth in addons-ref.md#2652
Conversation
Replace inline addon environment variable listings (PostgreSQL, MySQL, Redis, Sendmail, LDAP, OIDC) with a pointer to the authoritative addons-ref.md from the upstream Cloudron skills repo. The reference file covers all 14 addons with full env var lists and addon-specific options — a strict superset of what was duplicated here. Keeps the General Variables section (CLOUDRON_APP_ORIGIN, etc.) since those are not addon-specific and are not covered in addons-ref.md. Also fixes trailing whitespace in nginx config example (MD009).
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refactors the documentation for Cloudron application packaging by centralizing addon environment variable definitions. It eliminates redundant information previously scattered across Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
WalkthroughDocumentation consolidation in Cloudron deployment guide: replaces redundant per-addon environment variable examples with centralized reference link, introduces runtime behavior notes about environment variable handling and database migrations, and establishes a dedicated section for universally available CLOUDRON variables. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
🔍 Code Quality Report�[0;35m[MONITOR]�[0m Code Review Monitoring Report �[0;34m[INFO]�[0m Latest Quality Status: �[0;34m[INFO]�[0m Recent monitoring activity: 📈 Current Quality Metrics
Generated on: Sun Mar 1 18:56:40 UTC 2026 Generated by AI DevOps Framework Code Review Monitoring |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request effectively deduplicates the addon environment variable documentation by centralizing it into a single source of truth, which is a solid improvement for maintainability. The included whitespace fix and added cross-references are also beneficial. I've provided a couple of suggestions to further enhance the readability and clarity of the new documentation sections, with one suggestion aligning with our guidelines for presenting operational details.
| ``` | ||
|
|
||
| **Note**: Cloudron Redis REQUIRES authentication. | ||
| For the full environment variable reference for all addons (mysql, postgresql, mongodb, redis, ldap, oidc, sendmail, recvmail, email, proxyauth, scheduler, tls, turn, docker) including addon-specific options, see [addons-ref.md](cloudron-app-packaging-skill/addons-ref.md). |
There was a problem hiding this comment.
For better readability, it would be helpful to format the list of addon names as code spans using backticks. This makes them stand out from the surrounding text and is a common convention for technical terms.
| For the full environment variable reference for all addons (mysql, postgresql, mongodb, redis, ldap, oidc, sendmail, recvmail, email, proxyauth, scheduler, tls, turn, docker) including addon-specific options, see [addons-ref.md](cloudron-app-packaging-skill/addons-ref.md). | |
| For the full environment variable reference for all addons (`mysql`, `postgresql`, `mongodb`, `redis`, `ldap`, `oidc`, `sendmail`, `recvmail`, `email`, `proxyauth`, `scheduler`, `tls`, `turn`, `docker`) including addon-specific options, see [addons-ref.md](cloudron-app-packaging-skill/addons-ref.md). |
| CLOUDRON_OIDC_CLIENT_SECRET=client_secret | ||
| CLOUDRON_OIDC_CALLBACK_URL=https://app.domain.com/callback | ||
| ``` | ||
| **Key pattern**: Read env vars at runtime on every start — values can change across restarts. Run DB migrations on each start. |
There was a problem hiding this comment.
The "Key pattern" line contains two distinct but important pieces of advice. To improve clarity and make them easier to digest, consider presenting them as a bulleted list. This aligns with the guideline to format important operational details as bullet points for clarity and readability.
| **Key pattern**: Read env vars at runtime on every start — values can change across restarts. Run DB migrations on each start. | |
| **Key patterns**: | |
| * Read env vars at runtime on every start — values can change across restarts. | |
| * Run DB migrations on each start. |
References
- For important operational details like task claiming, format them as bullet points for clarity and readability.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.agents/tools/deployment/cloudron-app-packaging.md (1)
496-496: Consider qualifying the database migration advice.The note states "Run DB migrations on each start" as a blanket recommendation. Consider softening this to acknowledge that:
- Many frameworks have built-in migration tracking that automatically skips already-applied migrations
- Not all apps require migrations on every start
- The intent is to ensure migrations are checked/run if needed, not necessarily executed blindly
Suggested rephrasing: "Check and apply DB migrations on each start as needed (most frameworks handle idempotency)."
📝 Proposed refinement
-**Key pattern**: Read env vars at runtime on every start — values can change across restarts. Run DB migrations on each start. +**Key pattern**: Read env vars at runtime on every start — values can change across restarts. Check and apply DB migrations on each start (most frameworks handle idempotency automatically).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/tools/deployment/cloudron-app-packaging.md at line 496, The guidance "Run DB migrations on each start" is too absolute; update the sentence under the "Key pattern" (the line containing "Run DB migrations on each start") to a softer phrasing such as "Check and apply DB migrations on each start as needed (most frameworks handle idempotency)." Keep the surrounding context about reading env vars at runtime unchanged and ensure the new wording conveys that many frameworks skip already-applied migrations and that migrations should be performed only when required.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In @.agents/tools/deployment/cloudron-app-packaging.md:
- Line 496: The guidance "Run DB migrations on each start" is too absolute;
update the sentence under the "Key pattern" (the line containing "Run DB
migrations on each start") to a softer phrasing such as "Check and apply DB
migrations on each start as needed (most frameworks handle idempotency)." Keep
the surrounding context about reading env vars at runtime unchanged and ensure
the new wording conveys that many frameworks skip already-applied migrations and
that migrations should be performed only when required.
1 participant
Summary
cloudron-app-packaging.mdwith a pointer to the authoritativeaddons-ref.mdimported from upstream Cloudron skills in PR docs: ingest Cloudron 9.1 official AI skills and update docs #2651CLOUDRON_APP_ORIGIN, etc.) since those are platform-wide, not addon-specificWhy
Two sources of truth for addon env vars will inevitably drift — when Cloudron adds new env vars or options, only one file would get updated. The imported
addons-ref.mdis the authoritative upstream reference and is registered for update monitoring viaskill-sources.json.Net change: -59 lines of duplicated content, +2 cross-reference pointers.
Summary by CodeRabbit