Install as Pre-Configured Virtual Machine

You can deploy FindFace Enterprise Server SDK as a fully pre-configured ready-to-use virtual machine image that you can run inside a virtualization environment in any operating system. This type of installation is the simplest and requires minimum skills.


This type of installation is suitable only for the standalone deployment.


For highload projects, installation as a virtual machine is not recommended even in test mode.


We officially support only VMware as a virtualization environment. Install it prior to proceeding with this instruction.


Contact your NtechLab manager by to request the virtual machine image. You will be provided with files ffserver-*.ovf and disk-*.vmdk (discrete or in an archive).

The virtual machine image has the following software pre-installed:

  • Ubuntu Server 16.04 LTS x64 with no graphical user interface

  • FindFace Enterprise Server SDK in the following configuration:

    Component Details
    findface-facenapi Installed and started with enabled and configured dynamic person creation and “friend or foe” identification.
    findface-server-tarantool (tntapi) Installed and started (1 shard). Sharding may be required.
    findface-tarantool-build- index Installed. Before use, consult the component documentation.
    ffupload Installed and started.
    fkvideo_detector Only installed. Use the command line or FindFace Web UI to manually start it. Before use, consult the component documentation.
    findface-extraction-api Installed and started as a face detector and facen extractor. Consult the component documentation for advanced features.
    NTLS Installed and started.
    FindFace Web UI Installed and started.
    findface-mass-enroll Only installed. Use the command line to work with it. Before use, consult the component documentation.
    nginx Installed and started.
    MongoDB Installed and started.
    Tarantool Database Installed and started.
    jq Installed. Used to pretty-print API responses from FindFace Server.

To deploy FindFace Enterprise Server SDK as a virtual machine, do the following:

  1. Put the ffserver-*.ovf and disk-*.vmdk virtual machine files into the same directory.

  2. Start the virtualization environment. Click Open a Virtual Machine and select the ffserver-*.ovf file. If prompted, convert the file to a VMware format. This may take a while.

  3. After the virtual machine is imported into the virtualization environment, navigate to the virtual machine hardware settings: Edit virtual machine settings ‣ Hardware.


    Refer to the VMware official documentation.

    • Choose the network connection type, given the host networking.

    • By default, the virtual machine hardware is already configured in the way that ensures optimal performance in most medium-load systems. Make sure it meets your project requirements as well. If you are going to simultaneously process several video streams, or maintain a large dataset, you may need to allocate additional resources to the virtual machine RAM and increase the number of CPU cores. Be sure to save the settings.


      You may also need to set up tntapi sharding later on the virtual machine console.

  4. Power on the virtual machine. Wait until Ubuntu is finished starting.

  5. To log in, enter the following credentials: login user, password ntechlab.

  6. Find out the primary network interface IP address of the virtual machine ( in the case study).

    ens33 Link encap:Ethernet HWaddr 00:0c:29:8f:db:d5
    inet addr: Bcast: Mask:
    inet6 addr: fe80::20c:29ff:fe8f:dbd5/64 Scope:Link
    RX packets:37751 errors:0 dropped:0 overruns:0 frame:0
    TX packets:36205 errors:0 dropped:0 overruns:0 carrier:0
    collisions:0 txqueuelen:1000
    RX bytes:5621377 (5.6 MB) TX bytes:39193951 (39.1 MB)
    lo Link encap:Local Loopback
    inet addr: Mask:
    inet6 addr: ::1/128 Scope:Host
    UP LOOPBACK RUNNING MTU:65536 Metric:1
    RX packets:152521 errors:0 dropped:0 overruns:0 frame:0
    TX packets:152521 errors:0 dropped:0 overruns:0 carrier:0
    collisions:0 txqueuelen:1000
    RX bytes:24549909 (24.5 MB) TX bytes:24549909 (24.5 MB)
  7. Assign the primary network interface IP address to the ffupload_url parameter in the findface-facenapi configuration file.

    sudo vi /etc/findface-facenapi.ini
    ffupload_url = ''


    The findface-facenapi.ini content must be correct Python code.

  8. Restart all the FindFace Enterprise Server SDK services.

    sudo service 'findface*' restart
  9. Make the virtual machine IP address static. To do so, open the etc/network/interfaces file and modify the current primary network interface entry as shown in the case study below. Be sure to substitute the suggested addresses with the actual ones, subject to your network specification.


    Be sure to edit the etc/network/interfaces file with extreme care. Please refer to the Ubuntu guide on networking before proceeding.

    sudo vi /etc/network/interfaces
    # The primary network interface
    iface eth0 inet static
  10. Restart networking.

    sudo service networking restart
  11. Upload the FindFace Enterprise Server SDK license file via the local license server web interface at http://<IP_address>:3185/#/ ( in our example).

  12. Create an authentication token. Use it to access the FindFace Web Interface at http://<IP_address>:8000/.