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.

3.2 KB
Raw Blame
import type { HelpContent } from './types';
import { TROUBLESHOOTING_DOC_URL } from '@/utils/docsLinks';

/**
 * Help content for update-related features
 */
export const updatesHelpContent: HelpContent[] = [
  {
    id: 'updates.proxmox.access',
    title: 'Proxmox update-check access',
    description:
      "Pulse was denied access to this node's package-update list. Inventory and metrics use separate Proxmox permission checks, so they can still work.\n\n" +
      "Proxmox's update-list endpoint requires Sys.Modify on the node in current versions. This also permits refreshing package indexes, so it is broader than read-only monitoring.\n\n" +
      'You can keep read-only access and check updates in Proxmox. To show update counts in Pulse, review the requirements for your installed Proxmox version and the effective permissions of the exact user or token this connection uses.\n\n' +
      'A denied request does not identify the exact missing privilege or confirm that no updates are available.',
    docUrl: `${TROUBLESHOOTING_DOC_URL}#proxmox-pending-update-access`,
  },
  {
    id: 'updates.docker.notifications',
    title: 'Container Update Detection',
    description:
      'Pulse automatically detects when newer versions of your container images are available.\n\n' +
      'How it works:\n' +
      '- Compares local image digests against registry manifests\n' +
      '- Checks periodically without pulling full images\n' +
      '- Shows update badges on containers with available updates\n\n' +
      'Supported registries: Docker Hub, GitHub Container Registry (ghcr.io), ' +
      'and most private registries with v2 API support.',
    examples: [
      'Blue badge = Update available',
      'Hover the badge for version details',
      'Click container row for update instructions',
    ],
    addedInVersion: 'v3.0.0',
  },
  {
    id: 'updates.pulse.channel',
    title: 'Update Channel',
    description:
      'Choose which Pulse releases to be notified about:\n\n' +
      '- Stable: Production-ready releases only\n' +
      '- Preview: Beta user-testing builds and release candidates\n\n' +
      'Beta builds are expected to change after user feedback. A release candidate is a build that may become stable without product changes. Both can contain bugs, regressions, and migration issues. Use stable for production environments.\n\n' +
      'For major version previews (e.g. v6.5.0-beta.1), we strongly recommend installing ' +
      'as a separate instance rather than upgrading your production installation.',
    examples: [
      'stable - v6.4.0, v6.4.1, etc.',
      'preview - v6.5.0-beta.1, then v6.5.0-rc.1 when it is a release candidate',
    ],
    addedInVersion: 'v4.0.0',
  },
  {
    id: 'updates.docker.checkInterval',
    title: 'Docker Update Check Interval',
    description:
      'How often Pulse checks for container image updates.\n\n' +
      'More frequent checks catch updates sooner but increase registry API calls. ' +
      'Most registries have generous rate limits, but very frequent checks on many ' +
      'containers could hit limits.',
    examples: [
      '1 hour - Frequent updates, higher API usage',
      '6 hours - Balanced (recommended)',
      '24 hours - Conservative, minimal API usage',
    ],
    addedInVersion: 'v4.0.0',
  },
];