Skip to content

docs: clarify relay provisioning failure triage#134

Draft
iniTwakkie wants to merge 1 commit into
psimaker:mainfrom
iniTwakkie:agent/docs-relay-provisioning-triage
Draft

docs: clarify relay provisioning failure triage#134
iniTwakkie wants to merge 1 commit into
psimaker:mainfrom
iniTwakkie:agent/docs-relay-provisioning-triage

Conversation

@iniTwakkie

Copy link
Copy Markdown

What & why

Clarifies the Cloud Relay troubleshooting path when an active local subscription shows per-device provisioning as Failed while vaultsync-notify --doctor reaches the relay and reports an inactive registration.

The guide now distinguishes this app-to-relay provisioning state from Relay Unreachable, asks users to capture both the VaultSync app build and hosted relay version, and warns that reinstalling or changing a healthy helper cannot repair a provisioning-contract mismatch.

Refs #133.

Component(s)

  • go (bridge / Syncthing)
  • ios (app / widget)
  • notify (relay)
  • docs / CI

Testing

  • cd go && make patch && go test -tags noassets ./bridge
  • cd notify && go test ./...
  • iOS build / xcodebuild test
  • Not applicable

Documentation validation:

  • git diff --check
  • Reviewed the rendered list/fenced-code structure and anchor target

@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 7088129c-028e-429f-b7c4-169f5f3cc931

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@psimaker

Copy link
Copy Markdown
Owner

Thanks — this is a useful addition, and your triage instinct in #133 was validated: the failure you documented was indeed a provisioning-contract problem that no helper reinstall could fix. The root cause turned out to be relay-side (see my comment on #133), and the fix rolls out as Relay 1.3.2.

Two small requests before this can merge:

  1. Wording: the retained sentence "the problem is app-side: subscription or provisioning" is now known to be misleading — in the bug(relay): new paid subscription cannot provision against relay 1.3.1 #133 case the app and helper were both fine and the relay was rejecting valid transactions. Suggest something direction-neutral, e.g. "the problem is in app↔relay provisioning — not on your homeserver." The rest of your step 2 (capture both versions, file a report, don't touch the helper) holds up exactly as written.
  2. Mark the PR ready for review when you get a chance — as a draft, the required CI checks (Go Tests, Notify Tests, PR Title, govulncheck, Design Token Lint) haven't run yet; they must pass before merge even for docs-only changes.

One heads-up so the guidance stays honest after 1.3.2 is live: "Install any available VaultSync App Store update before retrying" is fine as generic advice, but in a contract mismatch like #133 the app update is not necessarily the cure — your own step 2 wording ("needs an app or hosted relay fix") already covers that correctly.

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.

2 participants