Windows

This section is Windows specific

This chapter guides you through the installation process of SmartFace, including SmartFace prerequisites, SmartFace Platform, and SmartFace Station on Windows OS.

To install the SmartFace on the Windows environment, you need to match some general requirements and have your license ready. If you are not prepared yet, please return to the introduction to installation.

⚠️ Install SmartFace only on a dedicated hardware with sufficient resources, clean operating system with the latest drivers updates and sufficient permitions. Do not install SmartFace on your personal computers to avoid losing personal data or reducing computer performance.

Requirements

There are several requirements on an operation system and other software that is needed for successful installation of the SmartFace Platform on Microsoft Windows.

SmartFace version 4.10 and higher versions require the CPU support AVX2 instruction set, eg Intel Haswell microarchitecture or AMD Zen family

Operating system: Windows Server 2016 (x64), Windows Server 2019 (x64), Windows 10 PRO (x64), Windows 11 PRO (x64)..

  • English language pack with English character set
⚠️ A character set different from English may cause SmartFace installation failure and SmartFace malfunction.
  • Do not use any other Windows 10 edition than Windows 10 PRO edition and use Windows 10 only for evaluation purposes. For production, use Windows Server or Linux OS.
  • Windows 10 N edition is missing Media Feature Pack. It is required that this pack is installed on the machine for proper functioning of the SmartFace Platform.

Download Installation Files

All of the Installation Files are available at our Customer Portal, you can login with your credentials.

ℹ️ Your sales representative will provide you the credentials for the Customer Portal login.
  1. At the Customer Portal access Products on the top menu bar or through Home > Products & Licenses > Products

  1. Click on the name of the SmartFace product and then on the SmartFace page choose the current release version - major version first, then the release itself.

  1. Under the Downloads section you can download all the installation files. Several files have a version number in the file name, such as SmartFace_PreReq_Installer_X.Y.Z.exe (X.Y.Z. is the version number). Please use Installation Files combination from one release only.

Once you have all the necessarry files downloaded, in the Microsoft Windows setup you need to install several packages. The combination of packages might differ per use case. For our initial installation please install the set as follows:

  1. SmartFace Prerequisites
  2. SmartFace Platform
  3. SmartFace Station

Install the SmartFace Prerequisites

Prerequisites can be installed manually, or automatically by using the Prerequisites installer. The Prerequisites installer requires internet connection and it installs and configures the software prerequisites on the server before you start the SmartFace installation.

⚠️ Always use Prerequisites installer from the same release as your SmartFace Platform. For more information about releases and the Prerequisites Installer used please take a look at the Releases.

The installer deploys the following components:

  • MS SQL Server Express 2019

    Prerequisites installer installs the MS SQL Server Express 2019 and sets up a database and creates a database user for the SmartFace Platform. The maximum size of the MS SQL Server Express database is 10 GB and is suitable for small-scale deployments. For advanced, complex and distributed installation please contact us directly for more information. The default parameters are as follows:

    • SQL instance: localhost\sfexpress
    • SA password: smartface
    • DB user: smartface
    • password: smartface

  • RabbitMQ
  • Erlang
  • Microsoft Visual C++ 2015-2019 Redistributable (x64)
  • OpenVINO Toolkit
  • NVIDIA cuDNN
  • NVIDIA TensorRT

    Prerequisites installer installs NVIDIA libraries in the c:\Program Files\innovatrics\smartface directory by default. If the installation directory is different, then these libraries need to be copied manually.

Execute the Prerequisites Installer

  1. Run the SmartFace_PreReq_Installer_X.Y.Z.exe as an administrator (select Run as administrator). Click Next to continue.

  1. Select an installation path or keep it as per default setup, then click Next

  1. The wizard checks whether any of the prerequisites have already been installed. Select the components which you want to install and click Next. By default, all options are selected.

  1. Review the selection and click Install.

  1. Wizard will install all the selected prerequisites. Once the installation is finished, click Finish to restart the computer.

Install the SmartFace Platform

Please make sure you have installed all the prerequisites and deployed the license before starting the SmartFace Platform installation. If you have used the Prerequisites installer, the default values are prefilled.

⚠️ SmartFace license is required for the correct functionality of the Innovatrics SmartFace. It needs to be activated before the installation of the SmartFace. Follow these steps to activate and apply the license.

