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.
Go aialertsdashboarddockerdocker-monitoringgohomelabinfrastructure-monitoringkubernetesmonitoringmspproxmoxproxmox-backup-serverproxmox-mail-gatewayproxmox-veself-hostedtruenastypescriptvspherewebhooks
Keep stored findings and operator notes private in configuration help
pulse-triage[bot]8aba5e08003f
diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.mdindex 83d2a7ee12..12b9cef5b0 100644--- a/docs/CONFIGURATION.md+++ b/docs/CONFIGURATION.md@@ -17,15 +17,15 @@ Pulse uses a split-configuration model to ensure security and flexibility.| `sso.enc` | SAML/SSO provider config | π **Encrypted** || `api_tokens.json` | API token records (hashed) | π **Sensitive** || `ai.enc` | AI settings and credentials | π **Encrypted** |-| `ai_findings.json` | AI Patrol findings | π Standard |-| `ai_patrol_runs.json` | AI Patrol run history | π Standard |+| `ai_findings.json` | AI Patrol findings, evidence and user notes | π **Sensitive** |+| `ai_patrol_runs.json` | AI Patrol analysis and tool inputs/results | π **Sensitive** || `ai_usage_history.json` | AI usage history | π Standard |-| `ai_chat_sessions.json` | Legacy AI chat sessions (UI sync) | π Standard |+| `ai_chat_sessions.json` | Legacy conversations, usernames and tool inputs/results | π **Sensitive** || `license.enc` | Relay/Pro/legacy Pro+/Cloud license key | π **Encrypted** || `report_schedules.json` | Scheduled report definitions, recipients, and last-run metadata | π **Sensitive** (encrypted when data-dir encryption is enabled) |-| `host_metadata.json` | Host notes, tags, and AI command overrides | π Standard |+| `host_metadata.json` | Private host notes, URLs, tags and AI command overrides | π **Sensitive** || `docker_metadata.json` | Docker metadata cache | π Standard |-| `guest_metadata.json` | Guest notes and metadata | π Standard |+| `guest_metadata.json` | Private guest notes, URLs and remembered identity | π **Sensitive** || `agent_profiles.json` | Agent configuration profiles (Pro/legacy Pro+/Cloud) | π Standard || `agent_profile_assignments.json` | Agent profile assignments (Pro/legacy Pro+/Cloud) | π Standard || `profile-versions.json` | Agent profile version history (Pro/legacy Pro+/Cloud) | π Standard |@@ -43,6 +43,21 @@ Pulse uses a split-configuration model to ensure security and flexibility.| `ai_incidents.json` | AI incident tracking | π Standard || `org.json` | Organization metadata (multi-tenant) | π Standard |+### Handle configuration and history privately++**Standard does not mean safe to publish.** A `.json` filename is not a promise+of anonymisation or encryption. Findings can retain evidence and user notes;+Patrol history and legacy chat records can retain private infrastructure details,+conversation text and tool inputs/results. Host and guest notes can contain+private URLs and operator annotations too.++Keep these files, their backups and decrypted or exported copies private.+Encryption and file permissions do not redact a copy you open or share. For a+public report, use only the relevant, locally reviewed and redacted excerpt;+do not attach the configuration directory or whole history files. Follow the+[safe reporting guidance](TROUBLESHOOTING.md#-getting-help). Do not delete history,+reset keys or disable collection just to prepare a report.+Guest metadata entries are keyed by the canonical guest ID format `instance:node:vmid` (for example, `pve1:node1:100`). Legacy dash-separated keys are migrated automatically.Paths are relative to `/etc/pulse/` (Systemd) or `/data/` (Docker/Kubernetes) bydiff --git a/frontend-modern/public/docs/CONFIGURATION.md b/frontend-modern/public/docs/CONFIGURATION.mdindex 83d2a7ee12..12b9cef5b0 100644--- a/frontend-modern/public/docs/CONFIGURATION.md+++ b/frontend-modern/public/docs/CONFIGURATION.md@@ -17,15 +17,15 @@ Pulse uses a split-configuration model to ensure security and flexibility.| `sso.enc` | SAML/SSO provider config | π **Encrypted** || `api_tokens.json` | API token records (hashed) | π **Sensitive** || `ai.enc` | AI settings and credentials | π **Encrypted** |-| `ai_findings.json` | AI Patrol findings | π Standard |-| `ai_patrol_runs.json` | AI Patrol run history | π Standard |+| `ai_findings.json` | AI Patrol findings, evidence and user notes | π **Sensitive** |+| `ai_patrol_runs.json` | AI Patrol analysis and tool inputs/results | π **Sensitive** || `ai_usage_history.json` | AI usage history | π Standard |-| `ai_chat_sessions.json` | Legacy AI chat sessions (UI sync) | π Standard |+| `ai_chat_sessions.json` | Legacy conversations, usernames and tool inputs/results | π **Sensitive** || `license.enc` | Relay/Pro/legacy Pro+/Cloud license key | π **Encrypted** || `report_schedules.json` | Scheduled report definitions, recipients, and last-run metadata | π **Sensitive** (encrypted when data-dir encryption is enabled) |-| `host_metadata.json` | Host notes, tags, and AI command overrides | π Standard |+| `host_metadata.json` | Private host notes, URLs, tags and AI command overrides | π **Sensitive** || `docker_metadata.json` | Docker metadata cache | π Standard |-| `guest_metadata.json` | Guest notes and metadata | π Standard |+| `guest_metadata.json` | Private guest notes, URLs and remembered identity | π **Sensitive** || `agent_profiles.json` | Agent configuration profiles (Pro/legacy Pro+/Cloud) | π Standard || `agent_profile_assignments.json` | Agent profile assignments (Pro/legacy Pro+/Cloud) | π Standard || `profile-versions.json` | Agent profile version history (Pro/legacy Pro+/Cloud) | π Standard |@@ -43,6 +43,21 @@ Pulse uses a split-configuration model to ensure security and flexibility.| `ai_incidents.json` | AI incident tracking | π Standard || `org.json` | Organization metadata (multi-tenant) | π Standard |+### Handle configuration and history privately++**Standard does not mean safe to publish.** A `.json` filename is not a promise+of anonymisation or encryption. Findings can retain evidence and user notes;+Patrol history and legacy chat records can retain private infrastructure details,+conversation text and tool inputs/results. Host and guest notes can contain+private URLs and operator annotations too.++Keep these files, their backups and decrypted or exported copies private.+Encryption and file permissions do not redact a copy you open or share. For a+public report, use only the relevant, locally reviewed and redacted excerpt;+do not attach the configuration directory or whole history files. Follow the+[safe reporting guidance](TROUBLESHOOTING.md#-getting-help). Do not delete history,+reset keys or disable collection just to prepare a report.+Guest metadata entries are keyed by the canonical guest ID format `instance:node:vmid` (for example, `pve1:node1:100`). Legacy dash-separated keys are migrated automatically.Paths are relative to `/etc/pulse/` (Systemd) or `/data/` (Docker/Kubernetes) bydiff --git a/frontend-modern/src/features/docs/__tests__/configurationPrivacyGuide.test.ts b/frontend-modern/src/features/docs/__tests__/configurationPrivacyGuide.test.tsnew file mode 100644index 0000000000..d3b7fcded2--- /dev/null+++ b/frontend-modern/src/features/docs/__tests__/configurationPrivacyGuide.test.ts@@ -0,0 +1,64 @@+import { readFileSync } from 'node:fs';+import path from 'node:path';+import { describe, expect, it } from 'vitest';+import { createGuideFixture } from './guideFixture';++const read = (file: string) => readFileSync(path.resolve(process.cwd(), '..', file), 'utf8');+const article = createGuideFixture((name) => read(`frontend-modern/public/docs/${name}.md`));++describe('configuration and history privacy guidance', () => {+ it('identifies stored private content rather than treating it as ordinary settings', () => {+ const rows = [...article('CONFIGURATION').querySelectorAll('tbody tr')];+ for (const [file, content] of [+ ['ai_findings.json', 'evidence and user notes'],+ ['ai_patrol_runs.json', 'tool inputs/results'],+ ['ai_chat_sessions.json', 'usernames and tool inputs/results'],+ ['host_metadata.json', 'Private host notes, URLs'],+ ['guest_metadata.json', 'Private guest notes, URLs'],+ ]) {+ const cells = rows+ .find((row) => row.querySelector('td')?.textContent === file)+ ?.querySelectorAll('td');+ expect(cells, file).toHaveLength(3);+ expect(cells![1].textContent, file).toContain(content);+ expect(cells![2].textContent, file).toContain('Sensitive');+ expect(cells![2].textContent, file).not.toContain('Standard');+ }+ });++ it('distinguishes storage protection from safe public evidence without deleting recovery data', () => {+ const rendered = article('CONFIGURATION');+ const heading = rendered.querySelector('#handle-configuration-and-history-privately');+ expect(heading).not.toBeNull();+ const section = document.createElement('section');+ for (+ let node = heading!.nextElementSibling;+ node && node.tagName !== 'H2';+ node = node.nextElementSibling+ ) {+ section.appendChild(node.cloneNode(true));+ }+ const copy = section.textContent!.replace(/\s+/g, ' ');+ for (const distinction of [+ 'Standard does not mean safe to publish',+ 'not a promise of anonymisation or encryption',+ 'their backups and decrypted or exported copies private',+ 'Encryption and file permissions do not redact',+ 'locally reviewed and redacted excerpt',+ 'do not attach the configuration directory or whole history files',+ 'Do not delete history, reset keys or disable collection',+ ]) {+ expect(copy).toContain(distinction);+ }+ const help = section.querySelector('a[href="/docs/TROUBLESHOOTING#-getting-help"]');+ expect(help?.textContent).toBe('safe reporting guidance');+ expect(article('TROUBLESHOOTING').querySelector('#-getting-help')).not.toBeNull();+ expect(section.querySelector('pre')).toBeNull();+ });++ it('ships the same privacy guidance as the repository guide', () => {+ expect(read('frontend-modern/public/docs/CONFIGURATION.md')).toBe(+ read('docs/CONFIGURATION.md'),+ );+ });+});