mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-10 02:25:56 +00:00
+2
-2
@@ -88,7 +88,7 @@ If you use the legacy `docker-compose` binary, replace `docker compose` with `do
|
||||
curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.sh | bash
|
||||
```
|
||||
|
||||
This script installs/updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Unified Agents → Installation commands**.
|
||||
This script installs/updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Infrastructure → Install on a host**.
|
||||
|
||||
### Systemd Service (Manual)
|
||||
|
||||
@@ -96,7 +96,7 @@ This script installs/updates the **Pulse server**. Agent updates use the `/insta
|
||||
curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.sh | bash
|
||||
```
|
||||
|
||||
This script installs/updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Unified Agents → Installation commands**.
|
||||
This script installs/updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Infrastructure → Install on a host**.
|
||||
|
||||
### Source Build
|
||||
|
||||
|
||||
+2
-2
@@ -51,11 +51,11 @@ curl -fsSL https://yourname.cloud.pulserelay.pro/install.sh | \
|
||||
bash -s -- --url https://yourname.cloud.pulserelay.pro --token <api-token>
|
||||
```
|
||||
|
||||
Generate installation commands from **Settings → Unified Agents → Installation commands** in your cloud dashboard.
|
||||
Generate installation commands from **Settings → Infrastructure → Install on a host** in your cloud dashboard.
|
||||
|
||||
### 3. Add Proxmox / TrueNAS Connections
|
||||
|
||||
Add your Proxmox VE, PBS, PMG, or TrueNAS systems via **Settings → Infrastructure** or **Settings → TrueNAS**.
|
||||
Add your Proxmox VE, PBS, PMG, or TrueNAS systems via **Settings → Infrastructure → Platform connections**.
|
||||
|
||||
### 4. Set Up Mobile Access
|
||||
|
||||
|
||||
+5
-4
@@ -9,7 +9,7 @@ If you run Proxmox VE, use the official LXC installer (recommended):
|
||||
curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.sh | bash
|
||||
```
|
||||
|
||||
Note: this installs the Pulse **server**. Agent installs use the command from **Settings → Unified Agents → Installation commands** (served from `/install.sh` on your Pulse server).
|
||||
Note: this installs the Pulse **server**. Agent installs use the command from **Settings → Infrastructure → Install on a host** (served from `/install.sh` on your Pulse server).
|
||||
|
||||
If you prefer Docker:
|
||||
|
||||
@@ -20,10 +20,11 @@ docker run -d --name pulse -p 7655:7655 -v pulse_data:/data rcourtman/pulse:late
|
||||
See [INSTALL.md](INSTALL.md) for all options (Docker Compose, Kubernetes, systemd).
|
||||
|
||||
### How do I add a node?
|
||||
Go to **Settings → Unified Agents**.
|
||||
Go to **Settings → Infrastructure → Install on a host** for systems that should
|
||||
run the unified agent directly.
|
||||
|
||||
- **Recommended (Agent setup)**: select **Agent Install** and run the generated install command on the Proxmox host.
|
||||
- **Manual/API-only**: open **Advanced** in the add-node modal and use **API Only** or **Manual**.
|
||||
- **Recommended (agent setup)**: copy the generated install command and run it on the target host.
|
||||
- **Manual/API-backed platforms**: use **Settings → Infrastructure → Platform connections** for systems such as Proxmox, PBS, PMG, or TrueNAS that connect over an API instead of running the agent locally.
|
||||
|
||||
If you want Pulse to find servers automatically, enable discovery in **Settings → System → Network** and then review discovered servers in **Settings → Infrastructure**.
|
||||
|
||||
|
||||
+3
-3
@@ -13,7 +13,7 @@ Run this on your Proxmox host:
|
||||
curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.sh | bash
|
||||
```
|
||||
|
||||
> **Note**: The GitHub `install.sh` is the **server** installer. The agent installer is served from your Pulse server at `/install.sh` (see **Settings → Unified Agents → Installation commands**).
|
||||
> **Note**: The GitHub `install.sh` is the **server** installer. The agent installer is served from your Pulse server at `/install.sh` (see **Settings → Infrastructure → Install on a host**).
|
||||
|
||||
### Docker
|
||||
Ideal for containerized environments or testing.
|
||||
@@ -74,7 +74,7 @@ For Linux servers (VM or bare metal), use the official installer:
|
||||
curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.sh | sudo bash
|
||||
```
|
||||
|
||||
> **Note**: This installs the Pulse server. Use the `/install.sh` endpoint from your Pulse UI for installing `pulse-agent` on monitored hosts.
|
||||
> **Note**: This installs the Pulse server. Use the `/install.sh` endpoint from **Settings → Infrastructure → Install on a host** for installing `pulse-agent` on monitored hosts.
|
||||
|
||||
<details>
|
||||
<summary><strong>Manual systemd install (advanced)</strong></summary>
|
||||
@@ -130,7 +130,7 @@ Pulse is secure by default. On first launch, you must retrieve a **Bootstrap Tok
|
||||
- Set your **Admin Username** and **Password** (or let Pulse generate one).
|
||||
- Pulse generates an **API token** for agents and automations.
|
||||
- Copy the credentials before leaving the page.
|
||||
4. Open **Settings → Unified Agents** and install the unified agent on each host you want monitored.
|
||||
4. Open **Settings → Infrastructure → Install on a host** and install the unified agent on each host you want monitored.
|
||||
|
||||
> **Note**: If you configure authentication via environment variables (`PULSE_AUTH_USER`/`PULSE_AUTH_PASS`), the bootstrap token is automatically removed and this step is skipped.
|
||||
|
||||
|
||||
+1
-1
@@ -66,7 +66,7 @@ Because local login credentials are stored in `.env` (not part of exports), you
|
||||
3. **Update Agents**:
|
||||
* **Unified Agent**: Update the `--token` flag in your service definition.
|
||||
* **Containerized agent**: Update `PULSE_TOKEN` in the agent container environment.
|
||||
* *Tip: Use **Settings → Unified Agents → Installation commands** to generate updated install commands.*
|
||||
* *Tip: Use **Settings → Infrastructure → Install on a host** to generate updated install commands.*
|
||||
4. **Relay/Pro/Pro+/Cloud**: Re-activate your license key after migration (license files are not included in exports).
|
||||
|
||||
## 🔒 Security
|
||||
|
||||
@@ -8,7 +8,7 @@ Install it on each host you want Pulse to monitor. This is the primary monitorin
|
||||
## Quick Start
|
||||
|
||||
Generate an installation command in the UI:
|
||||
**Settings → Unified Agents → Installation commands**
|
||||
**Settings → Infrastructure → Install on a host**
|
||||
|
||||
Choose a target profile in that screen when you want explicit install flags for Docker, Kubernetes, Proxmox VE, or Proxmox Backup Server.
|
||||
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.s
|
||||
sudo bash -s -- --version vX.Y.Z
|
||||
```
|
||||
|
||||
This installer updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Unified Agents → Installation commands**.
|
||||
This installer updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Infrastructure → Install on a host**.
|
||||
|
||||
### Docker
|
||||
|
||||
|
||||
+3
-3
@@ -27,7 +27,7 @@ curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.s
|
||||
sudo bash -s -- --version vX.Y.Z
|
||||
```
|
||||
|
||||
This installer updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Unified Agents → Installation commands**.
|
||||
This installer updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Infrastructure → Install on a host**.
|
||||
|
||||
### Docker
|
||||
|
||||
@@ -66,8 +66,8 @@ No. Use the unified installer to upgrade existing agent deployments in place.
|
||||
|
||||
No. The server upgrade and the Unified Agent upgrade are separate operations.
|
||||
After the server is on v6, use the generated install or upgrade command from
|
||||
**Settings → Unified Agents → Installation commands** when you want to move
|
||||
agents to v6.
|
||||
**Settings → Infrastructure → Install on a host** when you want to move agents
|
||||
to v6.
|
||||
|
||||
### Will an upgraded v5 agent keep the same identity in v6?
|
||||
|
||||
|
||||
@@ -49,4 +49,4 @@ If an update fails:
|
||||
curl -fsSL https://github.com/rcourtman/Pulse/releases/latest/download/install.sh | \
|
||||
sudo bash -s -- --version vX.Y.Z
|
||||
```
|
||||
This installer updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Unified Agents → Installation commands**.
|
||||
This installer updates the **Pulse server**. Agent updates use the `/install.sh` command generated in **Settings → Infrastructure → Install on a host**.
|
||||
|
||||
@@ -39,7 +39,7 @@ If you install Pulse v6, your existing agents do not all switch to v6 automatica
|
||||
|
||||
After upgrading the server, update existing agents separately using the command generated from:
|
||||
|
||||
`Settings -> Unified Agents -> Installation commands`
|
||||
`Settings -> Infrastructure -> Install on a host`
|
||||
|
||||
That is the supported v5-to-v6 crossover path for agent testing.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user