.. _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.
* USB dongle if you opt for the on-premise licensing.

Use the main web interface to manage ``findface-ntls``:

* 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-manager``,
* ``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 6 hours to restore it before the licensable components will be automatically stopped. 

The ``findface-ntls`` configuration is done through a configuration file ``/etc/findface-ntls.cfg``.

.. code::

   # Listen address of NTLS server where services will connect to.
   # The format is IP:PORT
   # Use 0.0.0.0:PORT to listen on all interfaces
   # This parameter is mandatory and may occur multiple times
   # if you need to listen on several specific interfaces or ports.
   listen = 127.0.0.1:3133


   # Directory with license files.
   # NTLS use most recently generated one.
   # Note: "recentness" of a license file is detected not by
   #       mtime/ctime but from its internal structure.
   #
   # This parameter is mandatory and must occur exactly once.
   license-dir = /opt/ntech/license

   # You can specify proxy which NTLS will use to access
   # global license server. The syntax is the same that is used by curl.
   # Proxy is optional
   #proxy = http://192.168.1.1:12345

   # This is bind address for NTLS web-interface.
   # Note: there're no authorization or access restriction mechanisms
   #       in NTLS UI. If you need one, consider using nginx as proxy
   #       with .htaccess / ip-based ACLs.
   # This parameter may be specified multiple times.
   ui = 127.0.0.1:3185


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

+---------------------+-------------------------------------------------------------------------------+
| Parameter           | Description                                                                   |
+=====================+===============================================================================+
| ``listen``          | IP address from which licensable services access ``findface-ntls``.           |
|                     | To allow access from any IP address, use ``0.0.0.0:3133``.                    |
+---------------------+-------------------------------------------------------------------------------+
| ``license_dir``     | Directory to store a license file.                                            |
+---------------------+-------------------------------------------------------------------------------+
| ``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”.               |
+---------------------+-------------------------------------------------------------------------------+