Key Takeaways
- Open-source GitHub runbooks for an Android SMS gateway must name the phone, OEM, SIM, and who tops up — not only clone URLs.
- Hub E how-to. Link the open-source cornerstone; do not rewrite its H1.
- Core sibling exists for generic runbooks. This spoke is GitHub/docs-as-code.
- No API keys in README. Developer Center owns live fields.
- BYO Android and operator credit. We meter devices and volume (Free 300 lifetime; paid from $19/mo).
Summary
Documenting runbooks in a GitHub OSS repo means a file on-call can follow at 2 a.m. Hub E — start from Android SMS gateway open source. Core sibling: core document runbooks. REST: Developer Center.
A CONTRIBUTING.md that never mentions OEM battery exemptions is a contributor guide, not an operations runbook.
The README is not the shelf
Clone steps belong in README. Pairing, top-up, and failover belong in docs/runbook.md. Setup still applies. External issue tracker hygiene: GitHub Issues.
Context
OSS forks often document HTTP samples and skip the radio. Hub E how-to stays on runbooks — not a rewrite of the open-source H1.
What the runbook must name
- Physical phone location, charger, and OEM exemption steps.
- SIM slot, tariff type, who tops up, after-hours number.
- How to read last-seen vs HTTP 2xx vs DLR.
- HMAC verification owner for inbound webhooks.
- Canary MSISDN (staff) — never a production customer list in git.
Page vs incident
| Doc | Good for | Not enough for |
|---|---|---|
| README | Clone, license, link to docs | OEM sleep at 02:00 |
| runbook.md | Pair, top-up, failover | Live API field names |
| Developer Center | REST fields | Which shelf the phone sits on |
| Issue template | Repro + last-seen | Storing API keys |
Airtime in the runbook
State that retries spend operator SMS and platform volume. Devices and volume. Free 300 lifetime is a lab.
Who can merge
CODEOWNERS on docs/runbook.md. After OEM updates, PR the runbook with the canary result — not a wiki that drifted.
Secrets stay out of git
Placeholders only. HMAC secrets and Bearers in env. Webhooks.
Decision guide
Merge the runbook before unattended sends. If nobody will own the SIM section, do not advertise 24/7 in the README.
Checklist
- runbook.md linked from README.
- OEM + SIM + last-seen named.
- No secrets in git.
- Canary staff number out of the repo or clearly fake.
- Pricing model stated: devices + volume + BYO airtime.
Next steps
Return to the open-source hub, pair in setup, and keep REST samples conceptual until Developer Center confirms fields.
Related product pages
Jump to the live product docs for this topic—not another long-form article.
- SMS API documentationLive endpoint reference
- device and SMS volume pricingPlans and allowances
- Android SMS gateway product guideDefinition, product, and how to buy
- download the Android gateway appGet the APK
