Squashed commit of the following:

commit 1cb2aa290825df0d38b40f33173655c418c1f3ae
Merge: bfa4669 c6c1fab
Author: Ad Schellevis <ad@opnsense.org>
Date:   Mon Nov 29 20:57:04 2021 +0100

    Merge branch 'add-zenarmor-changes' of https://github.com/opensourcecontribution/docs into opensourcecontribution-add-zenarmor-changes

commit c6c1fab381
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:36:01 2021 +0300

    Update zenarmor_install.rst

commit 0b1d51f71b
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:34:27 2021 +0300

    New Version

commit 88964f6791
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:33:50 2021 +0300

    old version

commit b12bfeb963
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:10:33 2021 +0300

    new version

commit bd6d5a6018
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:10:04 2021 +0300

    old version

commit 7aebd2c7f1
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:09:35 2021 +0300

    new version

commit 76040718d7
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:08:43 2021 +0300

    old version

commit 9760b7f27e
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:08:26 2021 +0300

    New version

commit ccb6933f40
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:07:25 2021 +0300

    old version

commit 5923bd6dc6
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:07:08 2021 +0300

    New version

commit f60df39010
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:06:42 2021 +0300

    old file

commit 98c3d29c9f
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:06:21 2021 +0300

    New file

commit 9b0937d518
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Mon Nov 29 20:04:34 2021 +0300

    old file

commit 3f0811c267
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 03:24:27 2021 +0300

    remote-db-new

commit b890f43458
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 03:23:57 2021 +0300

    remote-db-old

commit 27da697158
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 03:18:54 2021 +0300

    low-end-db-new

commit 3907673dfd
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 03:18:26 2021 +0300

    low-end-db-old

commit 8930c10062
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 03:10:07 2021 +0300

    high-end-new

commit 842e5d68d2
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 03:09:31 2021 +0300

    high-end-old

commit 1c5640eda4
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 02:18:03 2021 +0300

    incompetable_new

commit d42ee3255b
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 02:17:06 2021 +0300

    old ss

commit 5ae9b8e7c0
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 02:12:06 2021 +0300

    low-end-new

commit 5f5303d7ed
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 02:11:25 2021 +0300

    low-end-old

commit 7e981cd216
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 02:09:22 2021 +0300

    Welcome

commit ba5582b694
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 02:04:26 2021 +0300

    low-end-new

commit 46cc0f6939
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 02:03:58 2021 +0300

    Changed

commit 89838fca16
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 01:58:42 2021 +0300

    warning1

commit 3b80e5a0dc
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 01:57:15 2021 +0300

    warning

commit ccc0667c1b
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Sat Nov 27 01:55:52 2021 +0300

    warning

commit 1da39b8ab7
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:45:28 2021 +0300

    incompatible-new png

commit e313b32400
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:45:01 2021 +0300

    old

commit eb4d2db73b
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:42:15 2021 +0300

    low-end-new

commit 4156bdb12d
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:41:19 2021 +0300

    old

commit 83f89bfc9f
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:37:53 2021 +0300

    highend

commit bd6823fe8c
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:36:45 2021 +0300

    old

commit 397dc3f5ab
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:34:56 2021 +0300

    wellcome

commit 6368c04576
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:33:55 2021 +0300

    Proceed button

commit 0145ae5d3a
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:30:36 2021 +0300

    wellcome png updated

commit f02d1701da
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:29:36 2021 +0300

    old f

commit a4d462177d
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:26:22 2021 +0300

    new ss added

commit 8cfed6399a
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:25:35 2021 +0300

    old file

    Renewed

commit b537a7ac27
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:23:35 2021 +0300

    install-complete ss

commit e6274174c7
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:21:58 2021 +0300

    old file

commit 6c1ef618a3
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:02:48 2021 +0300

    Version changed

commit 4c7452293c
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:01:58 2021 +0300

    Update zenarmor_hardwarerequirements.rst

commit 850623a939
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:01:29 2021 +0300

    Note

commit 8daf8767b7
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 20:00:51 2021 +0300

    test

commit 2801dc3b6b
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:58:57 2021 +0300

    test

commit ccb8183aa4
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:56:39 2021 +0300

    note

commit fa6d93f7e2
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:56:15 2021 +0300

    test

commit 326be3d44d
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:55:42 2021 +0300

    frame

commit 6ba1ebc0ee
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:52:47 2021 +0300

    : added

