gitea-mirror/Pulse
1
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-02-18 00:17:39 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
2b48b0a459ee5379805cdb0eb69b978f5ed820a9
Pulse/docs/MAIL_GATEWAY.md
rcourtman 2b48b0a459 feat: add --kube-include-all-deployments flag for Kubernetes agent 
Adds IncludeAllDeployments option to show all deployments, not just
problem ones (where replicas don't match desired). This provides parity
with the existing --kube-include-all-pods flag.

- Add IncludeAllDeployments to kubernetesagent.Config
- Add --kube-include-all-deployments flag and PULSE_KUBE_INCLUDE_ALL_DEPLOYMENTS env var
- Update collectDeployments to respect the new flag
- Add test for IncludeAllDeployments functionality
- Update UNIFIED_AGENT.md documentation

Addresses feedback from PR #855
2025-12-18 20:58:30 +00:00

2.8 KiB
Raw Blame History

Proxmox Mail Gateway (PMG) Monitoring

Pulse 5.0 adds support for monitoring Proxmox Mail Gateway instances alongside your PVE and PBS infrastructure.

Features

  • Mail Queue Monitoring: Track active, deferred, and held messages
  • Spam Statistics: View spam detection rates and virus blocks
  • Cluster Status: Monitor PMG cluster node health
  • Quarantine Overview: See quarantine size and pending reviews

Adding a PMG Instance

Via Settings UI

  1. Navigate to Settings → Proxmox
  2. Click Add Node
  3. Select Proxmox Mail Gateway as the type
  4. Enter connection details:
    • Host: Your PMG IP or hostname
    • Port: 8006 (default)
    • API Token ID: e.g., root@pmg!pulse (format: <user>@<realm>!<token-id>)
    • API Token Secret: Your token secret (shown once when you create the token)

Via Discovery

Pulse can automatically discover PMG instances on your network:

  1. Enable discovery in Settings → System → Network
  2. Go to Settings → Proxmox
  3. PMG instances on port 8006 are detected and shown in the Proxmox discovery panels
  4. Click a discovered PMG server to add it

API Token Setup on PMG

Create an API token on your PMG server (recommended). The easiest method is via the PMG web UI:

  • Create a token for a user (for example root@pmg)
  • Copy the token secret when it is displayed (it is typically shown once)

If you see 403/permission errors, start by testing with a token for an admin user to confirm connectivity, then tighten permissions once you know which PMG endpoints your instance requires.

Dashboard

The Mail Gateway tab shows:

Metric Description
Mail Processed Total emails processed today
Spam Rate Percentage of spam detected
Virus Blocked Malicious emails caught
Queue Depth Messages pending delivery
Quarantine Size Emails in quarantine

Status Indicators

  • 🟢 Healthy: Normal operation
  • 🟡 Warning: Queue building up or high spam rate
  • 🔴 Critical: Delivery issues or cluster problems

Alerts

Configure alerts for PMG metrics in Settings → Alerts:

  • Queue depth exceeding threshold
  • Spam rate spike
  • Delivery failures
  • Cluster node offline

Multi-Instance Support

Monitor multiple PMG instances from a single Pulse dashboard:

  • Compare spam rates across gateways
  • Aggregate mail statistics
  • View cluster-wide health

Troubleshooting

Connection refused

  1. Verify PMG is accessible on port 8006
  2. Check firewall rules
  3. Ensure API token has correct permissions

No statistics showing

  1. Wait for initial data collection (may take 1-2 polling cycles)
  2. Verify PMG has mail activity
  3. Check Pulse logs for API errors

Cluster nodes missing

  1. PMG cluster must be properly configured
  2. API token needs cluster-wide permissions
  3. All nodes must be reachable from Pulse