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

Moved the command line installation to a new page (#290)

Browse Source
pull/293/head
dlcasto 4 years ago committed by GitHub
parent aa9583fdcc
commit 416239ed33
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 68 additions and 59 deletions
Show Stats Download Patch File Download Diff File

1
source/third_party_plugins.rst
Unescape Escape View File

@ -34,3 +34,4 @@ Sunnyvalley
vendor/sunnyvalley/sensei
vendor/sunnyvalley/sensei_hardwarerequirements
vendor/sunnyvalley/sensei_install
vendor/sunnyvalley/sensei_cmd_install

3
source/vendor/sunnyvalley/sensei.rst vendored
Unescape Escape View File

@ -32,6 +32,7 @@ Getting Started
- :doc:`sensei_hardwarerequirements`
- :doc:`sensei_install`
- :doc:`sensei_cmd_install`
----------------------------
User Manual
@ -59,7 +60,7 @@ You may also submit bug reports by visiting the *Report Bug* page in the Sensei
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>`_
* `OPNsense Forum <https://forum.opnsense.org/index.php?board=38.0>`_
* `Users' Manual <https://help.sunnyvalley.io/>`_
**Premium Subscription Support**

56
source/vendor/sunnyvalley/sensei_cmd_install.rst vendored
Unescape Escape View File

@ -0,0 +1,56 @@
===================================
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.
To install Sensei in OPNsense with the command line interface, you must use an administrative account with shell access.
-------------------------
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.
You may install Sensei if you have local system access to OPNsense or remote access using SSH.
....................
Local System Access
....................
When you have local access to OPNsense, you may simply log into OPNsense using the “root” user or another administrator account. You should see a list of OPNsense menu options.
.. image:: images/opnsense-direct-system-access.png
:width: 100%
....................
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.
.. code-block:: bash
$ ssh root@your-firewall-ip
.. image:: images/opnsense-ssh-login.png
:width: 100%
................................
Download & Run Sensei 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
.. image:: images/sensei-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.

67
source/vendor/sunnyvalley/sensei_install.rst vendored
Unescape Escape View File

@ -1,12 +1,12 @@
=====================
Sensei: Installing
=====================
====================================
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>`_
Sensei may be installed using the web interface in OPNsense or using the command line interface via SSH or direct system access. The preferred method is the web interface. Once Sensei is installed, you will need to complete the initial configuration in the web interface so it is convenient to also complete the installation using the web interface.
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.
To install plugins in OPNsense, you must use an account with administrative access.
@ -14,9 +14,9 @@ To install plugins in OPNsense, you must use an account with administrative acce
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.
---------------------------------------------
Web Interface Installation (Preferred Method)
---------------------------------------------
--------------------------
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.
@ -29,61 +29,12 @@ After installing Sensei, you should see the Sensei menu in the left sidebar of t
Next, you will need to complete the “Initial Configuration Wizard” for Sensei to be fully operational.
-----------------------------------------------
Command Line Installation (Alternative Method)
-----------------------------------------------
The command line installation method was the primary means for installing Sensei before it was 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, the web interface will need utilized after installation to complete the initial configuration of Sensei.
.. Tip::
If you plan to leave the SSH service active, the best practice recommendations are to create a user with administrative access rather than using the “root” user and to make use of stronger authentication methods such as using keys rather than passwords.
....................
Direct System Access
....................
When you have direct access to OPNsense, you may simply log into OPNsense using the “root” user or another administrator account. You should see a list of OPNsense menu options.
.. image:: images/opnsense-direct-system-access.png
:width: 100%
....................
SSH Access
....................
If you only have shell access to OPNsense, you may install Sensei remotely by logging into OPNsense using a SSH client using 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 the same list of menu options as directly accessing the system.
.. code-block:: bash
$ ssh root@your-firewall-ip
.. image:: images/opnsense-ssh-login.png
:width: 100%
................................
Download & Run Sensei Installer
................................
Once you are successfully logged into OPNsense either by direct system access or SSH access, 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
.. image:: images/sensei-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 may also disable your firewall’s 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.
.. _Sensei_Initial_Configuration_Wizard:
------------------------------
Initial Configuration Wizard
------------------------------
Regardless of the installation method you chose, you will need to go through 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 Sensei.
To start the "Initial Configuration Wizard":

Write Preview
Loading…
Cancel
Save