To install SmartFace Platform, perform the following steps:

  1. Run the SmartFace_Platform_Installer_x64_X.Y.Z.exe installer as an administrator (select Run as administrator).
  2. Accept the license agreement and click Next.

  1. Select a destination, where the SmartFace will be installed. By default, it is C:\Program Files\Innovatrics\SmartFace. Click Next.

ℹ️ If you use the default installation destination and the installation wizard warns you that the folder already exists, you can use the folder anyway.
  1. Fill in the Host settings and click Next.
    • Port for SmartFace API endpoint. The default value is 8099. The API endpoint will be available on the following addresses:
      • Api port: 8098
      • OData Port: 8099
      • GraphQL Port: 8097
    • Choose the availability of the SmartFace API:
      • Externally available: API is available from outside of the server
      • Local only: API is available only from the localhost

  1. Fill in the SQL database connection settings and click Next.

    If you have used the Prerequisites installer, the default values are pre-filled. Otherwise, you should provide the following information:

    • MsSql server instance — an instance of the database engine, e.g.:
      • localhost\sfexpress: default instance of MS SQL Server Express installed by the Prerequisite installer
      • localhost\SQLEXPRESS: default instance of MS SQL Server Express
      • localhost: default instance of MS SQL
    • Database name
    • User name
    • Password

You can also select Advanced connection string settings and build the connection string yourself:

⚠️ The SmartFace Platform services run under the LocalSystem account, so we are not supporting Integrated Security.

The connection string includes the following parameters, which are semicolon-separated:

  • data source=SQLserverinstance; (typically localhost or servername or localhost\SQLEXPRESS)
  • initial catalog=databasename;
  • User ID=username;
  • Password=password;
  • multipleactiveresultsets=False;
  • connect timeout=60;
  1. Fill in the Configuration settings and click Next.

    • Path to NoSql database. By default, it is C:\ProgramData\Innovatrics\SmartFace\Data. It is recommended to use a standalone disk (where the OS is not installed) with enough space for storing images from camera streams;

    • Path to log files. By default, it is C:\ProgramData\Innovatrics\SmartFace

  1. Fill in the RabbitMQ connection parameters and click Next.
    Please provide connection information for RabbitMQ.

  1. Fill in the S3 settings - settings for S3 blob storage (Minio) and click Next.

  1. Setup camera configuration and click Next.

Define the maximum number of cameras that could be registered during installation. This number determines the maximum number of cameras which will be possible to create, as each camera processing is handled by one process (SmartFace_Camera service).

⚠️ If you want to register more cameras after the installation, you would have to start the installer again to reconfigure the SmartFace Platform.

The highest number which can be entered is 100. For each camera, one Windows service needs to be registered.

  1. Set up the Database cleanup and click Next.
  • Set up the daily database cleanup
    • Enable database cleanup (checked by default): Enables the daily database cleanup. Then, fill in Time of day when the daily database cleanup should run. The time is specified in the hh:mm:ss format in the UTC time zone.
  • Set up the cleanup of SQL and NoSQL records related to faces and images.
    • For removed images also delete (checked by default): Deletes all SQL and NoSQL records related to faces and images. To delete only full images from streams in the NoSQL database, clear this checkbox.
    • Deleted stored images: cleanup process deletes all image data older than the entered value (in days).
  • Set up the cleanup of match results.
    • Enable if you want to cleanup also match results for faces which are no longer present in database (were deleted).

  1. Set up the OpenVino configuration and click Next.
    • required for body parts detection

  1. Set up the GPU configuration and click Next. Windows services with GPU support will be installed on the system that belong to the CPU services.

  1. Click Install to initialize the SmartFace Platform installation.

  1. Once the installation is sucessfully finished, please click Finish.

Install the SmartFace Station

