.. _ntls-config:


``ntls``
---------------------------------

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

* NtechLab 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 web interface ``http://<NTLS_IP_address>:3185/#/`` to manage ``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:

* ``tntapi``,
* ``extraction-api``,
* ``video-worker``.

.. important::
   After connection between ``ntls`` and a licensable component, or between ``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 ``ntls`` configuration is done through environment variables and command line flags. You can also use a configuration file and find its default content :download:`here <_scripts/default_ntls-cfg.yaml>`.

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


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

     * - Command line flags
       - Type
       - Description
     * - ``-h``, ``--help``
       - {bool}
       - Display help and exit (env: ``CFG_HELP``).
     * - ``-c``, ``--config``
       - {string}
       - Path to config file (env: ``CFG_CONFIG``).
     * - ``-C``, ``--config-template``
       - {bool}
       - Echo default config to stdout (env: ``CFG_CONFIG_TEMPLATE``).
     * - ``--config-template-format``
       - {string}
       - ``config-template`` output format (yaml/env/ini) (env: ``CFG_CONFIG_TEMPLATE_FORMAT``).
     * - ``-l``, ``--listen``
       - {networkAddress}
       - Address to accept incoming client connections (IP:PORT) (env: ``CFG_LISTEN``).
     * - ``-L``, ``--license-dir``
       - {string}
       - Directory where license files are stored (env: ``CFG_LICENSE_DIR``).
     * - ``--proxy``
       - {optionalNetworkAddress}
       - (Optional) IP address and port of your specified proxy server. Use specified proxy (MUST support HTTP CONNECT method) to access global license server (IP:PORT). (env: ``CFG_PROXY``).
     * - ``--ui``
       - {optionalNetworkAddress}
       - IP address from which accessing the ``ntls`` web interface must originate (IP:PORT). To allow access from any remote host, specify ``0.0.0.0:3185``. (env: ``CFG_UI``).
     * - ``--ui-dir``
       - {string}
       - Directory with UI static files (env: ``CFG_UI_DIR``).



Priority:

#. Defaults from source code (lowest priority).
#. Configuration file.
#. Environment variables.
#. Command line.