Skip to content

feat(docs): deploy Coldframe at home and build my own apps - #122

Merged
snovak7 merged 1 commit into
mainfrom
feat/epm-t141-gh121-deploy-coldframe-at-home-and-build-my
Oct 20, 2026
Merged

snovak7 merged 1 commit into
mainfrom
feat/epm-t141-gh121-deploy-coldframe-at-home-and-build-my

Conversation

@snovak7

@snovak7 snovak7 commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

Story 10-3 (bmad-loop), Zoho task EPM-T141.

Summary

  • docs/deploy/README.md (new): the adopter deploy guide in six ordered sections. They cover the domain and DNS token, RKE2 and Fleet, Secrets, the Keycloak realm and Phase Two, split DNS (with the stack install), and the first sign-in. It links install.md, split-dns.md, restore.md and deploy/SECRETS.md by section. It adds the steps no runbook had: installing RKE2, kubectl on the node, the firewall on 443, the namespace, writing the realm, and the first sign-in and admin.
  • deploy/realm/prepare-realm.sh (+ test.sh, 28 tests): writes the coldframe realm with the web client's redirect URIs for your origin and leaves everything else unchanged. It refuses http:// unless you pass --allow-http, which is meant for the Compose example only.
  • docs/build/apps.md: now the full build-your-own-apps guide. It covers:
    • the build-time Server URL and issuer on Android and iOS
    • choosing ids, and the fixed OIDC redirect scheme
    • your own Firebase project and APNs key, for the apps and the Server
    • debug installs and signed release installs
    • troubleshooting
  • deploy/compose/: a Compose example of the full stack. Both the README and compose.yaml label it reference-only. test.sh checks that every required variable stops config when it is missing.
  • ci:manual marker in docs/check-commands.sh: marks command blocks that need a phone, Xcode, the Android SDK or a cluster. CI lists them but does not run them.
  • Docs workflow: the links job now tests the realm writer and validates the Compose example. ci.yml is untouched.

Test plan

  • deploy/realm/test.sh: 28 passed
  • deploy/compose/test.sh: 17 passed
  • docs/test.sh: 49 passed
  • docs/check-links.sh: 497 links and paths in 27 files resolve
  • docs/check-commands.sh: 19 blocks pass; the five apps.md blocks are ci:manual
  • docker compose config --quiet with .env.example: exit 0
  • gitleaks with the repo's config on the new files: no leaks
  • Docs workflow passes on this PR
  • Follow the guide on a real domain and RKE2 node, and build and install the apps on phones. These are operator actions and part of Story 10.5.

Closes #121

🤖 Generated with Claude Code

https://claude.ai/code/session_015KPdX8bfrb629JuwAHJ8rq

Add the adopter deploy guide under docs/deploy/ (domain and DNS token,
RKE2 and Fleet, Secrets, the Keycloak realm and Phase Two, split DNS,
first sign-in), linking the Epic 2 runbooks; a tested realm writer,
deploy/realm/prepare-realm.sh, that sets the web client's redirect URIs
for the adopter's origin; and the full build-your-own-apps guide in
docs/build/apps.md (build-time Server URL and issuer, own APNs key and
FCM project, installing on phones). deploy/compose/ holds a Compose
example labelled reference-only. The Docs workflow now tests the realm
writer and validates the Compose file and each required variable.

Closes #121

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015KPdX8bfrb629JuwAHJ8rq
@snovak7 snovak7 self-assigned this Oct 19, 2026
@snovak7
snovak7 merged commit 2fced76 into main Oct 20, 2026
16 checks passed
@snovak7
snovak7 deleted the feat/epm-t141-gh121-deploy-coldframe-at-home-and-build-my branch October 20, 2026 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deploy Coldframe at home and build my own apps

1 participant