.. _ntls-config:


``findface-ntls``
---------------------------------

The ``findface-ntls`` service is to be installed on a designated host to verify the FindFace license. For verification purposes, ``findface-ntls`` uses one of the following sources:

* Ntech Lab global license center if you opt for the online licensing, direct or via a proxy server.
* Guardant USB dongle if you opt for the on-premise licensing.
* Guardant or Sentinel services if you opt for the offline software licensing.

Use the FindFace Multi web interface (:guilabel:`Settings` → :guilabel:`License`) to manage ``findface-ntls`` in the following way:

* view the list of purchased features,
* view license limitations,
* upload a license file,
* view the list of currently active components.

The following components are licensable:

* ``findface-tarantool-server``,
* ``findface-extraction-api``,
* ``findface-video-worker``.

.. important::
   After connection between ``findface-ntls`` and a licensable component, or between ``findface-ntls`` and the global license server is broken, you will have 4 hours to restore it before the licensable components will be automatically stopped. It is possible to prolongate the off-grid period for up to 2 days. Inform your manager if you need that.

The ``findface-ntls`` configuration is done through a configuration file ``findface-ntls.yaml``. You can find its default content :download:`here <_scripts/findface-ntls.yaml>`.

When configuring ``findface-ntls``, refer to the following parameters:


.. list-table::
     :widths: 14 45
     :header-rows: 1

     * - Parameter
       - Description
     * - ``license_dir``
       - Directory to store a license file.
     * - ``listen``
       - IP address from which licensable services access ``findface-ntls``. To allow access from any IP address, use ``0.0.0.0:3133``.
     * - ``proxy``
       - (Optional) IP address and port of your proxy server.
     * - ``ui``
       - IP address from which accessing the ``findface-ntls`` web interface must originate. To allow access from any remote host, set ``0.0.0.0``.