commit 45b7e8429e
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:51:51 2021 +0300

    bold

commit 9281ba0021
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:51:22 2021 +0300

    tip bolded

commit e77ddb41a6
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:50:27 2021 +0300

    tip made bold

commit 6af9e54f5b
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:49:52 2021 +0300

    reverted back

commit 1526f96273
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:48:50 2021 +0300

    tip and note bold

commit d84b631293
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:46:33 2021 +0300

    zenarmor-cli-install png added

commit 56bb8cabba
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:45:00 2021 +0300

    old file

commit ff83d0ae70
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:44:27 2021 +0300

    zenarmor-cli-install png addded

commit e9de3849e7
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:41:57 2021 +0300

    getzenarmor code added

commit 192c51e06d
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:40:15 2021 +0300

    suppor plan changed

commit dc5c8cfc55
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:36:48 2021 +0300

    old file

commit 006513bb5c
Author: opensourcecontribution <84644663+opensourcecontribution@users.noreply.github.com>
Date:   Fri Nov 26 19:36:02 2021 +0300

    Old file

commit a244155b2e
Author: Alex <alex@sunnyvalley.io>
Date:   Tue Nov 23 01:14:44 2021 +0300

    sensei changed as zenarmor
pull/368/head
Ad Schellevis 3 years ago
parent bfa466904d
commit 66793d2094

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 129 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

@ -0,0 +1 @@
zenarmor-wizard-interface-selection-available

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

@ -0,0 +1 @@
zenarmor-wizard-reporting-database-high-end

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

@ -1,11 +1,11 @@
===================
Sensei: Overview
Zenarmor (Sensei): Overview
===================
----------------------------
About
----------------------------
Sensei 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, Sensei is the product you're looking for.
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.
.. raw:: html
@ -15,7 +15,7 @@ Sensei is a plugin for the OPNsense firewall which provides state-of-the-art nex
Features
----------------------------
Sensei empowers your firewall with the following next generation features:
Zenarmor empowers your firewall with the following next generation features:
1. Application Control
2. Cloud Application Control \(Web 2.0 Controls\)
@ -30,16 +30,15 @@ Sensei empowers your firewall with the following next generation features:
Getting Started
----------------------------
- :doc:`sensei_hardwarerequirements`
- :doc:`sensei_install`
- :doc:`sensei_cmd_install`
- :doc:`zenarmor_hardwarerequirements`
- :doc:`zenarmor_install`
- :doc:`zenarmor_cmd_install`
----------------------------
User Manual
----------------------------
You can get detailed *How to* documents from Sensei's Documentation Site located at https://www.sunnyvalley.io/docs/
You can get detailed *How to* documents from Zenarmor's Documentation Site located at https://help.sunnyvalley.io/
* `Dashboard <https://www.sunnyvalley.io/docs/opnsense/customizing-dashboard/dashboard>`_
* `Status <https://www.sunnyvalley.io/docs/opnsense/customizing-dashboard/status>`_
@ -55,27 +54,25 @@ Getting Support
**Support for Free Edition**
If you need help with Sensei, there is an active discussion on the OPNsense forum. Feel free to `click here <https://forum.opnsense.org/index.php?board=38.0>`_ to join the conversation.
You may also submit bug reports by visiting the *Report Bug* page in the Sensei web UI.
If you need help with Zenarmor, there is an active discussion on the OPNsense forum. Feel free to `click here <https://forum.opnsense.org/index.php?board=38.0>`_ to join the conversation.
You may also submit bug reports by visiting the *Report Bug* page in the Zenarmor web UI.
With its in-depth coverage, `Sensei Documentation <https://www.sunnyvalley.io/docs/opnsense>`_ is always available for reference.
With its in-depth coverage, `Zenarmor Documentation <https://www.sunnyvalley.io/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>`_
**Premium Subscription Support**
When you buy a Sensei Premium Subscription, you are entitled to Sensei Basic Support. Additional support plans are available on demand.
When you buy a Zenarmor Premium Subscription, you are entitled to Zenarmor Basic Support. Additional support plans are available on demand.
* `Compare Support Plans <https://www.sunnyvalley.io/support-plans/>`_
* `Compare Support Plans <https://www.sunnyvalley.io/support-plans>`_
* `Access Support Center <https://help.sunnyvalley.io/hc/en-us>`_
**Support Options for Channel Partners**
Sunny Valley Networks provides Tier 3 Support Options for Sensei 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** .
**Connect via Social Media**

