Skip to content

Live-mode readiness: Going live docs and a real-email warning - #1

Merged
UEddy merged 4 commits into
mainfrom
claude/obol-live-mode-readiness-2m06ht
Nov 8, 2026
Merged

UEddy merged 4 commits into
mainfrom
claude/obol-live-mode-readiness-2m06ht

Conversation

@UEddy

@UEddy UEddy commented Nov 8, 2026 •

Copy link
Copy Markdown
Owner

What this changes

README

  • New Going live section: activate the Stripe account first; use a restricted rk_live_ key with only what Obol calls (Customers and Invoices write; Charges, Disputes and Events read); the exact commands (hermes config set STRIPE_API_KEY rk_live_…, hermes config set plugins.entries.obol.settings.allow_live true, hermes obol doctor); one small real invoice, paid then voided or refunded, before relying on it; and a warning that in live mode Stripe emails the real client.
  • The allow_live row in Configure links to that section.
  • The demo line now links the video on X and the official plugin catalog listing.
  • The Local data bullet says where bank-transfer details live: plain text in Hermes's config.yaml. The full number appears only there and on the PDFs; the logs and database hold a fingerprint and the last four digits.
  • Test count corrected to 231. That's what CI runs inside Hermes with no keys; the README said 234.

Approval prompt (src/obol_lib/gate.py)

  • In live mode, create-and-send, send and remind add the line "LIVE: approving makes Stripe email this real client now. Check the address." Drafts, void, mark paid, test mode and bank-transfer mode don't get it.
  • New test: tests/test_gate.py::test_live_sends_warn_that_a_real_client_is_emailed.

Testing

  • CI, full suite inside Hermes: 231 passed, 2 skipped (the two live suites need keys). hermes plugins validate and doctor pass.
  • Without Hermes: 187 passed, 5 skipped.

Not done

  • No live-mode Stripe run yet. The README asks for one small real invoice before announcing live support.

UEddy added 4 commits November 7, 2026 17:39
Explains how to turn on live mode, recommends a restricted rk_live_ key
with only the permissions Obol uses, notes Stripe account activation,
warns that live sends email real clients, and asks for one small real
invoice before relying on it.
In live mode, create-and-send, send and remind make Stripe email the
actual customer. The approval prompt now says so; void, mark paid and
drafts don't email anyone and get no warning.
@UEddy
UEddy merged commit 9ed5300 into main Nov 8, 2026
4 checks passed
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.

1 participant