diff --git a/docs/integrations/opnsense/img/administration_parameters.png b/docs/integrations/opnsense/img/administration_parameters.png new file mode 100644 index 00000000..a234a5a0 Binary files /dev/null and b/docs/integrations/opnsense/img/administration_parameters.png differ diff --git a/docs/integrations/opnsense/img/certificate_create_1.png b/docs/integrations/opnsense/img/certificate_create_1.png new file mode 100644 index 00000000..91d2e787 Binary files /dev/null and b/docs/integrations/opnsense/img/certificate_create_1.png differ diff --git a/docs/integrations/opnsense/img/certificate_create_2.png b/docs/integrations/opnsense/img/certificate_create_2.png new file mode 100644 index 00000000..4a263bd4 Binary files /dev/null and b/docs/integrations/opnsense/img/certificate_create_2.png differ diff --git a/docs/integrations/opnsense/index.mdx b/docs/integrations/opnsense/index.mdx index 9957871d..5172df9c 100644 --- a/docs/integrations/opnsense/index.mdx +++ b/docs/integrations/opnsense/index.mdx @@ -20,17 +20,59 @@ import { firewallWidget } from '../../widgets/firewall'; ### Widgets & Capabilities ### Adding the integration +#### 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 \ No newline at end of file + tabLabel: "ApiKey (Key & Secret)", + credentials: ['opnsenseApiKey', 'opnsenseApiSecret'], + steps: [], +}]} /> diff --git a/versioned_docs/version-1.31.0/integrations/opnsense/img/administration_parameters.png b/versioned_docs/version-1.31.0/integrations/opnsense/img/administration_parameters.png new file mode 100644 index 00000000..a234a5a0 Binary files /dev/null and b/versioned_docs/version-1.31.0/integrations/opnsense/img/administration_parameters.png differ diff --git a/versioned_docs/version-1.31.0/integrations/opnsense/img/certificate_create_1.png b/versioned_docs/version-1.31.0/integrations/opnsense/img/certificate_create_1.png new file mode 100644 index 00000000..91d2e787 Binary files /dev/null and b/versioned_docs/version-1.31.0/integrations/opnsense/img/certificate_create_1.png differ diff --git a/versioned_docs/version-1.31.0/integrations/opnsense/img/certificate_create_2.png b/versioned_docs/version-1.31.0/integrations/opnsense/img/certificate_create_2.png new file mode 100644 index 00000000..4a263bd4 Binary files /dev/null and b/versioned_docs/version-1.31.0/integrations/opnsense/img/certificate_create_2.png differ diff --git a/versioned_docs/version-1.31.0/integrations/opnsense/index.mdx b/versioned_docs/version-1.31.0/integrations/opnsense/index.mdx index 9957871d..bcecf256 100644 --- a/versioned_docs/version-1.31.0/integrations/opnsense/index.mdx +++ b/versioned_docs/version-1.31.0/integrations/opnsense/index.mdx @@ -28,9 +28,52 @@ import { firewallWidget } from '../../widgets/firewall'; ### Adding the integration +#### 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 \ No newline at end of file +}]} /> diff --git a/versioned_docs/version-1.31.0/widgets/firewall/img/firewall_widget.png b/versioned_docs/version-1.31.0/widgets/firewall/img/firewall_widget.png new file mode 100644 index 00000000..80f74f1b Binary files /dev/null and b/versioned_docs/version-1.31.0/widgets/firewall/img/firewall_widget.png differ diff --git a/versioned_docs/version-1.31.0/widgets/firewall/index.mdx b/versioned_docs/version-1.31.0/widgets/firewall/index.mdx index ac0657b5..790c40cb 100644 --- a/versioned_docs/version-1.31.0/widgets/firewall/index.mdx +++ b/versioned_docs/version-1.31.0/widgets/firewall/index.mdx @@ -20,9 +20,8 @@ import { opnsenseIntegration } from '../../integrations/opnsense'; ### Screenshots -:::note -Screenshots will follow soon. -::: +![Firewall Widget](img/firewall_widget.png) + ### Supported Integrations