@ -1,8 +1,8 @@
===================================
Sensei: Installing via Command Line
Zenarmor (Sensei): Installing via Command Line
===================================
Although the preferred method of installation is the web interface, Sensei may also be installed using the command line interface via SSH or direct system access. Once Sensei is installed, you will need to complete the initial configuration using the web interface.
Although the preferred method of installation is the web interface, Zenarmor may also be installed using the command line interface via SSH or direct system access. Once Zenarmor is installed, you will need to complete the initial configuration using the web interface.
To install Sensei in OPNsense with the command line interface, you must use an administrative account with shell access.
@ -10,9 +10,9 @@ To install Sensei in OPNsense with the command line interface, you must use an a
Command Line Installation
-------------------------
The command line installation method was the primary means for installing Sensei before it was officially available on the “Plugins” page in the OPNsense web interface. This option is still available for users who have direct access to the OPNsense system yet prefer using command line tools or who may only have remote shell access via SSH to administrate their OPNsense installations. However, accessing the web interface is still necessary after installation to complete the initial configuration of Sensei.
The command line installation method was the primary means for installing Zenarmor before it was officially available on the “Plugins” page in the OPNsense web interface. This option is still available for users who have direct access to the OPNsense system yet prefer using command line tools or who may only have remote shell access via SSH to administrate their OPNsense installations. However, accessing the web interface is still necessary after installation to complete the initial configuration of Zenarmor.
You may install Sensei if you have local system access to OPNsense or remote access using SSH.
You may install Zenarmor if you have local system access to OPNsense or remote access using SSH.
....................
Local System Access
@ -27,7 +27,7 @@ When you have local access to OPNsense, you may simply log into OPNsense using t
SSH Access
....................
If you only have shell access to OPNsense, you may install Sensei remotely by logging into OPNsense using a SSH client with the following command where “root” is the administrator account and “your-firewall-ip” is the IP address or hostname of the OPNsense system. You should see a list of OPNsense menu options.
If you only have shell access to OPNsense, you may install Zenarmor remotely by logging into OPNsense using a SSH client with the following command where “root” is the administrator account and “your-firewall-ip” is the IP address or hostname of the OPNsense system. You should see a list of OPNsense menu options.
.. code-block:: bash
@ -37,20 +37,20 @@ If you only have shell access to OPNsense, you may install Sensei remotely by lo
:width: 100%
................................
Download & Run Sensei Installer
Download & Run Zenarmor Installer
................................
Once you are successfully logged into OPNsense either by local system access or SSH, enter option “8” to open the shell. Run the following command to download and execute the installation script.
.. code-block:: bash
# curl https://updates.sunnyvalley.io/getsensei | sh
# curl https://updates.sunnyvalley.io/getzenarmor | sh
.. image:: images/sensei-cli-install.png
.. image:: images/zenarmor-cli-install-.png
:width: 100%
The script will copy the installation files onto the filesystem and will add a top-level menu item within the OPNsense web interface. Depending on the speed of your hardware and Internet connection, the installation may take several minutes to complete.
Once the installation has been completed, you may disconnect from your terminal session.
You will now need to complete the “Initial Configuration Wizard” for Sensei to be fully operational. See the :ref:`Initial Configuration Wizard <_Sensei_Initial_Configuration_Wizard>` section for information.
You will now need to complete the “Initial Configuration Wizard” for Zenarmor to be fully operational. See the :ref:`Initial Configuration Wizard <_Sensei_Initial_Configuration_Wizard>` section for information.

