108 lines
3.5 KiB
Plaintext
108 lines
3.5 KiB
Plaintext
---
|
|
title: "Proxmox"
|
|
description: "Proxmox is a powerful open-source virtualization platform that allows you to run virtual machines and containers."
|
|
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 { IconHeartRateMonitor } from "@tabler/icons-react";
|
|
import { proxmoxIntegration } from ".";
|
|
import Alert from "@theme/Admonition";
|
|
import { healthMonitoringWidget } from "@site/docs/widgets/health-monitoring";
|
|
import { systemResourcesWidget } from "@site/docs/widgets/system-resources";
|
|
|
|
<IntegrationHeader integration={proxmoxIntegration} categories={["System monitoring"]} />
|
|
|
|
### Widgets & Capabilities
|
|
|
|
<IntegrationCapabilites items={[{ widget: healthMonitoringWidget }]} />
|
|
|
|
### Adding the integration
|
|
|
|
<AddingIntegration />
|
|
|
|
### Secrets
|
|
|
|
<IntegrationSecrets
|
|
secrets={[
|
|
{
|
|
header: (
|
|
<Alert type="caution">
|
|
The Proxmox API may not work with Linux PAM standard authentication. It is strongly recommended to use the
|
|
Proxmox VE authentication server realm when creating your API user.
|
|
</Alert>
|
|
),
|
|
credentials: ["username", "tokenId", "realm", "apiKey"],
|
|
steps: [
|
|
"Navigate to the Proxmox portal, click on Datacenter",
|
|
"Expand Permissions, click on Groups",
|
|
"Click the Create button",
|
|
"Name the group something informative, like api-users",
|
|
"Click on the Permissions 'folder'",
|
|
<>
|
|
Click Add {"->"} Group Permission
|
|
<ul>
|
|
<li>Path: /</li>
|
|
<li>Group: group from Step 4 above</li>
|
|
<li>Role: PVEAuditor</li>
|
|
<li>Propagate: Checked</li>
|
|
</ul>
|
|
</>,
|
|
"Expand Permissions, click on Users",
|
|
<>
|
|
Click the Add button
|
|
<ul>
|
|
<li>User name: something informative like api</li>
|
|
<li>Realm: Proxmox VE authentication server</li>
|
|
<li>Password: create a secure password for the user</li>
|
|
<li>Confirm Password: re-enter the password</li>
|
|
<li>Group: group from Step 4 above</li>
|
|
</ul>
|
|
</>,
|
|
"Expand Permissions, click on API Tokens",
|
|
<>
|
|
Click the Add button
|
|
<ul>
|
|
<li>User: user from Step 8 above</li>
|
|
<li>Token ID: something informative like the application or purpose like homarr</li>
|
|
<li>Privilege Separation: unchecked</li>
|
|
</ul>
|
|
</>,
|
|
"Copy the Secret that is shown in Step 10 because it is only shown once",
|
|
"Go back to the 'Permissions' menu",
|
|
<>
|
|
Click Add {"->"} API Token Permission
|
|
<ul>
|
|
<li>Path: /</li>
|
|
<li>API Token: select the API token created in Step 10</li>
|
|
<li>Role: PVE Auditor</li>
|
|
<li>Propagate: Checked</li>
|
|
</ul>
|
|
</>,
|
|
],
|
|
body: (
|
|
<>
|
|
<span>
|
|
Sometimes you'll also find the <code>api@pve!homarr</code> format, within Homarr you'll have to split it up
|
|
into:
|
|
</span>
|
|
<ul>
|
|
<li>
|
|
<b>Username:</b> api
|
|
</li>
|
|
<li>
|
|
<b>Realm:</b> pve
|
|
</li>
|
|
<li>
|
|
<b>Token ID:</b> homarr
|
|
</li>
|
|
</ul>
|
|
</>
|
|
),
|
|
},
|
|
]}
|
|
/>
|