.. _deployment:

**************************************
Deploy and Remove FindFace Multi
**************************************

.. rubric:: Docker platform 

FindFace Multi 2.0+ is Docker-based. You must install and start a set of Docker products before proceeding with the FindFace Multi deployment. For your convenience, this chapter contains the :ref:`deploy-prepare-server` section covering the intricacies of installing Docker on Ubuntu. For other platforms, please refer to the `Docker documentation <https://docs.docker.com/engine/install/>`__. 

.. rubric:: NVIDIA driver and NVIDIA Container Runtime (GPU only)

If you intend to deploy FindFace Multi with GPU-acceleration, you need to install the NVIDIA driver and NVIDIA Container Runtime. Again, you will find the relevant information in the :ref:`deploy-prepare-server` section.  

.. rubric:: Deployment options

After you are finished with the server preparation, you are all set for the FindFace Multi deployment. You are provided with the following options here: 

#. Automatically install FindFace Multi standalone in one run. Being the simplest, this installation type is excellent to kick-start your experience with FindFace Multi. We recommend choosing it if you are a first-timer. See :ref:`installer` for guidance. 
#. Automatically install FindFace Multi and configure it to interact with additional remote ``findface-video-worker`` instances. This installation type is for those who are deploying FindFace Multi in a multi-host environment. It requires a bit of technical expertise and knowledge of the product architecture. To automatically install only FindFace Video Worker (``findface-video-worker``) on a remote host, refer to the :ref:`video-worker-installer` section. 
#. Fully customized installation. It requires fundamental understanding of the product architecture. See :ref:`custom-installation`.

.. note::
   If you select the installation type #3, keep in mind to :ref:`install necessary neural network models <deploy-models>` along with the ``findface-extraction-api`` component.

.. rubric:: Installer questions and automatic deployment from the installation file

Before starting the actual installation, the installer asks you a few questions and performs several automated checks to ensure that the host meets the system requirements. After filling out each prompt, press :kbd:`Enter`. 

To install the same configuration of FindFace Multi on a different host, use the automatic deployment from the installation file. In this case, you won't have to answer the installation questions again. The exact path to the installation file is displayed right after the last question, before the installer starts off active progress:

.. code::

   [I 2023-02-09 11:13:37,187 main:142] Your answers were saved to /tmp/findface-installer-p01n9sn3.json

.. important::

   Be sure to remove fields ``*.config``, ``exp_ip``, and ``int_ip`` before installing FindFace Multi on a host with a different IP address.

To launch the automatic deployment from the ``/tmp/<findface-installer-*>.json`` file, execute:

.. code::

   sudo ./<findface-*>.run -f /tmp/<findface-installer-*>.json

 
.. rubric:: Post-development procedures and how-to's

Browse through the :ref:`docker-commands` section to learn how to set the time zone, license your instance, and configure logging. This section will also provide you with few basic commands that will help you to kick-start your work with FindFace Multi containers, in case you are a newbie with Docker.

.. important::
   Starting the GPU-accelerated services ``findface-extraction-api`` and ``findface-video-worker`` for the first time after deployment may take a considerable amount of time due to the caching process (up to 45 minutes).

.. important::
   Although FindFace Multi provides tools to ensure its protection from unauthorized access, they are not replacing a properly configured firewall. Be sure to use a firewall to heighten the FindFace Multi network protection.

.. rubric:: Instance removal

To remove your instance, you must run a set of commands. See the :ref:`remove-instance` section.


.. toctree::
   :maxdepth: 1
   :caption: In this chapter:

   deploy-prepare-server
   deploy-prepare-centos
   deploy-prepare-debian
   deploy-installer
   deploy-video-worker
   deploy-vms
   custom-installation
   multi-host-installation
   deploy-models
   docker-commands
   remove_instance