@ -1,12 +1,14 @@
========================================
Sensei: Hardware Requirements
Zenarmor (Sensei): Hardware Requirements
========================================
Due to the nature of deep packet analysis and detailed drill-down reporting functionality, Sensei requires more hardware resources than a standard L3-L4 firewall.
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::
With the Sensei 1.5 release, you can offload your reporting database to an external system. This allows you to be able to run Sensei on systems with a constrained amount of RAM.
**.. 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.
It is recommended that you check if your Ethernet adapter functions well with netmap.
@ -14,13 +16,13 @@ It is recommended that you check if your Ethernet adapter functions well with ne
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 Sensei.
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 Sensei as a virtual guest since resources in virtual environments are generally shared between guest systems. 
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. 
Below is the recommended minimum hardware requirements for Sensei based on the number of devices and the amount of sustained bandwidth:
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**
@ -31,15 +33,15 @@ Below is the recommended minimum hardware requirements for Sensei based on the n
250-1000 500 Mbps - 100 Kpps 32 GB Intel Quad-Core i7 3.4 GHz (4 Cores, 8 Threads) or equivalent
===================== ========================= ================== ======================================================================
.. Note::
**.. Note:: :**
Sensei 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 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.
-----------------
Ethernet Adapter
-----------------
Sensei uses a FreeBSD subsystem called `netmap(4) <https://www.freebsd.org/cgi/man.cgi?query=netmap&sektion=4>`_ to access raw Ethernet frames. With FreeBSD 11 (OPNsense version <= 20.1) this software can be very particular in terms of proper driver compatibility.
Zenarmor uses a FreeBSD subsystem called `netmap(4) <https://www.freebsd.org/cgi/man.cgi?query=netmap&sektion=4>`_ to access raw Ethernet frames. With FreeBSD 11 (OPNsense version <= 20.1) this software can be very particular in terms of proper driver compatibility.
Intel based adapters, particularly em(4) and igb(4), are observed to perform well in terms of stability and performance.
@ -49,7 +51,7 @@ Sunny Valley Networks is sponsoring developments on this project so you can expe
Disk Space
-----------
Sensei uses `Elasticsearch <https://en.wikipedia.org/wiki/Elasticsearch>`_ or `MongoDB <https://www.mongodb.com/>`_ as its backend to store large data sets. Please allow at least 5 MB of disk space per hour per megabit/second throughput.
Zenarmor uses `Elasticsearch <https://en.wikipedia.org/wiki/Elasticsearch>`_ or `MongoDB <https://www.mongodb.com/>`_ as its backend to store large data sets. Please allow at least 5 MB of disk space per hour per megabit/second throughput.
If you're running a 100 Mbps link \(about 100 users\) which is quite active during the daytime and idle rest of the day, you may calculate the space needed as follows:
@ -59,4 +61,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>`_, Sensei 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/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.

@ -1,57 +1,57 @@
====================================
Sensei: Installing via Web Interface
Zenarmor (Sensei): Installing via Web Interface
====================================
.. Note::
Sensei 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>`_
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>`_
Sensei may be installed using the web interface in OPNsense or using the command line interface via SSH or local system access (see :doc:`sensei_cmd_install`). The preferred method is the web interface because the process of installing plugins in OPNsense is simple and Sensei requires the use of the web interface to complete the initial configuration after installation.
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.
To install plugins in OPNsense, you must use an account with administrative access.
.. Note::
Before installing Sensei, you should ensure you meet the minimum system requirements in order to run Sensei or to have the best user experience. See :doc:`sensei_hardwarerequirements` for more information.
Before installing Zenarmor, you should ensure you meet the minimum system requirements in order to run Zenarmor or to have the best user experience. See :doc:`zenarmor_hardwarerequirements` for more information.
--------------------------
Web Interface Installation
--------------------------
To install Sensei, you must first install the Sunny Valley Networks vendor repository plugin. Go to the :menuselection:`System --> Firmware --> Plugins` page. Click on the “+” icon next to os-sunnyvalley to install the plugin.
To install Zenarmor, you must first install the Sunny Valley Networks vendor repository plugin. Go to the :menuselection:`System --> Firmware --> Plugins` page. Click on the “+” icon next to os-sunnyvalley to install the plugin.
Once the vendor plugin is installed, you should see the Sensei plugin available in the list of plugins as os-sensei. If you do not see the Sensei plugin, you may need to refresh the “Plugins” page. Click the “+” icon next to os-sensei to install the plugin.
Once the vendor plugin is installed, you should see the Zenarmor plugin available in the list of plugins as os-sensei. If you do not see the Zenarmor plugin, you may need to refresh the “Plugins” page. Click the “+” icon next to os-sensei to install the plugin.
After installing Sensei, you should see the Sensei menu in the left sidebar of the OPNsense web interface. If you do not see the new, top-level menu, you may need to refresh the page.
After installing Zenarmor, you should see the Zenarmor menu in the left sidebar of the OPNsense web interface. If you do not see the new, top-level menu, you may need to refresh the page.
.. image:: images/sensei-install-complete.png
.. image:: images/zenarmor-install-complete.png
:width: 100%
Next, you will need to complete the “Initial Configuration Wizard” for Sensei to be fully operational.
Next, you will need to complete the “Initial Configuration Wizard” for Zenarmor to be fully operational.
.. _Sensei_Initial_Configuration_Wizard:
------------------------------
Initial Configuration Wizard
------------------------------
Regardless of the installation method you used, you will need to complete the initial configuration wizard before you may start using Sensei.
Regardless of the installation method you used, you will need to complete the initial configuration wizard before you may start using Zenarmor.
To start the "Initial Configuration Wizard":
* Log in to your OPNsense web interface
* Click Sensei from the left menu
* Click Zenarmor from the left menu
* Click on the Dashboard sub-menu to open the configuration wizard
....................
1- EULA
1- Welcome
....................
* Accept the End User License Agreement *(scroll and read the terms to get to the next button)*.
* Accept the Terms of Service and Privacy Policy by clicking on the checkbox.
.. image:: images/sensei-wizard-welcome.png
.. image:: images/zenarmor-wizard-welcome.png
:width: 100%
* Click the :menuselection:`I Agree` button to continue to the :menuselection:`Hardware Check` section.
* Click the :menuselection:`Proceed` button to continue to the :menuselection:`Hardware Check` section.
....................
2- Hardware Check
@ -59,17 +59,17 @@ To start the "Initial Configuration Wizard":
Your hardware will be analyzed to ensure it meets the minimum requirements. You will receive one of following responses: compatible hardware, low-end hardware, incompatible hardware. The setup will not continue if you have incompatible hardware.
.. image:: images/sensei-wizard-hardware-high-end.png
.. image:: images/zenarmor-wizard-hardware-high-end.png
:width: 100%
*Compatible*
.. image:: images/sensei-wizard-hardware-low-end.png
.. image:: images/zenarmor-wizard-hardware-low-end.png
:width: 100%
*Low-end*
.. image:: images/sensei-wizard-hardware-incompatible.png
.. image:: images/zenarmor-wizard-hardware-incompatible.png
:width: 100%
*Incompatible*
@ -86,12 +86,12 @@ Your hardware will be analyzed to ensure it meets the minimum requirements. You
If you wish to use a remote ElasticSearch database, you must choose it now since you cannot change this after the initial configuration wizard has been completed.
.. image:: images/sensei-wizard-reporting-database-high-end.png
.. image:: images/zenarmor-wizard-reporting-database-high-end.png
:width: 100%
*High-end*
.. image:: images/sensei-wizard-reporting-database-low-end.png
.. image:: images/zenarmor-wizard-reporting-database-low-end.png
:width: 100%
*Low-end*
@ -100,9 +100,9 @@ Your hardware will be analyzed to ensure it meets the minimum requirements. You
.. Note::
If you have SOHO or higher Sensei paid subscription, we recommend that you install your license key before proceeding with the initial configuration wizard since this will activate a feature that will enable you to have central reporting for many firewalls from a single Elasticsearch instance. Otherwise, only a single remote ES instance can be used with a single firewall.
If you have SOHO or higher Zenarmor paid subscription, we recommend that you install your license key before proceeding with the initial configuration wizard since this will activate a feature that will enable you to have central reporting for many firewalls from a single Elasticsearch instance. Otherwise, only a single remote ES instance can be used with a single firewall.
.. image:: images/sensei-wizard-reporting-database-remote.png
.. image:: images/zenarmor-wizard-reporting-database-remote.png
:width: 100%
* Click the :menuselection:`Install Database & Proceed` button to install the local database if one is chosen and continue to the :menuselection:`Interface Selection` section.
@ -115,10 +115,10 @@ Your hardware will be analyzed to ensure it meets the minimum requirements. You
For detailed information on "Deployment Modes", `see here <https://www.sunnyvalley.io/docs/guides/deployment-modes>`_. 
.. image:: images/sensei-wizard-interface-selection-available.png
.. image:: images/zenarmor-wizard-interface-selection-available.png
:width: 100%
.. image:: images/sensei-wizard-interface-selection-protected.png
.. image:: images/zenarmor-wizard-interface-selection-protected.png
:width: 100%
* Click :menuselection:`Next` to continue to the :menuselection:`Cloud Reputation` section.
@ -127,9 +127,9 @@ For detailed information on "Deployment Modes", `see here <https://www.sunnyval
5- Cloud Reputation
....................
The Cloud Threat Intelligence data is queried in real-time when any connections are made through your network. This capability enables Sensei to respond to malware and wireless outbreaks in real-time and very quickly.
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. Sensei 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 140+ million websites under 120+ categories in milliseconds.
Cloud Threat Intel settings let you:
@ -137,67 +137,57 @@ Cloud Threat Intel settings let you:
* Set local domain name you wish to be excluded from cloud queries
* Select the fastest Cloud Reputation Servers which are used for queries
.. image:: images/sensei-wizard-cloud-reputation.png
.. image:: images/zenarmor-wizard-cloud-reputation.png
:width: 100%
* Click :menuselection:`Next` to continue to the :menuselection:`Sensei CLI` section.
.........................
6- Sensei CLI (Security)
.........................
* Set your TCP Service password. This password protects the command line access to the packet engine. It is highly recommended to use a very secure password. The default password is “Sensei1234” so be sure to change it.
.. image:: images/sensei-wizard-sensei-cli.png
:width: 100%
* Click :menuselection:`Next` to continue to the :menuselection:`Updates & Health Check` section.
..........................
7- Updates & Health Check
6- Updates & Health Check
..........................
.. Note::
Sensei uses the OPNsense package system to deliver its updates. You may configure how you prefer to receive your Sensei updates.
Zenarmor uses the OPNsense package system to deliver its updates. You may configure how you prefer to receive your Zenarmor updates.
* **Check for Updates Automatically:** Checks automatically for the updates and creates a notification on the Sensei “Status” page.
* **Automatically Update Databases and Threat Intelligence Data:** Checks automatically for the updates and creates a notification on the Sensei “Status” page.
* **Enable Generation of Support Data:** If enabled, Sensei collects supporting data during unusual events and crashes. You can share this data when opening a ticket with us.
* **Max Swap Utilization:** You may specify how much swap space Sensei may utilize when the system is low on memory. It is recommended that you do not set this value too high. Otherwise, system performance may suffer.
* **Check for Updates Automatically:** Checks automatically for the updates and creates a notification on the Zenarmor “Status” page.
* **Automatically Update Databases and Threat Intelligence Data:** Checks automatically for the updates and creates a notification on the Zenarmor “Status” page.
* **Enable Generation of Support Data:** If enabled, Zenarmor collects supporting data during unusual events and crashes. You can share this data when opening a ticket with us.
* **Max Swap Utilization:** You may specify how much swap space Zenarmor may utilize when the system is low on memory. It is recommended that you do not set this value too high. Otherwise, system performance may suffer.
* **Health Check:** If enabled, "Health Check" monitors the system's memory, CPU, disk usage and core services if they're working correctly, and raises alerts if anything goes wrong. "Health Check" also stops the appropriate services if they're consuming excessive system resources.
* **Help Sunny Valley Improve Its Products and Services:** If enabled, general system information is submitted to Sunny Valley to help improve the future development of Sensei.
* **Help Sunny Valley Improve Its Products and Services:** If enabled, general system information is submitted to Sunny Valley to help improve the future development of Zenarmor.
.. image:: images/sensei-wizard-updates-health-check.png
.. image:: images/zenarmor-wizard-updates-health-check.png
:width: 100%
* Click :menuselection:`Next` to continue to the :menuselection:`Deployment Size` section.
....................
8- Deployment Size
7- Deployment Size
....................
Sensei may support up to 1,000 concurrent users on an average PC. You can set your Sensei installations capacity in this section.
Zenarmor may support up to 1,000 concurrent users on an average PC. You can set your Zenarmor installations capacity in this section.
.. Note::
You may see detailed information about suggested hardware at :doc:`sensei_hardwarerequirements`
You may see detailed information about suggested hardware at :doc:`zenarmor_hardwarerequirements`
.. image:: images/sensei-wizard-deployment-size.png
.. image:: images/zenarmor-wizard-deployment-size.png
:width: 100%
* Click :menuselection:`Next` to continue to the :menuselection:`Finish` section.
....................
9- Finish
8- Finish
....................
* You may enter your email address if you wish to subscribe to the Sunny Valley email list to stay up to date on the latest news.
.. image:: images/sensei-wizard-finish.png
.. image:: images/zenarmor-wizard-finish.png
:width: 100%
* Click the :menuselection:`Finish` button to save your initial configuration data and start using Sensei.
* Click the :menuselection:`Finish` button to save your initial configuration data and start using Zenarmor.
-------------------
**Hands-on Video**
Loading…
Cancel
Save