Skip to content

Feat: OPNsense integration #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 49 additions & 7 deletions docs/integrations/opnsense/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,59 @@ import { firewallWidget } from '../../widgets/firewall';

### Widgets & Capabilities
<IntegrationCapabilites
items={[{
widget: firewallWidget,
}]}
items={[{
widget: firewallWidget,
}]}
/>

### Adding the integration
<AddingIntegration />

#### Using HTTPS to access your firewall

If you are using HTTPS to access your firewall, you must add the certificate to Homarr before adding the integration

Moreover, if you are accessing your firewall through its IP address, you also need to generate a custom certificate that includes the IP address you access it with.

go to System -> Trust -> Certificates in the dashboard.

Create a new certificate
![New certificate](img/certificate_create_1.png)

Method : Create an internal certificate


Description : what ever you like, but something meaningful

Type : Server Certificate

Private Key Location : Save on this firewall

Key type : RSA 4096

Digest Algorithm : SHA 512

Country code : Your Country

DNS domain names : any DNS name you are using to access your OPNsense firewall

![Alternatives names](img/certificate_create_2.png)

IP addresses : the IP address you access your firewall with

When everything seems good, click save to generate the certificate

Now head out to System -> Settings -> Administration

![Web GUI parameters](img/administration_parameters.png)

Click on the select box next to Certificates and select the previously created certificate

When you save this parameter, you'll probably have to refresh the web page to redeem access to your firewall.

### Secrets
<IntegrationSecrets secrets={[{
tabLabel: "ApiKey (Key & Secret)",
credentials: ['opnsenseApiKey', 'opnsenseApiSecret'],
steps: [],
}]} />
tabLabel: "ApiKey (Key & Secret)",
credentials: ['opnsenseApiKey', 'opnsenseApiSecret'],
steps: [],
}]} />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 44 additions & 1 deletion versioned_docs/version-1.31.0/integrations/opnsense/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,52 @@ import { firewallWidget } from '../../widgets/firewall';
### Adding the integration
<AddingIntegration />

#### Using HTTPS to access your firewall

If you are using HTTPS to access your firewall, you must add the certificate to Homarr before adding the integration

Moreover, if you are accessing your firewall through its IP address, you also need to generate a custom certificate that includes the IP address you access it with.

go to System -> Trust -> Certificates in the dashboard.

Create a new certificate

![New certificate](img/certificate_create_1.png)

Method : Create an internal certificate


Description : what ever you like, but something meaningful

Type : Server Certificate

Private Key Location : Save on this firewall

Key type : RSA 4096

Digest Algorithm : SHA 512

Country code : Your Country

DNS domain names : any DNS name you are using to access your OPNsense firewall

![Alternatives names](img/certificate_create_2.png)

IP addresses : the IP address you access your firewall with

When everything seems good, click save to generate the certificate

Now head out to System -> Settings -> Administration

![Web GUI parameters](img/administration_parameters.png)

Click on the select box next to Certificates and select the previously created certificate

When you save this parameter, you'll probably have to refresh the web page to redeem access to your firewall.

### Secrets
<IntegrationSecrets secrets={[{
tabLabel: "ApiKey (Key & Secret)",
credentials: ['opnsenseApiKey', 'opnsenseApiSecret'],
steps: [],
}]} />
}]} />
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 2 additions & 3 deletions versioned_docs/version-1.31.0/widgets/firewall/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,8 @@ import { opnsenseIntegration } from '../../integrations/opnsense';

### Screenshots

:::note
Screenshots will follow soon.
:::
![Firewall Widget](img/firewall_widget.png)


### Supported Integrations

Expand Down