Docker

How to install Regula FaceAPI SDK.

• Distribution channels and general info
• Windows 10/11
• Linux and macOS:

Distribution channels and general info

We distribute our container images via the following container registries:

• hub.docker.com
• catalog.redhat.com

Images are RedHat Certified and fully identical. The face-api image is based on the official ubi8-minimal image, maintained by RedHat. The image is configured to be run as an arbitrarily assigned UID (OpenShift-ready).

Windows 10/11

1. Install Docker Desktop by following the instructions based on your Windows edition:

   • Installing Docker Desktop on Windows 10 Pro, Enterprise, and Education
   • Installing Docker Desktop on Windows 10 Home

2. Start the Docker Desktop application.

3. Put your license to your Desktop directory.

4. Open the Command line and execute the following command:

   docker run -d -p 41101:41101 -v C:\%HOMEPATH%\Desktop\regula.license:/app/extBin/unix_x64/cpu/regula.license regulaforensics/face-api:latest
   

   Hint. To open the Command line, press the WIN button, type 'cmd', and press Enter.

5. To make sure that the service is up and running, enter the http://localhost:41101/ address in a web browser.

Warning

Docker Desktop doesn't support Windows Server version installation.

Linux and macOS:

1. Install Docker Engine:

   • Linux platforms
   • Installing Docker Desktop on Mac

2. Put your license to your user's home (/home/username/) directory.

3. Open a terminal and execute:

   docker run -p 41101:41101 -v ~/regula.license:/app/extBin/unix_x64/cpu/regula.license regulaforensics/face-api:latest
   

4. To make sure that the service is up and running, enter the http://localhost:41101/ address in a web browser.