---
title: "Proxmox"
description: "Virtual machines and containers managed by Proxmox VE."
hide_title: true
---

import { IntegrationHeader } from "@site/src/components/integrations/header";
import { IntegrationCapabilites } from "@site/src/components/integrations/widgets";
import { AddingIntegration } from "@site/src/components/integrations/adding";
import { IntegrationSecrets } from "@site/src/components/integrations/secrets";
import { proxmoxIntegration } from ".";
import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";

<IntegrationHeader integration={proxmoxIntegration} categories={["System monitoring"]} />

### Widgets and capabilities

<IntegrationCapabilites items={[{ widget: healthMonitoringWidget }]} />

### Adding the integration

<AddingIntegration />

### Secrets

Use a Proxmox VE (`pve`) user and API token with the `PVEAuditor` role at `/` and **Propagate** enabled. PAM
authentication may not work with the API.

<IntegrationSecrets
  secrets={[
    {
      credentials: ["username", "tokenId", "realm", "apiKey"],
      steps: [
        "Create a Proxmox VE user or group and grant PVEAuditor at / with Propagate enabled.",
        "Create an API token for that user. Disable privilege separation to inherit the user permission, or grant the token the same PVEAuditor permission.",
        "Copy the token secret when Proxmox displays it and enter the user, realm, token ID, and secret in Homarr.",
      ],
      body: (
        <p>
          For <code>api@pve!homarr</code>, use username <code>api</code>, realm <code>pve</code>, and token ID{" "}
          <code>homarr</code>.
        </p>
      ),
    },
  ]}
/>