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.

Explain safe containment after an accidental public disclosure

pulse-triage[bot]6409a3848099
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 12442bf1cf..a19491d432 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -15,6 +15,8 @@ body:
Anything you attach here is public. Review files and screenshots locally before posting, even when an export is labelled "sanitized". Remove credentials, session cookies, secret URLs, private host/network and personal details, including text echoed in errors. Do not attach full/private diagnostics, .env or configuration files, private keys, Copy as cURL commands or full network exports.
+ If a credential has already been posted, revoke it with its issuer and remove the public copy; editing a post is not revocation or proof that every copy is gone. Do not repost the original evidence; use the [private security disclosure route](https://github.com/rcourtman/Pulse/security/policy) for sensitive details.
+
- type: textarea
id: bug_description
attributes:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index c2fae6e291..977b73ae61 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -11,6 +11,8 @@ body:
Anything you attach here is public. Review files and screenshots locally before posting, even when an export is labelled "sanitized". Remove credentials, session cookies, secret URLs, private host/network and personal details, including text echoed in errors. Do not attach full/private diagnostics, .env or configuration files, private keys, Copy as cURL commands or full network exports.
+ If a credential has already been posted, revoke it with its issuer and remove the public copy; editing a post is not revocation or proof that every copy is gone. Do not repost the original evidence; use the [private security disclosure route](https://github.com/rcourtman/Pulse/security/policy) for sensitive details.
+
- type: textarea
id: problem
attributes:
diff --git a/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml b/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
index fee1d2bfb3..0bb07397a3 100644
--- a/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
+++ b/.github/ISSUE_TEMPLATE/v6_rc_feedback.yml
@@ -14,6 +14,8 @@ body:
Anything you attach here is public. Review files and screenshots locally before posting, even when an export is labelled "sanitized". Remove credentials, session cookies, secret URLs, private host/network and personal details, including text echoed in errors. Do not attach full/private diagnostics, .env or configuration files, private keys, Copy as cURL commands or full network exports.
+ If a credential has already been posted, revoke it with its issuer and remove the public copy; editing a post is not revocation or proof that every copy is gone. Do not repost the original evidence; use the [private security disclosure route](https://github.com/rcourtman/Pulse/security/policy) for sensitive details.
+
- type: dropdown
id: feedback_type
attributes:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 75445a4c3a..d991ed6512 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -78,6 +78,10 @@ and installer tooling.
private. Do not attach configuration or `.env` files, private keys, **Copy as
cURL** commands or full network exports. Never put credentials in a command
line, URL or thread.
+- If private information has already been posted, follow the
+ [containment steps](docs/TROUBLESHOOTING.md#if-you-already-posted-private-information).
+ Removing a post is not credential revocation or proof that every copy is gone;
+ do not repost the original evidence to ask for help.
- For CPU, memory or disk-write reports, use existing readings or safe passive
observations. Where known, say whether they measure the Pulse process, its
container or the whole host, with units, measurement window and uptime.
diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md
index 60a883d740..869d922c09 100644
--- a/docs/TROUBLESHOOTING.md
+++ b/docs/TROUBLESHOOTING.md
@@ -1237,6 +1237,35 @@ not limited to the lines visible in the panel. Keep the archive private and
share only relevant, manually reviewed, redacted excerpts. See the
[log-control and export limits](CONFIGURATION.md#log-levels).
+### If you already posted private information
+
+Treat a publicly posted credential as exposed, even if you later edit or delete
+the post. Do not paste it again to identify it or test whether it still works.
+
+- **Revoke access at its source.** Use a trusted administrator session to revoke
+ the affected credential with its issuer. Manage Pulse API tokens in
+ **Settings → API Access**; Proxmox/PBS tokens and notification-provider secrets
+ need revocation at their respective providers. Removing a Pulse connection or
+ stopping an agent is not credential revocation. A session cookie needs the
+ authentication system's session-revocation procedure; clearing local browser
+ cookies is not server-side revocation. Check the issuer's confirmation, not
+ just a dismissed dialog. Revocation can interrupt monitoring or notifications;
+ arrange independent coverage and configure legitimate consumers privately
+ with a replacement carrying no wider permissions.
+- **Remove the public copy too.** Edit the affected text and remove the attached
+ file or screenshot. Editing the text alone does not remove an attachment.
+ Ask GitHub for help with content you cannot remove yourself, but do not wait
+ for removal before revoking access. Copies, notification emails and attachment
+ links may survive; deleting a post is not proof that the information is erased.
+- **Keep the remaining evidence private.** Preserve the original locally, not
+ in another public upload. Public follow-up needs only the time, affected
+ version, type of exposed information and relevant redacted symptoms. For
+ sensitive security details, use the [private disclosure route](../SECURITY.md),
+ not another issue or discussion. Do not send the credential itself or upload
+ an unreviewed replacement bundle. If only private identifying details were
+ exposed, seek GitHub's help with removal of copies you cannot remove yourself;
+ that alone is not a reason to rotate unrelated credentials.
+
### Inspect Notification Logs
For notification failures, prefer **Recent delivery activity** in **Alerts →
diff --git a/frontend-modern/public/docs/CONTRIBUTING.md b/frontend-modern/public/docs/CONTRIBUTING.md
index 75445a4c3a..d991ed6512 100644
--- a/frontend-modern/public/docs/CONTRIBUTING.md
+++ b/frontend-modern/public/docs/CONTRIBUTING.md
@@ -78,6 +78,10 @@ and installer tooling.
private. Do not attach configuration or `.env` files, private keys, **Copy as
cURL** commands or full network exports. Never put credentials in a command
line, URL or thread.
+- If private information has already been posted, follow the
+ [containment steps](docs/TROUBLESHOOTING.md#if-you-already-posted-private-information).
+ Removing a post is not credential revocation or proof that every copy is gone;
+ do not repost the original evidence to ask for help.
- For CPU, memory or disk-write reports, use existing readings or safe passive
observations. Where known, say whether they measure the Pulse process, its
container or the whole host, with units, measurement window and uptime.
diff --git a/frontend-modern/public/docs/TROUBLESHOOTING.md b/frontend-modern/public/docs/TROUBLESHOOTING.md
index 60a883d740..869d922c09 100644
--- a/frontend-modern/public/docs/TROUBLESHOOTING.md
+++ b/frontend-modern/public/docs/TROUBLESHOOTING.md
@@ -1237,6 +1237,35 @@ not limited to the lines visible in the panel. Keep the archive private and
share only relevant, manually reviewed, redacted excerpts. See the
[log-control and export limits](CONFIGURATION.md#log-levels).
+### If you already posted private information
+
+Treat a publicly posted credential as exposed, even if you later edit or delete
+the post. Do not paste it again to identify it or test whether it still works.
+
+- **Revoke access at its source.** Use a trusted administrator session to revoke
+ the affected credential with its issuer. Manage Pulse API tokens in
+ **Settings → API Access**; Proxmox/PBS tokens and notification-provider secrets
+ need revocation at their respective providers. Removing a Pulse connection or
+ stopping an agent is not credential revocation. A session cookie needs the
+ authentication system's session-revocation procedure; clearing local browser
+ cookies is not server-side revocation. Check the issuer's confirmation, not
+ just a dismissed dialog. Revocation can interrupt monitoring or notifications;
+ arrange independent coverage and configure legitimate consumers privately
+ with a replacement carrying no wider permissions.
+- **Remove the public copy too.** Edit the affected text and remove the attached
+ file or screenshot. Editing the text alone does not remove an attachment.
+ Ask GitHub for help with content you cannot remove yourself, but do not wait
+ for removal before revoking access. Copies, notification emails and attachment
+ links may survive; deleting a post is not proof that the information is erased.
+- **Keep the remaining evidence private.** Preserve the original locally, not
+ in another public upload. Public follow-up needs only the time, affected
+ version, type of exposed information and relevant redacted symptoms. For
+ sensitive security details, use the [private disclosure route](../SECURITY.md),
+ not another issue or discussion. Do not send the credential itself or upload
+ an unreviewed replacement bundle. If only private identifying details were
+ exposed, seek GitHub's help with removal of copies you cannot remove yourself;
+ that alone is not a reason to rotate unrelated credentials.
+
### Inspect Notification Logs
For notification failures, prefer **Recent delivery activity** in **Alerts →
diff --git a/scripts/tests/test_public_report_containment_docs.py b/scripts/tests/test_public_report_containment_docs.py
new file mode 100644
index 0000000000..d8d23ccb76
--- /dev/null
+++ b/scripts/tests/test_public_report_containment_docs.py
@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+"""Check reporting guidance, not live revocation or GitHub data erasure."""
+
+from pathlib import Path
+import unittest
+
+
+ROOT = Path(__file__).resolve().parents[2]
+HEADING = "### If you already posted private information\n"
+ANCHOR = "docs/TROUBLESHOOTING.md#if-you-already-posted-private-information"
+
+
+def containment(text):
+ """Restrict checks to the instructions a reader follows after exposure."""
+ return " ".join(text.split(HEADING, 1)[1].split("\n### ", 1)[0].split())
+
+
+class PublicReportContainmentDocsTest(unittest.TestCase):
+ def test_revocation_is_issuer_specific_and_preserves_least_privilege(self):
+ text = containment((ROOT / "docs/TROUBLESHOOTING.md").read_text())
+ for statement in (
+ "publicly posted credential as exposed",
+ "trusted administrator session", "affected credential with its issuer",
+ "Settings → API Access", "respective providers",
+ "stopping an agent is not credential revocation",
+ "clearing local browser cookies is not server-side revocation",
+ "issuer's confirmation", "interrupt monitoring or notifications",
+ "independent coverage", "replacement carrying no wider permissions",
+ "not a reason to rotate unrelated credentials",
+ ):
+ with self.subTest(statement=statement):
+ self.assertIn(statement, text)
+
+ def test_removal_never_promises_erasure_or_replaces_revocation(self):
+ text = containment((ROOT / "docs/TROUBLESHOOTING.md").read_text())
+ for statement in (
+ "Editing the text alone does not remove an attachment",
+ "GitHub for help with content you cannot remove yourself",
+ "do not wait for removal before revoking access",
+ "notification emails and attachment links may survive",
+ "not proof that the information is erased",
+ ):
+ with self.subTest(statement=statement):
+ self.assertIn(statement, text)
+
+ def test_follow_up_keeps_originals_private_and_uses_existing_disclosure_route(self):
+ text = containment((ROOT / "docs/TROUBLESHOOTING.md").read_text())
+ for statement in (
+ "Do not paste it again", "test whether it still works",
+ "Preserve the original locally, not in another public upload",
+ "relevant redacted symptoms", "[private disclosure route](../SECURITY.md)",
+ "not another issue or discussion", "Do not send the credential itself",
+ "unreviewed replacement bundle",
+ ):
+ with self.subTest(statement=statement):
+ self.assertIn(statement, text)
+ self.assertIn("**Private disclosures:** <[email protected]>",
+ (ROOT / "SECURITY.md").read_text())
+ self.assertIn(ANCHOR, (ROOT / "CONTRIBUTING.md").read_text())
+
+ def test_every_report_form_warns_before_the_first_public_input(self):
+ for name in ("bug_report.yml", "v6_rc_feedback.yml", "feature_request.yml"):
+ with self.subTest(form=name):
+ text = (ROOT / ".github/ISSUE_TEMPLATE" / name).read_text()
+ intro = text.split(" - type: ", 2)[1]
+ for statement in (
+ "If a credential has already been posted", "revoke it with its issuer",
+ "remove the public copy", "editing a post is not revocation",
+ "Do not repost the original evidence",
+ "https://github.com/rcourtman/Pulse/security/policy",
+ ):
+ self.assertIn(statement, intro)
+
+ def test_shipped_help_and_contribution_entrypoint_match_their_sources(self):
+ for source in ("docs/TROUBLESHOOTING.md", "CONTRIBUTING.md"):
+ with self.subTest(source=source):
+ self.assertEqual((ROOT / source).read_bytes(),
+ (ROOT / "frontend-modern/public/docs" / Path(source).name).read_bytes())
+
+
+if __name__ == "__main__":
+ unittest.main()