Skip to content

[Docs] Add an environment and deployment runbook (env vars, staging deploy, healthchecks, rollback) #8

@grantfox-oss

Description

@grantfox-oss

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

Why this matters

There is no operational documentation for running or deploying the system. The backend requires many env vars and there is a staging deploy with Docker images, Trivy scanning, and healthchecks, but none of it is documented for an operator.

Acceptance criteria

  • Document all required env vars per service and which are mandatory at startup
  • Document the staging deploy flow (images, healthcheck, rollback to previous)
  • Document local development setup (DB, Redis, running migrations)
  • Add a troubleshooting section for common startup failures

Files to touch

  • runbook.md (new)
  • wiki/README.md

Out of scope

  • Production infra provisioning (Terraform)
  • Secret management tooling

Metadata

Metadata

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationImprovements or additions to documentationhelp wantedExtra attention is needed

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