SwarmSense Installation
=======================

SwarmSense setup is really easy. It comes with one-click installer script which will
take-care of every dependency of the application.

You will get a zip file ``snms.zip`` of the application.

First of all you have to install ``unzip``::


   $ apt-get update
   $ apt-get install unzip

Now extract the zip file::

   $ unzip snms.zip

.. image:: ../_static/unzip_snms.png
   :height: 500px

|
It will create a folder named ``release``. Installation script for the application
:file:`setup.sh` is under :file:`release/script` directory. Run this file to start application
installation::

   $ cd release/script
   $ sh setup.sh

.. note:: Run all the above commands with ``root`` privileges.

After running :command:`$ sh setup.sh` it will install **nginx**, **postfix**, **rabbitmq**, **postgres**,
**influxdb** etc.

While installing **postfix** it will prompt for installation type, please
select **Internet Site**.

.. image:: ../_static/postfix_prompt.png
   :height: 400px
|
During the installation of database it will ask for database username and prefix for database name.
You can use default values if you don't want to change.

.. image:: ../_static/database_username.png
   :height: 500px
|
It will also ask for host name (domain) for installation. Enter your domain name like
``swarmsense.baseapp.com`` or ``swarmsense.com``. Your backend server will be accessible
at ``<hostname>/api`` endpoint like ``swarmsense.baseapp.com/api`` or ``swarmsense.com/api``.

.. image:: ../_static/hostname.png
   :height: 500px
|
During the installation of backend it will ask for the details for first admin user. Please
note that this user details will be further used to login to your application.

.. image:: ../_static/admin_user.png
   :height: 500px
|
After finishing the installation ``/etc/snms.conf`` configuration will be created. This
file has all the application configurations.

.. image:: ../_static/install_complete.png
   :height: 500px
|
Now you can browse the web UI application at the host name you provided. Login with
the user that you created above.

.. image:: ../_static/ui_login.png
   :height: 500px
|
All the application related files logs will be at ``/opt/snms`` directory.