Zenarmor Documentation Changes (#435)

pull/438/head
zenarmor 2 years ago committed by GitHub
parent af35265136
commit e764edd361
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -4,9 +4,8 @@ Zenarmor (Sensei): Hardware Requirements
Due to the nature of deep packet analysis and detailed drill-down reporting functionality, Zenarmor requires more hardware resources than a standard L3-L4 firewall.
**.. Note:: :**
**Note**
With the Sensei 1.5 release, you can offload your reporting database to an external system. This allows you to be able to run Zenarmor on systems with a constrained amount of RAM.
@ -18,7 +17,7 @@ CPU & Memory
Because the analytics module relies on Elasticsearch to process large amounts of data, the amount of the memory available in the system is crucial for the overall performance of Zenarmor.
**.. Tip:: :**
**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. 
@ -33,8 +32,8 @@ Below is the recommended minimum hardware requirements for Zenarmor based on the
250-1000 500 Mbps - 100 Kpps 32 GB Intel Quad-Core i7 3.4 GHz (4 Cores, 8 Threads) or equivalent
===================== ========================= ================== ======================================================================
**.. Note:: :**
**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.
-----------------
@ -61,4 +60,4 @@ If you're running a 100 Mbps link \(about 100 users\) which is quite active duri
6 GB x 7 days a week = 42 GB per week.
42 x 4 weeks a month = 164 GB per month.
As of `version 0.7.0 <https://www.sunnyvalley.io/blog/what-s-cooking-for-0-7>`_, Zenarmor expires old report data to free up disk space for the most recent data based on the configured number of days of history to keep.
As of `version 0.7.0 <https://www.sunnyvalley.io/docs/support/release-notes#07>`_, Zenarmor expires old report data to free up disk space for the most recent data based on the configured number of days of history to keep.

@ -2,9 +2,13 @@
Zenarmor (Sensei): Installing via Web Interface
==================================================
.. Note::
Zenarmor Free Edition is **forever free-of-charge**. We strongly recommend you register to keep in touch with updates and new features. You can register at `https://www.sunnyvalley.io/sensei <https://www.sunnyvalley.io/sensei>`_
**Note**
Zenarmor Free Edition is **forever free-of-charge**. We strongly recommend you register to keep in touch with updates and new features. You can register at `https://www.sunnyvalley.io/open-source-firewalls <https://www.sunnyvalley.io/open-source-firewalls>`_
Zenarmor may be installed using the web interface in OPNsense or using the command line interface via SSH or local system access (see :doc:`zenarmor_cmd_install`). The preferred method is the web interface because the process of installing plugins in OPNsense is simple and Zenarmor requires the use of the web interface to complete the initial configuration after installation.
@ -129,7 +133,7 @@ For detailed information on "Deployment Modes", `see here <https://www.sunnyval
The Cloud Threat Intelligence data is queried in real-time when any connections are made through your network. This capability enables Zenarmor to respond to malware and wireless outbreaks in real-time and very quickly.
The engine processes the request, queries the **“Sunny Valley Network (SVN) Cloud”** in real-time, and decides whether it will be blocked or allowed. Zenarmor checks against 140+ million websites under 120+ categories in milliseconds.
The engine processes the request, queries the **“Sunny Valley Network (SVN) Cloud”** in real-time, and decides whether it will be blocked or allowed. Zenarmor checks against 300+ million websites under 120+ categories in milliseconds.
Cloud Threat Intel settings let you:
@ -140,7 +144,7 @@ Cloud Threat Intel settings let you:
.. image:: images/zenarmor-wizard-cloud-reputation.png
:width: 100%
* Click :menuselection:`Next` to continue to the :menuselection:`Sensei CLI` section.
* Click :menuselection:`Next` to continue to the :menuselection:`Updates & Health Check section` section.
..........................
@ -195,4 +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/embed/lbaBySzc5OI" frameborder="0" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/watch?v=Hvz1qhNBZdo&t=2s" frameborder="0" allowfullscreen></iframe>

Loading…
Cancel
Save