Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

Preserve existing phone access in retirement troubleshooting

pulse-triage[bot]4793af28d56f
diff --git a/docs/RELAY.md b/docs/RELAY.md
index 39d155d8a0..4bd410ea4b 100644
--- a/docs/RELAY.md
+++ b/docs/RELAY.md
@@ -29,7 +29,9 @@ Pulse Relay is the end-to-end encrypted connection between a Pulse instance and
## Requirements
-- **Relay, Pro, legacy Pro+, or Cloud license** — relay is gated by the `relay` feature key.
+- **An existing licence with the `relay` entitlement** — Relay is no longer sold.
+ Existing Relay subscribers receive Pro features at their current price for as
+ long as their subscription continues, including after the app retires.
- **Outbound WebSocket** — Pulse must be able to reach `relay.pulserelay.pro` (port 443).
- **No inbound ports** — you do not need to open any ports on your firewall.
@@ -43,7 +45,7 @@ Relay was designed with a zero-trust model:
| **Plaintext** | Relay server never sees your monitoring data |
| **Authentication** | Per-session mobile authentication |
| **Back-pressure** | Data limiters prevent channel flooding |
-| **License-gated** | Requires an active Relay-or-higher license |
+| **License-gated** | Requires an active licence with the `relay` entitlement |
| **Configurable** | Can be enabled/disabled at any time via Settings |
| **Audit** | Pulse Mobile relay access token creation is recorded in the audit trail. Relay connection events are written to the Pulse server log. |
@@ -97,30 +99,44 @@ Pulse Mobile can pair with multiple Pulse instances. Each pairing has its own en
### Relay showing "Disconnected"
-1. Confirm your Relay, Pro, grandfathered Pro+, or Cloud license is active (**Settings → Plans & Billing**).
-2. Verify the Pulse server can reach the relay server:
- ```bash
- curl -s https://relay.pulserelay.pro/healthz
- ```
-3. Check Pulse logs for relay errors:
- ```bash
- journalctl -u pulse | grep -i relay
- # or
- docker logs pulse | grep -i relay
- ```
+For an existing paired phone, inspect **Settings → Pulse Mobile** without
+changing it: distinguish whether relay is enabled, whether the server's relay
+connection is active, and whether the affected phone connects. An active server
+connection does not prove phone delivery. Relay is no longer sold; do not buy
+or switch plans as a troubleshooting step. If the panel shows a licence error,
+keep its exact redacted wording rather than changing the subscription.
+
+Use the original time, Pulse server and app versions, and any existing error
+or screenshot. Unknown details are valid. If logs are needed, follow the
+[bounded Pulse log readers](TROUBLESHOOTING.md#inspect-notification-logs) on the
+Pulse server, then review only relevant lines locally. Do not post full logs,
+QR codes, pairing deep links, cookies, tokens or private server addresses.
+
+Keep the existing pairing and configuration. Do not disable/re-enable relay,
+delete a pairing, rescan a QR code, restart services or change firewall rules
+merely to collect evidence. A public relay health response would not establish
+that this server's WebSocket or the phone's encrypted session recovered.
### Pulse Mobile can't connect
-1. Verify relay is enabled in **Settings → Pulse Mobile**.
-2. Confirm your mobile account has beta access.
-3. Re-scan the QR code — sessions can expire.
-4. Ensure your mobile device has internet access.
+Compare the affected phone's existing connection error with the server's
+[Relay status](#relay-showing-disconnected). If another already-paired phone
+works, retain that distinction; do not pair another device as a test. Preserve
+the current pairing and use the existing error or redacted screenshot in the
+[same support thread](TROUBLESHOOTING.md#-getting-help).
### Open Pulse handoff not loading
-1. Check the relay connection status in **Settings → Pulse Mobile**.
-2. Look for WebSocket reconnection messages in Pulse logs.
-3. Restart Pulse Mobile.
+Keep app connectivity separate from access to the web UI: Relay connects the
+app, **not the web UI**. Open the Pulse web address in the phone's browser using
+your own VPN or tunnel away from home. If the browser works but the app's
+handoff does not, report that distinction and the existing app error without
+restarting or re-pairing.
+
+For alerts after **31 March 2027**, add [ntfy, Gotify or Pushover](WEBHOOKS.md#-quick-setup)
+under **Alerts → Notifications**. These destinations do not require Relay or
+a Pulse Mobile pairing. A successful Test is not proof of ordinary alert delivery;
+see [notification delivery checks](TROUBLESHOOTING.md#test-succeeds-but-real-alerts-are-missing).
## See Also
diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md
index b680ec25a0..a55df71ab4 100644
--- a/docs/TROUBLESHOOTING.md
+++ b/docs/TROUBLESHOOTING.md
@@ -1309,9 +1309,19 @@ not a guide to the current menu.
### Relay / Mobile
#### Relay showing "Disconnected"
-- Confirm a valid Relay, Pro, grandfathered Pro+, or Cloud license is active (**Settings → Plans & Billing**).
-- Check Pulse server can reach the relay server (outbound WebSocket to `relay.pulserelay.pro`).
-- Review logs: `journalctl -u pulse | grep relay` or `docker logs pulse | grep relay`.
+
+Pulse Mobile and Relay retire on **31 March 2027**; existing paired phones keep
+working until then. **Relay is no longer sold.** Existing Relay subscribers keep
+Pro features at their current price for as long as their subscription continues,
+including after the app retires. Do not buy or switch plans to diagnose a
+connection failure.
+
+For an existing paired phone, use the [Relay connection checks](RELAY.md#relay-showing-disconnected).
+Keep the pairing and current configuration; a relay connection is not proof
+that the phone has connected. Relay connects the app, **not the web UI**.
+For phone alerts after retirement, configure [ntfy, Gotify or Pushover](WEBHOOKS.md#-quick-setup)
+under **Alerts → Notifications** and open Pulse in your phone's browser, using
+your own VPN or tunnel when away from home.
---
diff --git a/frontend-modern/public/docs/RELAY.md b/frontend-modern/public/docs/RELAY.md
index 39d155d8a0..4bd410ea4b 100644
--- a/frontend-modern/public/docs/RELAY.md
+++ b/frontend-modern/public/docs/RELAY.md
@@ -29,7 +29,9 @@ Pulse Relay is the end-to-end encrypted connection between a Pulse instance and
## Requirements
-- **Relay, Pro, legacy Pro+, or Cloud license** — relay is gated by the `relay` feature key.
+- **An existing licence with the `relay` entitlement** — Relay is no longer sold.
+ Existing Relay subscribers receive Pro features at their current price for as
+ long as their subscription continues, including after the app retires.
- **Outbound WebSocket** — Pulse must be able to reach `relay.pulserelay.pro` (port 443).
- **No inbound ports** — you do not need to open any ports on your firewall.
@@ -43,7 +45,7 @@ Relay was designed with a zero-trust model:
| **Plaintext** | Relay server never sees your monitoring data |
| **Authentication** | Per-session mobile authentication |
| **Back-pressure** | Data limiters prevent channel flooding |
-| **License-gated** | Requires an active Relay-or-higher license |
+| **License-gated** | Requires an active licence with the `relay` entitlement |
| **Configurable** | Can be enabled/disabled at any time via Settings |
| **Audit** | Pulse Mobile relay access token creation is recorded in the audit trail. Relay connection events are written to the Pulse server log. |
@@ -97,30 +99,44 @@ Pulse Mobile can pair with multiple Pulse instances. Each pairing has its own en
### Relay showing "Disconnected"
-1. Confirm your Relay, Pro, grandfathered Pro+, or Cloud license is active (**Settings → Plans & Billing**).
-2. Verify the Pulse server can reach the relay server:
- ```bash
- curl -s https://relay.pulserelay.pro/healthz
- ```
-3. Check Pulse logs for relay errors:
- ```bash
- journalctl -u pulse | grep -i relay
- # or
- docker logs pulse | grep -i relay
- ```
+For an existing paired phone, inspect **Settings → Pulse Mobile** without
+changing it: distinguish whether relay is enabled, whether the server's relay
+connection is active, and whether the affected phone connects. An active server
+connection does not prove phone delivery. Relay is no longer sold; do not buy
+or switch plans as a troubleshooting step. If the panel shows a licence error,
+keep its exact redacted wording rather than changing the subscription.
+
+Use the original time, Pulse server and app versions, and any existing error
+or screenshot. Unknown details are valid. If logs are needed, follow the
+[bounded Pulse log readers](TROUBLESHOOTING.md#inspect-notification-logs) on the
+Pulse server, then review only relevant lines locally. Do not post full logs,
+QR codes, pairing deep links, cookies, tokens or private server addresses.
+
+Keep the existing pairing and configuration. Do not disable/re-enable relay,
+delete a pairing, rescan a QR code, restart services or change firewall rules
+merely to collect evidence. A public relay health response would not establish
+that this server's WebSocket or the phone's encrypted session recovered.
### Pulse Mobile can't connect
-1. Verify relay is enabled in **Settings → Pulse Mobile**.
-2. Confirm your mobile account has beta access.
-3. Re-scan the QR code — sessions can expire.
-4. Ensure your mobile device has internet access.
+Compare the affected phone's existing connection error with the server's
+[Relay status](#relay-showing-disconnected). If another already-paired phone
+works, retain that distinction; do not pair another device as a test. Preserve
+the current pairing and use the existing error or redacted screenshot in the
+[same support thread](TROUBLESHOOTING.md#-getting-help).
### Open Pulse handoff not loading
-1. Check the relay connection status in **Settings → Pulse Mobile**.
-2. Look for WebSocket reconnection messages in Pulse logs.
-3. Restart Pulse Mobile.
+Keep app connectivity separate from access to the web UI: Relay connects the
+app, **not the web UI**. Open the Pulse web address in the phone's browser using
+your own VPN or tunnel away from home. If the browser works but the app's
+handoff does not, report that distinction and the existing app error without
+restarting or re-pairing.
+
+For alerts after **31 March 2027**, add [ntfy, Gotify or Pushover](WEBHOOKS.md#-quick-setup)
+under **Alerts → Notifications**. These destinations do not require Relay or
+a Pulse Mobile pairing. A successful Test is not proof of ordinary alert delivery;
+see [notification delivery checks](TROUBLESHOOTING.md#test-succeeds-but-real-alerts-are-missing).
## See Also
diff --git a/frontend-modern/public/docs/TROUBLESHOOTING.md b/frontend-modern/public/docs/TROUBLESHOOTING.md
index b680ec25a0..a55df71ab4 100644
--- a/frontend-modern/public/docs/TROUBLESHOOTING.md
+++ b/frontend-modern/public/docs/TROUBLESHOOTING.md
@@ -1309,9 +1309,19 @@ not a guide to the current menu.
### Relay / Mobile
#### Relay showing "Disconnected"
-- Confirm a valid Relay, Pro, grandfathered Pro+, or Cloud license is active (**Settings → Plans & Billing**).
-- Check Pulse server can reach the relay server (outbound WebSocket to `relay.pulserelay.pro`).
-- Review logs: `journalctl -u pulse | grep relay` or `docker logs pulse | grep relay`.
+
+Pulse Mobile and Relay retire on **31 March 2027**; existing paired phones keep
+working until then. **Relay is no longer sold.** Existing Relay subscribers keep
+Pro features at their current price for as long as their subscription continues,
+including after the app retires. Do not buy or switch plans to diagnose a
+connection failure.
+
+For an existing paired phone, use the [Relay connection checks](RELAY.md#relay-showing-disconnected).
+Keep the pairing and current configuration; a relay connection is not proof
+that the phone has connected. Relay connects the app, **not the web UI**.
+For phone alerts after retirement, configure [ntfy, Gotify or Pushover](WEBHOOKS.md#-quick-setup)
+under **Alerts → Notifications** and open Pulse in your phone's browser, using
+your own VPN or tunnel when away from home.
---
diff --git a/frontend-modern/src/features/docs/__tests__/mobileRetirementHelp.test.ts b/frontend-modern/src/features/docs/__tests__/mobileRetirementHelp.test.ts
new file mode 100644
index 0000000000..9107fc2fa1
--- /dev/null
+++ b/frontend-modern/src/features/docs/__tests__/mobileRetirementHelp.test.ts
@@ -0,0 +1,86 @@
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, it } from 'vitest';
+import { createGuideFixture } from './guideFixture';
+
+// These are checks of the shipped server documentation, not app or Relay
+// qualification. No pairing, notification, subscription or provider is used.
+const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../../../../..');
+const shipped = (name: string) =>
+ readFileSync(path.join(root, 'frontend-modern/public/docs', `${name}.md`), 'utf8');
+const render = createGuideFixture(shipped);
+const prose = (element: Element) => (element.textContent ?? '').replace(/\s+/g, ' ').trim();
+
+function section(name: string, fragment: string, level: number): HTMLElement {
+ const heading = render(name).querySelector(`[id="${fragment}"]`);
+ expect(heading, `${name}#${fragment}`).not.toBeNull();
+ const result = document.createElement('section');
+ for (let next = heading!.nextElementSibling; next; next = next.nextElementSibling) {
+ if (/^H[1-6]$/.test(next.tagName) && Number(next.tagName.slice(1)) <= level) break;
+ result.appendChild(next.cloneNode(true));
+ }
+ return result;
+}
+
+describe('existing phone recovery and retirement help', () => {
+ it('keeps retirement, continuing paid terms and app/web access distinct', () => {
+ const text = prose(section('TROUBLESHOOTING', 'relay-showing-disconnected', 4));
+ expect(text).toContain('31 March 2027');
+ expect(text).toContain('existing paired phones keep working until then');
+ expect(text).toContain('Relay is no longer sold');
+ expect(text).toContain('current price for as long as their subscription continues');
+ expect(text).toContain('including after the app retires');
+ expect(text).toContain('Do not buy or switch plans');
+ expect(text).toContain('not the web UI');
+ expect(text).toContain('ntfy, Gotify or Pushover');
+ expect(text).toContain('own VPN or tunnel');
+ expect(prose(section('RELAY', 'requirements', 2))).toContain('An existing licence with the relay entitlement');
+ expect(prose(section('RELAY', 'requirements', 2))).not.toContain('Relay-or-higher');
+ });
+
+ it('replaces unbounded reads and speculative recovery with preserved evidence', () => {
+ const element = section('RELAY', 'troubleshooting', 2);
+ const text = prose(element);
+ expect(element.querySelector('pre')).toBeNull();
+ expect(text).toContain('An active server connection does not prove phone delivery');
+ expect(text).toContain('Unknown details are valid');
+ expect(text).toContain('bounded Pulse log readers');
+ expect(text).toContain('Do not post full logs, QR codes, pairing deep links, cookies, tokens');
+ expect(text).toContain('Do not disable/re-enable relay, delete a pairing, rescan a QR code');
+ expect(text).toContain('restart services or change firewall rules merely to collect evidence');
+ expect(text).toContain('do not pair another device as a test');
+ expect(text).toContain('A successful Test is not proof of ordinary alert delivery');
+ expect(text).not.toContain('Confirm your mobile account has beta access');
+ expect(text).not.toContain('Restart Pulse Mobile');
+ });
+
+ it('keeps existing bookmarks and every recovery link usable in the actual renderer', () => {
+ const sections = [
+ section('TROUBLESHOOTING', 'relay-showing-disconnected', 4),
+ section('RELAY', 'troubleshooting', 2),
+ ];
+ for (const element of sections) {
+ for (const link of element.querySelectorAll('a[href]')) {
+ const href = link.getAttribute('href')!;
+ const same = /^#(.+)$/.exec(href);
+ const cross = /^\/docs\/([^#]+)#(.+)$/.exec(href);
+ expect(same || cross, href).not.toBeNull();
+ expect(render(cross ? cross[1] : 'RELAY').querySelector(
+ `[id="${cross ? cross[2] : same![1]}"]`,
+ ), href).not.toBeNull();
+ expect(link.hasAttribute('data-doc-link'), href).toBe(true);
+ }
+ }
+ for (const fragment of ['relay-showing-disconnected', 'pulse-mobile-cant-connect',
+ 'open-pulse-handoff-not-loading']) {
+ expect(render('RELAY').querySelector(`[id="${fragment}"]`), fragment).not.toBeNull();
+ }
+ });
+
+ it('ships the same guidance as the canonical repository pages', () => {
+ for (const name of ['TROUBLESHOOTING', 'RELAY']) {
+ expect(shipped(name)).toBe(readFileSync(path.join(root, 'docs', `${name}.md`), 'utf8'));
+ }
+ });
+});