76 lines
2.4 KiB
Plaintext
76 lines
2.4 KiB
Plaintext
---
|
|
title: "OPNsense"
|
|
description: "OPNsense is an open-source, easy-to-use, and easy-to-build 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 { IconHeartRateMonitor } from "@tabler/icons-react";
|
|
import { opnsenseIntegration } from ".";
|
|
import Alert from "@theme/Admonition";
|
|
import { firewallWidget } from "../../widgets/firewall";
|
|
|
|
<IntegrationHeader integration={opnsenseIntegration} categories={["Firewall"]} />
|
|
|
|
### Widgets & Capabilities
|
|
|
|
<IntegrationCapabilites
|
|
items={[
|
|
{
|
|
widget: firewallWidget,
|
|
},
|
|
]}
|
|
/>
|
|
|
|
### Adding the integration
|
|
|
|
<AddingIntegration />
|
|
|
|
### Secrets
|
|
|
|
<IntegrationSecrets
|
|
secrets={[
|
|
{
|
|
tabLabel: "ApiKey (Key & Secret)",
|
|
credentials: ["opnsenseApiKey", "opnsenseApiSecret"],
|
|
header: (
|
|
<Alert type="info">
|
|
This integration does not require full API access to the firewall. The following guide outlines the process
|
|
for creating a restricted OPNsense user with a scrambled password, designed exclusively for API access. This
|
|
ensures minimal permissions and prevents local login capability.
|
|
</Alert>
|
|
),
|
|
steps: [
|
|
"Log in to the OPNsense web interface as an administrator",
|
|
"Navigate to System → Access → Users",
|
|
"Click the + (Add) button to create a new user",
|
|
<>
|
|
Fill in the user details:
|
|
<ul>
|
|
<li>Username: Enter a unique name</li>
|
|
<li>Password: Leave empty</li>
|
|
<li>Scrambled Password: Enable this option</li>
|
|
<li>Full name: (Optional) Add a descriptive name</li>
|
|
</ul>
|
|
</>,
|
|
<>
|
|
In Privileges section → Select the option below:
|
|
<ul>
|
|
<li>Lobby: Dashboard</li>
|
|
<li>Reporting: Traffic</li>
|
|
</ul>
|
|
</>,
|
|
"Click Save",
|
|
"Return to the Users list",
|
|
"Find the user and click the ticket icon in the Commands column",
|
|
"Click Yes in the popup to confirm",
|
|
"A txt file will download automatically, containing: Key and Secret",
|
|
"Save this file securely—this information will only be shown once",
|
|
],
|
|
},
|
|
]}
|
|
/>
|