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.

Pin installer help to its verified private-file guide

pulse-triage[bot]3bb2c7e95dea
diff --git a/scripts/install.sh b/scripts/install.sh
index e5dda1e115..90f58a7ca7 100755
--- a/scripts/install.sh
+++ b/scripts/install.sh
@@ -555,7 +555,7 @@ Download over verified HTTPS to a private file and inspect it before running.
Keep API tokens out of command history and process arguments. Prefer --token-file;
the caller owns input-file cleanup. Use the target host's root/admin shell where
required. For private-file preparation and platform requirements, see:
- https://github.com/rcourtman/Pulse/blob/main/docs/UNIFIED_AGENT.md#private-file-installation-linux-macos-and-nas
+ https://github.com/rcourtman/Pulse/blob/fe65bc4c4760dfe82f758dc926fb2cc456f49080/docs/UNIFIED_AGENT.md#private-file-installation-linux-macos-and-nas
Options:
--url <url> Pulse server URL (e.g. https://pulse.example.com)
diff --git a/scripts/tests/test_agent_installer_help.py b/scripts/tests/test_agent_installer_help.py
index 2607c6bdf3..8bd9a36ecf 100644
--- a/scripts/tests/test_agent_installer_help.py
+++ b/scripts/tests/test_agent_installer_help.py
@@ -4,6 +4,7 @@
import json
import os
from pathlib import Path
+import re
import shutil
import subprocess
import tempfile
@@ -62,6 +63,17 @@ class AgentInstallerHelpTest(unittest.TestCase):
self.assertNotRegex(usage, r"--token(?:\s|=)|http://|\|\s*(?:sudo\s+)?bash")
self.assertIn('https://pulse.example.com --token-file "$HOME/.config/pulse/agent-token"', usage)
+ def test_help_links_to_immutable_private_file_preparation(self):
+ links = re.findall(r"https://github\.com/\S+", help_text())
+ self.assertEqual(len(links), 1)
+ self.assertRegex(
+ links[0],
+ r"^https://github\.com/rcourtman/Pulse/blob/[0-9a-f]{40}/"
+ r"docs/UNIFIED_AGENT\.md#private-file-installation-linux-macos-and-nas$",
+ )
+ self.assertIn("### Private-file installation: Linux, macOS and NAS",
+ (ROOT / "docs/UNIFIED_AGENT.md").read_text())
+
def test_source_header_and_shipped_help_recommend_the_same_commands(self):
header = INSTALLER.read_text().split("# Usage:\n", 1)[1].split("\n# Options:", 1)[0]
commands = [line.removeprefix("# ").removesuffix(" [options]")