Archives
/
opensense-docs
mirror of https://github.com/opnsense/docs
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Squashed commit of the following:

Browse Source 
commit 4fc58db7f361fca140119665107f562333ec416c
Author: Ad Schellevis <ad@opnsense.org>
Date:   Fri Apr 7 18:52:35 2023 +0200

    minor compile issue in https://github.com/opnsense/docs/pull/465

commit 5859bb84be40f20358549ec014f571e9c70858da
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Apr 4 17:08:55 2023 +0200

    troubleshooting : add webgui recovery help, ipsec: explain async crypto a bit better

commit b2189c500314e67607952fd8eae68ccea72a3e17
Author: Ad Schellevis <ad@opnsense.org>
Date:   Wed Mar 29 16:27:46 2023 +0200

    VPN/IPsec/Examples - add a note about connecting childre. closes https://github.com/opnsense/core/issues/6451

commit e0bb5a46fe8cd46334b3849503b29aa4c28a4ff2
Author: Ad Schellevis <ad@opnsense.org>
Date:   Wed Mar 29 14:26:56 2023 +0200

    changelogs

commit b002a92e8e2cbd202e23d823079a5c69aa8e4d5c
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 28 17:03:30 2023 +0200

    System/Settings/Administration - minor fixes

commit e6c02aa1864c1f229e33f2046272351f4a25ef8a
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 28 16:48:45 2023 +0200

    System/Settings/Administration - reorganise settings a bit and add missing options. Also explain the risks of using "listen interfaces" and how to properly use them. Loopbacks are intended to create the environment needed to reliably bind a service in a changing world.

commit 1fae5cc8a81fda2ba790c2e3cfc357f46f2c6d8b
Author: Stephan <stephan.de.wit@deciso.com>
Date:   Tue Mar 28 16:24:13 2023 +0200

    unbound: update reporting/advanced/blocklist documentation

commit 8ffa3e1565bff8b8ffb986d7dd447e7f5371805f
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 28 08:58:44 2023 +0200

    update api endpoints

commit 07f9f614b6fa49847bd78b013d8c664c3ac50940
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 28 08:56:00 2023 +0200

    changelogs

commit f234f235b404a25e7b9af8ca27796369b53a0277
Author: Ad Schellevis <ad@opnsense.org>
Date:   Mon Mar 27 17:38:49 2023 +0200

    Access / Servers / Radius - add mnissing options

commit f6fc23f09ea2ec3b626f07ab92bac7b2e04e0001
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 21 16:57:03 2023 +0100

    changelogs

commit 831b0d54a209b13c54e9f4272a705d198cab86b2
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 21 16:36:02 2023 +0100

    IPS: change Emerging Threats documentation links

commit 1ed441a7fcce20a33d5c9eaccc0d63af663b9332
Author: Ad Schellevis <ad@opnsense.org>
Date:   Fri Mar 17 15:30:16 2023 +0100

    Interfaces: Diagnostics: Ping - update documentation, closes https://github.com/opnsense/core/issues/6378

commit f7e4ee76c158f2a0b73ae5a74c77ecb451b5dbd7
Author: Ad Schellevis <ad@opnsense.org>
Date:   Thu Mar 16 21:59:34 2023 +0100

    Interfaces: Diagnostics: Ping - documentation for https://github.com/opnsense/core/issues/6378

commit 82e2801b67
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Apr 7 00:21:10 2023 +0300

    Update zenarmor_hardwarerequirements.rst

    Hardware Requirements content updated

commit 72e65f07e3
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Thu Apr 6 15:51:35 2023 +0300

    Update zenarmor_hardwarerequirements.rst

    HW req. Table Updated

commit 2d8e780e62
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:49:39 2023 +0300

    Update zenarmor.rst

commit 59cde54661
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:43:18 2023 +0300

    Update zenarmor_install.rst

commit 13a60a4564
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:38:36 2023 +0300

    Update zenarmor.rst

commit 9fd1a80b34
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:35:54 2023 +0300

    Update zenarmor.rst

commit 5f08f24b5f
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:28:47 2023 +0300

    Update zenarmor.rst

commit 29e34ff9c2
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:33:23 2023 +0300

    Update zenarmor_install.rst

commit b4e97197f1
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:28:16 2023 +0300

    Update zenarmor.rst

commit 4b36e1f03e
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:21:25 2023 +0300

    Update zenarmor.rst

commit a20fd312d0
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:16:38 2023 +0300

    Update zenarmor.rst

commit 647a134479
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:16:11 2023 +0300

    Update zenarmor.rst

    Feature list is updated

commit b573a10a2d
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:12:12 2023 +0300

    Update zenarmor.rst

    Youtube URL Updated

commit e9d2a63c00
Merge: e132115 f3c6e5b
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:10:46 2023 +0300

    Merge branch 'opnsense:master' into master

commit e132115879
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Mon Nov 7 15:32:39 2022 +0300

    Update zenarmor_install.rst

commit e348b92a5b
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Mon Nov 7 15:25:03 2022 +0300

    Update zenarmor_install.rst