Please make sure the SmartFace Platform is installed before proceeding with the SmartFace Station installation. To install SmartFace Station please perform the following steps:

  1. Run the SmartFace_Station_Installer_vX_Y_Z.exe as an administrator (select Run as administrator). Click Next to continue.

  1. Choose the installation location and click Install.

  1. Once the installation is completed sucessfully you can set URL, endpoints and ports for the SmartFace Station. Once set, click Next.
  • SmartFace core server API URL - the URL where the Swagger and the REST API is available.
  • SmartFace ODATA API URL - the URL where the Swagger and the ODATA API is available.
  • Address to Access Controller gRPC endpoint - the URL that SmartFace Station connects to receive gRPC notifications from the Access Controller module.
  • Host (IP address where SF Station server listens for requests) - the default 0.0.0.0 means that all IPv4 addresses are listened to.
  • Port (port where SF Station server listens for requests) - the default is 8000. This is where you access SmartFace Station with your browser.

  1. Additional settings can be adjusted, such as Blacklisted watchlists - watchlists of member with restricted access or to setup the Keycloak Authentication. Click Next.

Apply License

Open the License Manager and click on the Deploy license tab. Click the License file: button and choose the license file. Once the correct file is selected, select to activate the license for Everyone and click on the Deploy license button.

After a successful deployment you can see the license in the License information tab. If you do not see your license please click Refresh.

Run the SmartFace

Once the SmartFace is successfully installed it will be up and running automatically.

Validate your Installation

Once the services are up and running you can visit the port 8000 on your installation machine in your preferred browser. Such as the URL: http://localhost:8000

After the SmartFace Platform is installed, you can also view the status of the following services in Task Manager services tab (depending on your installation settings). These services should be in running state.

You can also get the list of running services with the following command: Get-Service -Name "SF*". Please keep in mind this is not the final list and the list presented will differ based on your installation.

The results would be as below:

Status   Name               DisplayName
------   ----               -----------
Running  SFAccessController SmartFace AccessController
Running  SFApi              SmartFace API Service
Running  SFBase             SmartFace Base Service
Running  SFBodyPartsDete... SmartFace Pedestrian with body part...
Running  SFCam1             SmartFace Camera 1 Service
Running  SFCam10            SmartFace Camera 10 Service
Running  SFCam11            SmartFace Camera 11
Running  SFCam2             SmartFace Camera 2 Service
Running  SFCam3             SmartFace Camera 3 Service
...

To ensure the proper functioning system and to get your first own real world results, we can do few more things:

  1. Add a camera
  2. Register yourself into a watchlist
  3. Get your first identification

Add a camera

  1. Click on Cameras in the left menu panel.
  2. Click on button REGISTER CAMERA.

  1. Enter the Name and RTSP / Video source.

  1. To create a new camera, click on ADD CAMERA.

  2. Click on registered camera in camera list to open camera configuration.

  3. In camera configuration detail you can enable camera by clicking on toggle switch Enabled.

Register yourself into a watchlist

  1. Go to Watchlists in the left panel.

  2. Select ADD WATCHLIST.

  1. Type the name of your watchlist and confirm with CREATE WATCHLIST.

  1. Upload a photo by dropping the photos directly onto the marked area or by choosing photo on your computer. You can also take photo (in this case your selfie) using the device built-in camera or a USB camera connected to your computer

  2. After you uploaded photos of watchlist members, click NEXT.

  1. Type the FULL NAME for uploaded watchlist member. You may also add a note by specifying the NOTE field.

  1. Click NEXT.

  2. Specify the matching THRESHOLD and CONFIRM. For more information what is the matching threshold, see Matching

Get the First Identification

  1. Go to the Security dashboard in the left menu.

  2. Click on Camera preview settings

  1. For each camera you can choose left or right side, where the camera preview will be showed. For example the left side. For each side only one camera can be shown at the same time. Then go back to the Security dashboard.

  1. Click on Recent event setting

  1. Switch on your camera by clicking on the icon next to the name of your camera (it will appear green)

  1. Go in front of your camera.

  2. This is your first identification!

You are matched against to watchlist. Check out SmartFace Station. The match notification you can see in Security dashboard in Recent event settings section and also in History event page.

  1. You can display notification detail by clicking on the notification.

Notification detail provides you more details about watchlist member (in this case it is information about you), for example: name, notes, age, gender and many other attributes. More about notifications, you can find here.

Your matchresult is also displayed in History event page.

Next steps

Congratulations! Your SmartFace Windows deployment is up and running.

  • For more information about the SmartFace Platform and to reveal what functionality SmartFace has, please visit the manuals.
  • To find out complex solutions, please read the guides section offering in depth information and step by step instructions.
  • For developers and integrators, we recommend to take a look at the Integration section where you find out how to use our APIs, extended modules and hands on knowledge about sample projects.