.. _installer:

Install from Console Installer
---------------------------------------------------------------
	
To install FindFace Enterprise Server, use a developer-friendly console installer.

.. tip::
   Be sure to consult the :ref:`system requirements <requirements>` prior.


Do the following:

#. Download the installer file ``<findface-security-and-server-xxx>.run``.
#. Put the ``.run`` file into some directory on the designated host (for example, ``/home/username``).
#. From this directory, make the ``.run`` file executable.

   .. code::

      chmod +x <findface-security-and-server-xxx>.run

#. Execute the ``.run`` file.

   .. code::

      sudo ./<findface-security-and-server-xxx>.run

   The installer will ask you a few questions and perform several automated checks to ensure that the host meets the system requirements. Fill out the prompts appropriately once requested. The questions are the following:

   #. Product to install: ``FindFace Server``. 
   #. Installation type:

      * ``1``: install FindFace Enterprise Server standalone.
      * ``2``: install FindFace Enterprise Server and configure it to interact with additional remote ``findface-video-worker`` instances. 
 
         .. tip::
            To install only ``findface-video-worker`` on a host, refer to :ref:`video-worker-installer`.

      * ``3``: install only the apt repository that can be further used for the :ref:`step-by-step deployment <step-by-step>`.
      * ``4``: :ref:`fully customized installation <custom-installation>`.

        .. important::
           Be sure to :ref:`manually install <deploy-models>` neural network models on the host(s) with ``findface-extraction-api``.
 
   #. Type of ``findface-video-worker`` package: CPU or GPU.
   #. Type of ``findface-extraction-api`` package: CPU or GPU.

   After all the questions are answered, the answers will be saved to a file ``/tmp/<findface-installer-*>.json``. You can edit this file and use it to install FindFace Enterprise Server on other hosts without having to answer the questions again.

   Should you choose the standalone installation, the FindFace Enterprise Server components will be automatically installed, configured, and/or started in the following configuration:

   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | Service                              | Configuration                                                                                         |
   +======================================+=======================================================================================================+
   | etcd                                 | Installed and started.                                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | memcached                            | Installed and started.                                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | nginx                                | Installed and started.                                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | findface-ntls	                  | Installed and started.                                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+ 
   | findface-tarantool-server            | Installed and started. The number of instances (shards) is calculated using the formula:              |
   |                                      | ``N = max(min(mem_mb // 2000, cpu_cores), 1)``, i.e. it is equal to the RAM size in MB divided by     |
   |                                      | 2000, or the number of CPU physical cores (but at least 1 shard).                                     |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | findface-extraction-api              | Installed and started.                                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | findface-sf-api                      | Installed and started.                                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | findface-facerouter                  | Installed and started.                                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | findface-upload                      | Installed.                                                                                            |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | findface-video-manager 	          | Installed and started.                                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | findface-video-worker-*              | Installed and started.                                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | findface-data-*                      | Neural network models for face and face features recognition (gender, age, emotions, glasses, beard). |
   |                                      | Installed.                                                                                            |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | findface-gpudetector-data/           | NTechLab gpu detector data. Installed.                                                                |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+
   | jq 	                          | Installed. Used to pretty-print API responses from FindFace Enterprise Server.                        |
   +--------------------------------------+-------------------------------------------------------------------------------------------------------+

   After the installation is complete, the following output will be shown on the console:

   .. tip::
      Be sure to save this data: you will need it later.

   .. code::

      #############################################################################
      #                       Installation is complete                            #
      #############################################################################
      - upload your license to http://127.0.0.1:3185/
      - FindFace SF-API address: http://172.20.77.78:18411/
      - FindFace VideoManager address: http://172.20.77.78:18411/

#. Upload the FindFace Enterprise Server license file via the ``findface-ntls`` web interface ``http://<ntls_host_IP_address>:3185``. 

   .. note::
      The IP address is shown in the links to the FindFace web services in the following way: as an external IP address if the host belongs to a network, or ``127.0.0.1`` otherwise.

#. To automatically install FindFace Enterprise Server on another host without answering the installation questions, use the ``/tmp/<findface-installer-*>.json`` file. Execute:

   .. code::

      sudo ./<findface-security-and-server-xxx>.run -f /tmp/<findface-installer-*>.json

   .. tip::
      You can find the installation file example in :ref:`installation-file`.