commit 0709b7a09a
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Nov 4 15:41:44 2022 +0300

    Update zenarmor_install.rst

commit b64a2e497b
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Nov 4 15:38:05 2022 +0300

    Update zenarmor_install.rst

commit 3f660a01e8
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Nov 4 15:16:46 2022 +0300

    Update zenarmor_hardwarerequirements.rst

commit 2d3883035d
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Nov 4 15:04:34 2022 +0300

    Update zenarmor_hardwarerequirements.rst
pull/468/head
Ad Schellevis 1 year ago
parent c2a0c3426c
commit 18b58b320a
3 changed files with 42 additions and 27 deletions
Show Stats Download Patch File Download Diff File

50
source/vendor/sunnyvalley/zenarmor.rst vendored
Unescape Escape View File

@ -5,11 +5,13 @@ Zenarmor (Sensei): Overview
About
----------------------------
Zenarmor is a plugin for the OPNsense firewall which provides state-of-the-art next generation features. If you are running a L4 firewall (all open source firewalls fall into this category) and looking for features like Application Control, Network Analytics and TLS Inspection, Zenarmor is the product you're looking for.
Zenarmor is a plugin for the OPNsense firewall which provides state-of-the-art next generation features. Zenarmor is developed by Sunny Valley Networks (https://www.sunnyvalley.io)
If you are running a L4 firewall (all open source firewalls fall into this category) and looking for features like Application Control, Network Analytics and TLS Inspection, Zenarmor is the product you're looking for.
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/embed/VQ7tlMUNPYA" frameborder="0" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/watch?v=IMKLO_LHbAY" frameborder="0" allowfullscreen></iframe>
----------------------------
Features
@ -20,11 +22,18 @@ Zenarmor empowers your firewall with the following next generation features:
1. Application Control
2. Cloud Application Control \(Web 2.0 Controls\)
3. Advanced Network Analytics
4. All-ports full TLS Inspection \(for every TCP port, not just HTTPS\)
4. Web Filtering & Security
5. Cloud Threat Intelligence
6. Encrypted Threats Prevention
7. Web Filtering & Security
8. Active Directory Integration
6. User-based Filtering and Reporting
7. Active Directory Integration
8. RESTful API
9. Cloud based centralized management & Reporting
10. Application / Web category based Traffic Shaping and Prioritization
11. Policy based filtering and QoS
12. Encrypted Threats Prevention
13. All-ports full TLS Inspection \(for every TCP port, not just HTTPS\) *Coming soon*
----------------------------
Getting Started
@ -38,15 +47,15 @@ Getting Started
User Manual
----------------------------
You can get detailed *How to* documents from Zenarmor's Documentation Site located at https://help.sunnyvalley.io/
You can get detailed *How to* documents from Zenarmor's Documentation Site located at https://www.zenarmor.com/docs/opnsense
* `Dashboard <https://www.sunnyvalley.io/docs/opnsense/customizing-dashboard/dashboard>`_
* `Status <https://www.sunnyvalley.io/docs/opnsense/customizing-dashboard/status>`_
* `Reports <https://www.sunnyvalley.io/docs/opnsense/reporting-analytics/reports-overview>`_
* `Security <https://www.sunnyvalley.io/docs/opnsense/policies/security-rules>`_
* `Application Control <https://www.sunnyvalley.io/docs/opnsense/policies/application-control-rules>`_
* `Web Control <https://www.sunnyvalley.io/docs/opnsense/policies/web-control-rules>`_
* `Configuration <https://www.sunnyvalley.io/docs/opnsense/configuring/overview>`_
* `Dashboard <https://www.zenarmor.com/docs/opnsense/customizing-dashboard/dashboard>`_
* `Status <https://www.zenarmor.com/docs/opnsense/customizing-dashboard/status>`_
* `Reports <https://www.zenarmor.com/docs/opnsense/reporting-analytics/reports-overview>`_
* `Security <https://www.zenarmor.com/docs/opnsense/policies/security-rules>`_
* `Application Control <https://www.zenarmor.com/docs/opnsense/policies/application-control-rules>`_
* `Web Control <https://www.zenarmor.com/docs/opnsense/policies/web-control-rules>`_
* `Configuration <https://www.zenarmor.com/docs/opnsense/configuring/overview>`_
----------------------------
Getting Support
@ -58,7 +67,7 @@ If you need help with Zenarmor, there is an active discussion on the OPNsense fo
You may also submit bug reports by visiting the *Report Bug* page in the Zenarmor web UI.
With its in-depth coverage, `Zenarmor Documentation <https://www.sunnyvalley.io/docs/opnsense>`_ is always available for reference.
With its in-depth coverage, `Zenarmor Documentation <https://www.zenarmor.com/docs/opnsense>`_ is always available for reference.
* `OPNsense Forum <https://forum.opnsense.org/index.php?board=38.0>`_
* `Users' Manual <https://www.sunnyvalley.io/docs/opnsense>`_
@ -72,10 +81,15 @@ When you buy a Zenarmor Premium Subscription, you are entitled to Zenarmor Basic
**Support Options for Channel Partners**
Sunny Valley Networks provides Tier 3 Support Options for Zenarmor Channel Partners. To learn more about them, please contact **sensei-partnership -at- sunnyvalley.io** .
Sunny Valley Networks provides Tier 3 Support Options for Zenarmor Channel Partners. To learn more about them, please contact **sensei-partnership -at- sunnyvalley.io**.
To become a partner, you may apply for partnership via https://www.sunnyvalley.io/apply-partnership .
**Connect via Social Media**
**Connect via Social Media or Websites**
* **Twitter**: `@sunnyvalley <https://twitter.com/sunnyvalley>`_
* **Youtube**: `Sunny Valley Networks Hands-on videos <https://www.youtube.com/channel/UCBmMJAnuUW5qxAN23kLPuPA>`_
* **Youtube**: `Sunny Valley Networks Hands-on videos <https://www.youtube.com/@zenarmor>`_
* **Company Website**: https://www.sunnyvalley.io
* **Product Website**: https://www.zenarmor.com
* **Zenconsole Cloud Management Portal**: https://dash.zenarmor.com
* **Sunny Valley Blog**: https://sunnyvalley.io/blog/

15
source/vendor/sunnyvalley/zenarmor_hardwarerequirements.rst vendored
Unescape Escape View File

@ -19,22 +19,23 @@ Because the analytics module relies on Elasticsearch to process large amounts of
**Tip**
If the number of active devices are more than 250 and the sustained WAN bandwidth is higher than 100 Mbps, we do not recommend deploying Zenarmor as a virtual guest since resources in virtual environments are generally shared between guest systems. 
If the number of active devices are more than 500 and the sustained WAN bandwidth is higher than 500 Mbps, we do not recommend deploying Zenarmor as a virtual guest since resources in virtual environments are generally shared between guest systems.
Below is the recommended minimum hardware requirements for Zenarmor based on the number of devices and the amount of sustained bandwidth:
===================== ========================= ================== ======================================================================
**# Active Devices** **Maximum WAN Bandwidth** **Minimum Memory** **Minimum CPU**
0-25 50 Mbps 4 GB A Dual-Core CPU (x86_64 compatible, single core PassMark score of 200)
25-50 150 Mbps - 10 Kpps 4 GB Intel Dual-Core i5 2.0 GHz (2 Cores, 4 Threads) or equivalent
50-100 200 Mbps - 20 Kpps 8 GB Intel Dual-Core i5 2.2 GHz (2 Cores, 4 Threads) or equivalent
100-250 300 Mbps - 40 Kpps 16 GB Intel Dual-Core i5 3.2 GHz (2 Cores, 4 Threads) or equivalent
250-1000 500 Mbps - 100 Kpps 32 GB Intel Quad-Core i7 3.4 GHz (4 Cores, 8 Threads) or equivalent
0-50 300 Mbps 1 GB A Dual-Core CPU (x86_64 compatible, single core PassMark score of 200)
50-100 500 Mbps - 10 Kpps 4 GB Intel Dual-Core i3 2.0 GHz (2 Cores, 4 Threads) or equivalent
100-250 1 Gbps - 20 Kpps 8 GB Intel Dual-Core i5 2.2 GHz (2 Cores, 4 Threads) or equivalent
250-1000 1-2 Gbps 40 Kpps 16 GB Intel Dual-Core i5 3.20 GHz (2 Cores, 4 Threads) or equivalent
1000-2000 1-2 Gbps 32 GB Intel Quad-Core i7 3.40 GHz (4 Cores, 8 Threads) or equivalent
2000+ 2-4.5 Gbps 64 GB Intel Quad-Core i9 3.0 GHz (24 Cores, 48 Threads) or equivalent
===================== ========================= ================== ======================================================================
**Note**
Zenarmor requires at least 2 GB of memory. The installer will not continue if you have less than 2 GB of RAM. We recommend 4 GB memory to have an improved experience.
Zenarmor requires at least 1 GB of memory. Installer will not continue if you have less than 1 GB of RAM. We recommend 8 GB memory to have an exceptional reporting experience with elasticsearch database.
-----------------
Ethernet Adapter

4
source/vendor/sunnyvalley/zenarmor_install.rst vendored
Unescape Escape View File

@ -117,7 +117,7 @@ Your hardware will be analyzed to ensure it meets the minimum requirements. You
* Select the Ethernet Interface(s) to protect. To do so, click on an interface and use the right/left arrow buttons to move it to protected/unprotected interfaces combo box.
For detailed information on "Deployment Modes", `see here <https://www.sunnyvalley.io/docs/guides/deployment-modes>`_. 
For detailed information on "Deployment Modes", see `here <https://www.zenarmor.com/docs/guides/deployment-modes>`_. 
.. image:: images/zenarmor-wizard-interface-selection-available.png
:width: 100%
@ -199,5 +199,5 @@ Zenarmor may support up to 1,000 concurrent users on an average PC. You can set
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/watch?v=Hvz1qhNBZdo&t=2s" frameborder="0" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/watch?v=Hvz1qhNBZdo" frameborder="0" allowfullscreen></iframe>

Write Preview
Loading…
Cancel
Save