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.

Keep manual update help from running an unknown helper

pulse-triage[bot]d96ab64e01fa
diff --git a/docs/AUTO_UPDATE.md b/docs/AUTO_UPDATE.md
index 38dbff640e..5ba3f301c5 100644
--- a/docs/AUTO_UPDATE.md
+++ b/docs/AUTO_UPDATE.md
@@ -86,6 +86,13 @@ Auto-update preferences are stored in `system.json` and edited via the UI.
## Manual Update Methods
+Before updating, record the running server version and edition, preserve the
+existing deployment definition privately, and keep a consistent
+[full-state backup](MIGRATION.md#full-state-recovery) with its matching keys.
+An update interrupts monitoring and alert delivery. Follow
+[update preparation and recovery limits](DEPLOYMENT_MODELS.md#updates-by-model);
+do not update during a backup, freeze/thaw or an unresponsive-guest incident.
+
### Docker
Use [Docker server updates](DOCKER.md#-updates). Change the configured image to
@@ -101,19 +108,45 @@ container updates are separate operations.
### ProxmoxVE LXC (Manual)
-```bash
-sudo /bin/update
-```
-
-`/bin/update` is installed by the supported Pulse server installer and preserves the signed-installer trust chain. If your host does not have it yet, use the signed server-installer flow in [INSTALL.md](INSTALL.md). Agent updates still use the `/install.sh` command generated in **Settings → Infrastructure → Install on a host**.
+Work **inside the existing Pulse LXC**, not on the Proxmox host or a monitored
+guest. Follow the [existing-installation update procedure](INSTALL.md#-updates),
+including its helper-ownership check. On a community-scripts installation,
+`/bin/update` can be a different updater; its filename does not establish that
+it uses Pulse's signed installer or accepts an exact target version.
### Systemd Service (Manual)
-```bash
-sudo /bin/update
-```
-
-`/bin/update` is installed by the supported Pulse server installer and preserves the signed-installer trust chain. If your host does not have it yet, use the signed server-installer flow in [INSTALL.md](INSTALL.md). Agent updates still use the `/install.sh` command generated in **Settings → Infrastructure → Install on a host**.
+Follow the [existing-installation update procedure](INSTALL.md#-updates) using
+the actual installed server service, paths and update helper. Do not run a
+helper whose owner is unknown or apply default installation paths over a
+custom deployment. Server updates do not install or update `pulse-agent`;
+agent installation commands come from **Settings → Infrastructure → Install
+on a host**.
+
+### A helper selects a Helm-chart release
+
+A Pulse server release uses a tag such as `vX.Y.Z`. A `helm-chart-*` release
+contains a Kubernetes chart, not the Linux server archive. A helper selecting
+a chart does not establish that Pulse's server release is missing or that
+GitHub's latest-release pointer is wrong; preserve the selected tag and error.
+
+Do not supply a GitHub personal access token, bypass signatures or change
+permissions to make that helper continue. An unknown helper may ignore
+`--version`; even a Pulse-owned helper must download its installer before the
+installer can apply that option. Adding the flag is not proof of an exact or
+successful update.
+
+Before another attempt, check the running version and service health and
+preserve the existing container, configuration, keys and history. Do not
+recreate the LXC or install a second server to recover from release selection.
+For a public Community server, the
+[existing-installation procedure](INSTALL.md#-updates) links the signed
+server-installer flow with an exact `PULSE_VERSION`; use it only after checking
+the installed service and paths. Private Pro installations must retain their
+private runtime, not substitute that public installer. Use
+[update failure checks](#update-failed) if the attempted update's result is
+uncertain. Guidance is not confirmation that the helper or installation is
+repaired.
### Source Build
diff --git a/docs/INSTALL.md b/docs/INSTALL.md
index b8ce64f8ca..d171337bff 100644
--- a/docs/INSTALL.md
+++ b/docs/INSTALL.md
@@ -317,11 +317,22 @@ an updater snapshot alone is not a complete data backup. See
Use `/bin/update --version vX.Y.Z` for an exact target only when the helper was
installed by the Pulse server installer. On Proxmox community-scripts
containers, `/bin/update` can belong to a different updater that ignores
-`--version`. If the helper is absent or its owner is unknown, use the
+`--version`. If the helper is absent or its owner is unknown, stop before
+executing it. For a public Community server, review the
[signed server-installer flow](#2-bare-metal--systemd) with `PULSE_VERSION` set
-to the exact target tag. The same ownership check applies to rollback. After
+to the exact target tag, first confirming the existing service and data/config
+paths; do not apply its default paths over a custom deployment or replace a
+private Pro runtime with a public build. Work inside the existing Pulse LXC,
+not on the Proxmox host. The same ownership check applies to rollback. After
the service restarts, verify the installed version with `GET /api/version`.
+If a helper selects `helm-chart-*` instead of a Pulse server release, follow
+[Helm-chart selection checks](AUTO_UPDATE.md#a-helper-selects-a-helm-chart-release)
+before another attempt. A chart is not a server archive, and adding
+`--version` to an unknown or download-failing helper does not prove an exact
+update. Do not recreate the LXC, provide a GitHub token or bypass signatures
+to clear that failure.
+
For Docker without Compose, `docker restart` keeps the old image running.
Select the target in the existing saved deployment and pull it successfully
before stopping the current container. Recreate through that deployment with
diff --git a/frontend-modern/public/docs/AUTO_UPDATE.md b/frontend-modern/public/docs/AUTO_UPDATE.md
index 38dbff640e..5ba3f301c5 100644
--- a/frontend-modern/public/docs/AUTO_UPDATE.md
+++ b/frontend-modern/public/docs/AUTO_UPDATE.md
@@ -86,6 +86,13 @@ Auto-update preferences are stored in `system.json` and edited via the UI.
## Manual Update Methods
+Before updating, record the running server version and edition, preserve the
+existing deployment definition privately, and keep a consistent
+[full-state backup](MIGRATION.md#full-state-recovery) with its matching keys.
+An update interrupts monitoring and alert delivery. Follow
+[update preparation and recovery limits](DEPLOYMENT_MODELS.md#updates-by-model);
+do not update during a backup, freeze/thaw or an unresponsive-guest incident.
+
### Docker
Use [Docker server updates](DOCKER.md#-updates). Change the configured image to
@@ -101,19 +108,45 @@ container updates are separate operations.
### ProxmoxVE LXC (Manual)
-```bash
-sudo /bin/update
-```
-
-`/bin/update` is installed by the supported Pulse server installer and preserves the signed-installer trust chain. If your host does not have it yet, use the signed server-installer flow in [INSTALL.md](INSTALL.md). Agent updates still use the `/install.sh` command generated in **Settings → Infrastructure → Install on a host**.
+Work **inside the existing Pulse LXC**, not on the Proxmox host or a monitored
+guest. Follow the [existing-installation update procedure](INSTALL.md#-updates),
+including its helper-ownership check. On a community-scripts installation,
+`/bin/update` can be a different updater; its filename does not establish that
+it uses Pulse's signed installer or accepts an exact target version.
### Systemd Service (Manual)
-```bash
-sudo /bin/update
-```
-
-`/bin/update` is installed by the supported Pulse server installer and preserves the signed-installer trust chain. If your host does not have it yet, use the signed server-installer flow in [INSTALL.md](INSTALL.md). Agent updates still use the `/install.sh` command generated in **Settings → Infrastructure → Install on a host**.
+Follow the [existing-installation update procedure](INSTALL.md#-updates) using
+the actual installed server service, paths and update helper. Do not run a
+helper whose owner is unknown or apply default installation paths over a
+custom deployment. Server updates do not install or update `pulse-agent`;
+agent installation commands come from **Settings → Infrastructure → Install
+on a host**.
+
+### A helper selects a Helm-chart release
+
+A Pulse server release uses a tag such as `vX.Y.Z`. A `helm-chart-*` release
+contains a Kubernetes chart, not the Linux server archive. A helper selecting
+a chart does not establish that Pulse's server release is missing or that
+GitHub's latest-release pointer is wrong; preserve the selected tag and error.
+
+Do not supply a GitHub personal access token, bypass signatures or change
+permissions to make that helper continue. An unknown helper may ignore
+`--version`; even a Pulse-owned helper must download its installer before the
+installer can apply that option. Adding the flag is not proof of an exact or
+successful update.
+
+Before another attempt, check the running version and service health and
+preserve the existing container, configuration, keys and history. Do not
+recreate the LXC or install a second server to recover from release selection.
+For a public Community server, the
+[existing-installation procedure](INSTALL.md#-updates) links the signed
+server-installer flow with an exact `PULSE_VERSION`; use it only after checking
+the installed service and paths. Private Pro installations must retain their
+private runtime, not substitute that public installer. Use
+[update failure checks](#update-failed) if the attempted update's result is
+uncertain. Guidance is not confirmation that the helper or installation is
+repaired.
### Source Build
diff --git a/frontend-modern/public/docs/INSTALL.md b/frontend-modern/public/docs/INSTALL.md
index b8ce64f8ca..d171337bff 100644
--- a/frontend-modern/public/docs/INSTALL.md
+++ b/frontend-modern/public/docs/INSTALL.md
@@ -317,11 +317,22 @@ an updater snapshot alone is not a complete data backup. See
Use `/bin/update --version vX.Y.Z` for an exact target only when the helper was
installed by the Pulse server installer. On Proxmox community-scripts
containers, `/bin/update` can belong to a different updater that ignores
-`--version`. If the helper is absent or its owner is unknown, use the
+`--version`. If the helper is absent or its owner is unknown, stop before
+executing it. For a public Community server, review the
[signed server-installer flow](#2-bare-metal--systemd) with `PULSE_VERSION` set
-to the exact target tag. The same ownership check applies to rollback. After
+to the exact target tag, first confirming the existing service and data/config
+paths; do not apply its default paths over a custom deployment or replace a
+private Pro runtime with a public build. Work inside the existing Pulse LXC,
+not on the Proxmox host. The same ownership check applies to rollback. After
the service restarts, verify the installed version with `GET /api/version`.
+If a helper selects `helm-chart-*` instead of a Pulse server release, follow
+[Helm-chart selection checks](AUTO_UPDATE.md#a-helper-selects-a-helm-chart-release)
+before another attempt. A chart is not a server archive, and adding
+`--version` to an unknown or download-failing helper does not prove an exact
+update. Do not recreate the LXC, provide a GitHub token or bypass signatures
+to clear that failure.
+
For Docker without Compose, `docker restart` keeps the old image running.
Select the target in the existing saved deployment and pull it successfully
before stopping the current container. Recreate through that deployment with
diff --git a/scripts/tests/test_update_recovery_docs.py b/scripts/tests/test_update_recovery_docs.py
index bd5fabcfa3..62a831db76 100644
--- a/scripts/tests/test_update_recovery_docs.py
+++ b/scripts/tests/test_update_recovery_docs.py
@@ -64,6 +64,66 @@ else:
class UpdateRecoveryDocsTest(unittest.TestCase):
+ def assert_host_update_entry(self, text):
+ # The entry point must hand off to the ownership-checked procedure,
+ # not execute whichever program happens to be called /bin/update.
+ self.assertIn("](INSTALL.md#-updates)", text)
+ self.assertNotRegex(text, r"```(?:bash|sh|shell)\b")
+ self.assertNotRegex(text, r"\bsudo\s+/bin/update\b")
+
+ def test_manual_host_entries_do_not_execute_an_unidentified_helper(self):
+ lxc = section("AUTO_UPDATE", "ProxmoxVE LXC (Manual)", "###")
+ systemd = section("AUTO_UPDATE", "Systemd Service (Manual)", "###")
+ for entry in (lxc, systemd):
+ self.assert_host_update_entry(entry)
+ with self.assertRaises(AssertionError):
+ self.assert_host_update_entry(entry + "\n```bash\nsudo /bin/update\n```\n")
+ self.assertIn("inside the existing Pulse LXC", lxc)
+ self.assertIn("not on the Proxmox host", lxc)
+ self.assertIn("community-scripts installation", lxc)
+ self.assertIn("helper whose owner is unknown", systemd)
+ self.assertIn("default installation paths", systemd)
+
+ def test_chart_selection_help_preserves_evidence_and_exact_installer_trust(self):
+ text = " ".join(section("AUTO_UPDATE", "A helper selects a Helm-chart release", "###").split())
+ for phrase in (
+ "`vX.Y.Z`", "`helm-chart-*`", "not the Linux server archive",
+ "does not establish", "latest-release pointer is wrong",
+ "preserve the selected tag and error", "GitHub personal access token",
+ "bypass signatures", "unknown helper may ignore `--version`",
+ "download its installer before", "running version and service health",
+ "configuration, keys and history", "Do not recreate the LXC",
+ "exact `PULSE_VERSION`", "installed service and paths",
+ "Private Pro installations must retain their private runtime",
+ "not confirmation", "INSTALL.md#-updates", "#update-failed",
+ ):
+ with self.subTest(phrase=phrase):
+ self.assertIn(phrase, text)
+ self.assertNotIn("```", text, "No alternate unverified download or repair recipe")
+
+ # The linked public installer recipe downloads both files from the
+ # selected release, not a moving /latest asset URL. Its executable
+ # download/signature failure controls live in test_signed_installer_docs.
+ recipes = [block for block in re.findall(r"```bash\n(.*?)```", guide("INSTALL"), re.S)
+ if "ssh-keygen -Y verify" in block]
+ self.assertEqual(len(recipes), 2)
+ for recipe in recipes:
+ self.assertIn('/releases/download/${PULSE_VERSION}/install.sh"', recipe)
+ self.assertIn('/releases/download/${PULSE_VERSION}/install.sh.sshsig"', recipe)
+ self.assertNotIn("/latest/", recipe)
+
+ def test_install_update_link_keeps_helper_ownership_and_existing_paths(self):
+ text = " ".join(section("INSTALL", "Manual Update", "####").split())
+ for phrase in (
+ "helper is absent or its owner is unknown", "stop before executing it",
+ "existing service and data/config paths", "default paths over a custom deployment",
+ "private Pro runtime with a public build", "inside the existing Pulse LXC",
+ "AUTO_UPDATE.md#a-helper-selects-a-helm-chart-release",
+ "unknown or download-failing helper", "Do not recreate the LXC",
+ ):
+ with self.subTest(phrase=phrase):
+ self.assertIn(phrase, text)
+
def exercise(self, recipe, **settings):
with tempfile.TemporaryDirectory() as temporary:
root = Path(temporary)