Production environment template and deployment checklist

[whisper67265]

Close #86.

Summary by CodeRabbit

• Documentation
  • Expanded deployment/runbook and README guidance: copy-and-fill env instructions, fail-fast secret checks, updated CI/CD workflow links, mail/GitHub credential placeholders, Celery single-process guidance, and revised troubleshooting for external Redis networks.
• New Features
  • Support for a configurable external Redis Docker network and Compose-driven port defaults.
  • Added Boost plugin endpoint throttling configuration options.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 432b5e80-7649-441e-8a88-67cf0dd27ba2

📥 Commits

Reviewing files that changed from the base of the PR and between 152e672 and a4ef91f.

📒 Files selected for processing (2)

• .env.example
• docker/README.md

💤 Files with no reviewable changes (1)

• .env.example

✅ Files skipped from review due to trivial changes (1)

• docker/README.md

---

📝 Walkthrough

Walkthrough

Refactors environment and deployment docs: externalizes Redis network via REDIS_EXTERNAL_NETWORK, clarifies which variables are compose-pinned vs env_file-provided, moves required secret interpolations into compose, adds Boost throttling vars, and updates CI/CD documentation links.

Changes

Environment and Deployment Configuration

Layer / File(s)	Summary
Documentation reference consolidation .github/WORKFLOWS.md, README.md, scripts/README.md	Update CI/CD header and replace links pointing to .github/README.md with .github/WORKFLOWS.md.
Externalized Redis network configuration .env.example, docker/docker-compose.cd.yml, docs/deployment-runbook.md	Introduce REDIS_EXTERNAL_NETWORK in .env.example, use it as the external bdc_redis network name in compose, and update runbook prerequisites/troubleshooting to reference the variable.
Environment file and compose topology refactoring .env.example, docker/docker-compose.cd.yml, docker/README.md	Remove POSTGRES_HOST/POSTGRES_PORT from .env.example, clarify compose-pinned vs env_file variables, add explicit SMTP/GitHub replace-* placeholders, and make weblate service use required .env interpolations and derive ports from .env.
Plugin and runtime configuration expansion .env.example, docs/deployment-runbook.md	Clarify CELERY_SINGLE_PROCESS behavior, add BOOST_ENDPOINT_THROTTLE_INFO and BOOST_ENDPOINT_THROTTLE_ADD_OR_UPDATE, and expand runbook tables and pre-deploy checklist to document these variables.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

• henry0816191
• wpak-ai

Poem

🐰 I hopped through env files and rewrote a few lines,
Pinned ports and networks and clarified signs.
Redis set free on a network you name,
Throttles and secrets now part of the game,
Docs point to workflows — the rabbit approves! 🥕

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main changes: adding a production environment template (.env.example) and updating deployment documentation (runbook checklist).
Linked Issues check	✅ Passed	All four acceptance criteria from issue #86 are met: .env.example documents REDIS_EXTERNAL_NETWORK and throttle defaults, docker-compose.cd.yml enforces required secrets via :? interpolation, topology is pinned in environment while other settings load via env_file, and deployment-runbook.md includes Pre-Deploy Checklist guidance.
Out of Scope Changes check	✅ Passed	All changes are directly aligned with issue #86 objectives: .env.example updates, docker-compose.cd.yml configuration refinement, deployment-runbook.md expansion, and documentation link corrections to WORKFLOWS.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.env.example:
- Around line 86-87: Update the explanatory comment to distinguish pinned vs
defaulted variables: note that POSTGRES_HOST and REDIS_HOST are pinned
(hardcoded) in docker-compose.cd.yml, whereas POSTGRES_PORT and REDIS_PORT use
environment interpolation with defaults (e.g., POSTGRES_PORT:
${POSTGRES_PORT:-5432}) and therefore can be overridden via .env; reference the
symbols POSTGRES_HOST, POSTGRES_PORT, REDIS_HOST, and REDIS_PORT in the revised
wording so readers understand which are fixed and which have fallback defaults.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 36a541a4-3b25-437e-90be-a3eac7a790fd

📥 Commits

Reviewing files that changed from the base of the PR and between 49fe1fb and 6a10477.

📒 Files selected for processing (6)

• .env.example
• .github/WORKFLOWS.md
• README.md
• docker/docker-compose.cd.yml
• docs/deployment-runbook.md
• scripts/README.md

[whisper67265]

@coderabbitai, resume

[coderabbitai]

@whisper67265: Resuming reviews for this PR.

✅ Action performed

Reviews resumed.

[whisper67265]

@coderabbitai, resume

[coderabbitai]

@whisper67265: Resuming reviews for this PR.

✅ Action performed

Reviews resumed.