42 lines
1.3 KiB
Plaintext
42 lines
1.3 KiB
Plaintext
---
|
|
title: "OPNsense"
|
|
description: "Open-source firewall and routing platform."
|
|
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 { opnsenseIntegration } from ".";
|
|
import { firewallWidget } from "../../widgets/firewall";
|
|
|
|
<IntegrationHeader integration={opnsenseIntegration} categories={["Firewall"]} />
|
|
|
|
### Widgets and capabilities
|
|
|
|
<IntegrationCapabilites items={[{ widget: firewallWidget }]} />
|
|
|
|
### Adding the integration
|
|
|
|
<AddingIntegration />
|
|
|
|
### Secrets
|
|
|
|
Use a dedicated API-only user with **Lobby: Dashboard** and **Reporting: Traffic** privileges.
|
|
|
|
<IntegrationSecrets
|
|
secrets={[
|
|
{
|
|
tabLabel: "API key and secret",
|
|
credentials: ["opnsenseApiKey", "opnsenseApiSecret"],
|
|
steps: [
|
|
"Under System → Access → Users, create a user with Scrambled Password enabled.",
|
|
"Grant Lobby: Dashboard and Reporting: Traffic privileges, then save the user.",
|
|
"Use the ticket action for that user and confirm the API key download.",
|
|
"Copy the downloaded key and secret into Homarr.",
|
|
],
|
|
},
|
|
]}
|
|
/>
|