gsadmin/pulse
1
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-09-10 02:25:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Correct stale Settings/Alerts nav labels in user docs

Browse Source 
Rename doc references to settings/alerts items that were renamed in the
shipped v6 IA, verified against current settingsNavCatalog.ts and
i18n/messages.ts:
  Settings > Relay             -> Settings > Remote Access
  Settings > Plans             -> Settings > Plans & Billing
  Settings > Security > Webhooks -> Settings > Security > Audit Webhooks
  Alerts > Notification Destinations -> Alerts > Notifications
  Settings > Reports           -> Settings > Data & Reports

Derived from the docs-rot audit; pure label renames only. Flow/route
rewrites (retired standalone pages, TrueNAS/Nodes relocation, i18n
copies) held for a supervised pass.
This commit is contained in:
rcourtman
2026-07-13 13:47:13 +01:00
parent f095da2fdb
commit 5b4365853d
7 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CLOUD.md
+1 -1
View File
@@ -62,7 +62,7 @@ Add your Proxmox VE, PBS, PMG, or TrueNAS systems via **Settings → Infrastruct
### 4. Set Up Mobile Access
Relay is enabled by default on Cloud instances. Open **Settings → Relay** to prepare pairing and connect once mobile beta/public access is enabled.
Relay is enabled by default on Cloud instances. Open **Settings → Remote Access** to prepare pairing and connect once mobile beta/public access is enabled.
## Data & Privacy
docs/MSP.md
+1 -1
View File
@@ -212,7 +212,7 @@ automatically.
Each client runtime (or organization) generates its own reports, scoped to
that client's resources:
- **UI**: Settings → Reports.
- **UI**: Settings → Data & Reports.
- **API**: `GET /api/admin/reports/generate` (single resource) and
`POST /api/admin/reports/generate-multi` (up to 50 resources per report),
returning PDF or CSV. In shared-process mode, scope with `X-Pulse-Org-ID`
docs/MULTI_TENANT.md
+2 -2
View File
@@ -16,7 +16,7 @@ Without these, all API calls return `501 Not Implemented` (flag off) or `402 Pay
## Quick Start
1. Set `PULSE_MULTI_TENANT_ENABLED=true` in your environment and restart Pulse.
2. Activate your Enterprise license in **Settings → Plans**.
2. Activate your Enterprise license in **Settings → Plans & Billing**.
3. Go to **Settings → Organization** and click **Create Organization**.
4. Name your organization and assign infrastructure to it.
5. Use the **Org Switcher** in the header bar to switch between organizations.
@@ -190,7 +190,7 @@ Set `PULSE_MULTI_TENANT_ENABLED=true` in your environment and restart Pulse.
### "Multi-tenant requires an Enterprise license" (402)
Activate an Enterprise license with the `multi_tenant` capability in **Settings → Plans**.
Activate an Enterprise license with the `multi_tenant` capability in **Settings → Plans & Billing**.
### Organization data not loading after switch
docs/RBAC.md
+1 -1
View File
@@ -31,7 +31,7 @@ When using OIDC/SSO, roles can be automatically assigned based on group membersh
## Quick Start
1. Activate a Pro, grandfathered Pro+, Cloud, MSP, or Enterprise/custom license in **Settings → Plans**.
1. Activate a Pro, grandfathered Pro+, Cloud, MSP, or Enterprise/custom license in **Settings → Plans & Billing**.
2. Go to **Settings → Security → Access Control**.
3. Create roles with the permissions you need.
4. Assign roles to users.
docs/RELAY.md
+7 -7
View File
@@ -2,7 +2,7 @@
Pulse Relay provides **end-to-end encrypted remote access** foundations for Pulse instances. It allows secure remote connectivity without exposing your Pulse server to the public internet.
> Supported Pulse Mobile clients pair from **Settings → Relay** using a QR code or deep link and connect through Pulse Relay over end-to-end encrypted remote access.
> Supported Pulse Mobile clients pair from **Settings → Remote Access** using a QR code or deep link and connect through Pulse Relay over end-to-end encrypted remote access.
## How It Works
@@ -20,7 +20,7 @@ Pulse Relay provides **end-to-end encrypted remote access** foundations for Puls
## Quick Start
1. Go to **Settings → Relay**.
1. Go to **Settings → Remote Access**.
2. Toggle relay **On**.
3. Use the **QR Code** or **Deep Link** to pair a supported Pulse Mobile client.
4. Your paired mobile client connects through relay.
@@ -49,7 +49,7 @@ Relay was designed with a zero-trust model:
### UI
**Settings → Relay** — toggle on/off, view QR code, and manage relay pairing sessions.
**Settings → Remote Access** — toggle on/off, view QR code, and manage relay pairing sessions.
### Environment Variables
@@ -84,7 +84,7 @@ Relay configuration is stored encrypted in `relay.enc` in the Pulse data directo
1. Pulse Mobile is in early access. Relay and Pro customers get install links from the authenticated [download page](https://pulserelay.pro/download.html).
2. Open Pulse Mobile and tap **Connect to Server**.
3. Scan the QR code from **Settings → Relay** in your Pulse web UI.
3. Scan the QR code from **Settings → Remote Access** in your Pulse web UI.
4. The app connects via the relay for push notifications and secure Open Pulse handoff.
### Multiple Servers
@@ -95,7 +95,7 @@ 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**).
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
@@ -109,14 +109,14 @@ Pulse Mobile can pair with multiple Pulse instances. Each pairing has its own en
### Pulse Mobile can't connect
1. Verify relay is enabled in **Settings → Relay**.
1. Verify relay is enabled in **Settings → Remote Access**.
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.
### Open Pulse handoff not loading
1. Check the relay connection status in **Settings → Relay**.
1. Check the relay connection status in **Settings → Remote Access**.
2. Look for WebSocket reconnection messages in Pulse logs.
3. Restart Pulse Mobile.
docs/TROUBLESHOOTING.md
+2 -2
View File
@@ -79,7 +79,7 @@ sudo pulse bootstrap-token
### Notifications
#### Emails not sending
- Check SMTP settings in **Alerts → Notification Destinations**.
- Check SMTP settings in **Alerts → Notifications**.
- Check logs: `docker logs pulse | grep email`.
- Ensure your SMTP provider allows the connection (e.g., Gmail App Passwords).
@@ -111,7 +111,7 @@ sudo pulse bootstrap-token
### Relay / Mobile
#### Relay showing "Disconnected"
- Confirm a valid Relay, Pro, grandfathered Pro+, or Cloud license is active (**Settings → Plans**).
- 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`.
docs/WEBHOOKS.md
+4 -4
View File
@@ -4,7 +4,7 @@ Pulse includes built-in templates for popular services and a generic JSON templa
## 🚀 Quick Setup
1. Go to **Alerts → Notification Destinations**.
1. Go to **Alerts → Notifications**.
2. Click **Add Webhook**.
3. Click the current service label (Generic by default) to open the service picker, choose the destination type, and paste the URL.
@@ -118,7 +118,7 @@ Content-Type: application/json
Pro, legacy Pro+, and Cloud support dedicated audit webhooks for security event compliance. Unlike alert notifications, these webhooks deliver the raw, signed JSON payload of every security-relevant action (login, config change, group mapping).
### Setup
1. Go to **Settings → Security → Webhooks**.
1. Go to **Settings → Security → Audit Webhooks**.
2. Add your endpoint URL (e.g., `https://siem.corp.local/ingest/pulse`).
### Security
@@ -135,7 +135,7 @@ Built-in webhook templates include Gotify, PagerDuty, Slack, and Generic. Use th
Typical MSP setup:
1. Open the client workspace from Pulse Account.
2. Add that client's notification destinations in **Alerts → Notification Destinations**.
2. Add that client's notification destinations in **Alerts → Notifications**.
3. Use Gotify, PagerDuty, Slack, or Generic depending on where the client or provider team wants alerts to land.
4. Keep each destination scoped to the client runtime so alert payloads and resolved events never cross into another client's workflow.
@@ -160,7 +160,7 @@ There are two integration models. The push model is usually the right fit when t
**Push (recommended): one outbound webhook per organization.** Create a **Generic** webhook for each organization and point it at your external system's inbound endpoint (an ITSM/PSA inbound webhook, an email connector, or middleware that opens service tickets). Shape the JSON with a [custom template](#-custom-templates) so it matches the receiving system's expected schema: every template variable listed above is available. Pulse fires on both `alert` and `resolved` events (`{{.Event}}` is `"alert"` or `"resolved"`), so the receiving system can open a ticket on alert and auto-resolve it on recovery. Add authentication as a custom header (e.g. `Authorization: Bearer ...`).
Configure it from the UI (**Alerts → Notification Destinations → Add Webhook**) per org, or programmatically with an org-bound admin token:
Configure it from the UI (**Alerts → Notifications → Add Webhook**) per org, or programmatically with an org-bound admin token:
```http
POST /api/notifications/webhooks