Updated docs for 1.6 and corrected minor issues

pull/288/head
Dustin Casto 4 years ago
parent 413a347926
commit 17b9110b67

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 75 KiB

@ -53,15 +53,14 @@ Getting Support
**Support for Free Edition**
If you need help for anything, there is an active discussion about Sensei on OPNsense forum. Feel free to `click here <https://forum.opnsense.org/index.php?topic=9521.new;topicseen#new>`_ and join the conversation.
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?topic=9521.new;topicseen#new>`_ to join the conversation.
You can also issue bug reports from `Gitlab <https://gitlab.com/svn-community/opnsense-sensei-plugin/issues>`_
You may also submit bug reports by visiting the *Report Bug* page in the Sensei web UI.
With its in-depth coverage, `Sensei Documentation <https://help.sunnyvalley.io/>`_ is always available for reference.
* `OPNsense Forum <https://forum.opnsense.org/index.php?topic=9521.new;topicseen#new>`_
* `Users' Manual <https://help.sunnyvalley.io/>`_
* `Report a problem <https://gitlab.com/svn-community/opnsense-sensei-plugin/issues>`_
**Premium Subscription Support**

@ -20,19 +20,15 @@ Web Interface Installation (Preferred Method)
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.
.. image:: images/sensei-vendor-plugin.png
:width: 100%
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 plugin, you may need to refresh the Plugins page. Click the “+” icon next to os-sensei to install the plugin.
.. image:: images/sensei-plugin.png
:width: 100%
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.
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 your page.
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.
.. image:: images/sensei-install-complete.png
:width: 100%
Next, you will need to complete the “Initial Configuration Wizard” for Sensei to be fully operational.
-----------------------------------------------
Command Line Installation (Alternative Method)
-----------------------------------------------
@ -82,10 +78,12 @@ The script will copy the installation files onto the filesystem and will add a t
Once the installation has been completed, you may disconnect from your terminal session. You may also disable your firewalls SSH service by unchecking the checkboxes mentioned above if you no longer wish to use the SSH service.
You will now need to complete the “Initial Configuration Wizard” for Sensei to be fully operational.
-----------------------------
Initial Configuration Wizard
------------------------------
Regardless of your installation method, you will need to go through the initial configuration wizard before you may start using Sensei.
Regardless of the installation method you chose, you will need to go through the initial configuration wizard before you may start using Sensei.
To start the "Initial Configuration Wizard":
@ -102,7 +100,7 @@ To start the "Initial Configuration Wizard":
.. image:: images/sensei-wizard-welcome.png
:width: 100%
* Click the :menuselection:`I Agree` button to continue to the :menuselection:`Interface Selection` section.
* Click the :menuselection:`I Agree` button to continue to the :menuselection:`Hardware Check` section.
....................
2- Hardware Check
@ -113,17 +111,17 @@ Your hardware will be analyzed to ensure it meets the minimum requirements. You
.. image:: images/sensei-wizard-hardware-high-end.png
:width: 100%
Compatible
**Compatible**
.. image:: images/sensei-wizard-hardware-low-end.png
:width: 100%
Low-end
**Low-end**
.. image:: images/sensei-wizard-hardware-incompatible.png
:width: 100%
Incompatible
**Incompatible**
* Click :menuselection:`Next` to continue to the :menuselection:`Reporting Database` section.
@ -140,12 +138,12 @@ Incompatible
.. image:: images/sensei-wizard-reporting-database-high-end.png
:width: 100%
High-end
**High-end**
.. image:: images/sensei-wizard-reporting-database-low-end.png
:width: 100%
Low-end
**Low-end**
* If you select “Use a Remote Elasticsearch Database”, you will be prompted to enter the URL, username, and password.
@ -164,6 +162,8 @@ Low-end
* 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://help.sunnyvalley.io/hc/en-us/articles/360053347013>`_. 
.. image:: images/sensei-wizard-interface-selection-available.png
:width: 100%
@ -254,4 +254,4 @@ Sensei may support up to 1,000 concurrent users on an average PC. You can set yo
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/embed/y6OE2FuzkF0?time_continue=7" frameborder="0" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/embed/lbaBySzc5OI" frameborder="0" allowfullscreen></iframe>

Loading…
Cancel
Save