Linux
Prerequisites
To install the Face SDK, you need to have a 64-bit version of one of these OS versions:
Ubuntu
- Ubuntu 16.04 (xenial)
- Ubuntu 18.04 (bionic)
- Ubuntu 20.04 (focal)
Debian
- Debian 9 (Stretch)
- Debian 10 (Buster)
- Debian 11 (Bullseye)
CentOS
- CentOS 7
- CentOS 8
Info
The SDK is supported on x86_64 or (amd64) architectures.
Available Packages
face-rec-service-cpu
face-rec-service-gpu
A local web service to communicate with reader devices via JavaScript calls using the Socket.IO library. You can view an example web page by opening http://localhost:3000/
The source code of the page can be found in
/usr/share/regula/Examples/LocalServiceExample
Install SDK
Install using the repository
Set up the repository
- Update the
apt
package index and install packages to allowapt
using the repository over HTTPS:
sudo apt-get update
sudo apt-get install -y \
apt-transport-https \
ca-certificates \
curl \
gnupg-agent \
software-properties-common
curl -fsSL https://downloads.regulaforensics.com/repo/ubuntu/regula.gpg | sudo apt-key add -
sudo add-apt-repository \
"deb [arch=amd64] https://downloads.regulaforensics.com/repo/ubuntu \
$(lsb_release -cs) \
stable"
- Update the
apt
package index and install the latest version of SDK, or go to the next step to install a specific version:sudo apt-get update
orsudo apt-get install face-rec-service-cpu
sudo apt-get install face-rec-service-gpu
- To install a specific version of SDK, list the available versions in the repo, then select and install the required version.
a. List the versions available in your repo:
apt-cache madison face-rec-service-cpu
apt-cache madison face-rec-service-gpu
sudo apt-get install face-rec-service-cpu=<VERSION>
sudo apt-get install face-rec-service-gpu=<VERSION>
Set up the repository
- Update the
apt
package index and install packages to allowapt
using the repository over HTTPS:sudo apt-get update
sudo apt-get install -y \ apt-transport-https \ ca-certificates \ curl \ gnupg-agent \ software-properties-common
- Add Regula official GPG key:
curl -fsSL https://downloads.regulaforensics.com/repo/debian/regula.gpg | sudo apt-key add -
- Use the following command to set up the stable repository:
sudo add-apt-repository \ "deb [arch=amd64] https://downloads.regulaforensics.com/repo/debian \ $(lsb_release -cs) \ stable"
Install SDK
- Update the
apt
package index and install the latest version of SDK, or go to the next step to install a specific version:sudo apt-get update
orsudo apt-get install face-rec-service-cpu
sudo apt-get install face-rec-service-gpu
- To install a specific version of SDK, list the available versions in the repo, then select and install the required version.
a. List the versions available in your repo:
apt-cache madison face-rec-service-cpu
apt-cache madison face-rec-service-gpu
sudo apt-get install face-rec-service-cpu=<VERSION>
sudo apt-get install face-rec-service-gpu=<VERSION>
Set up the repository
Install the yum-utils
package (which provides the yum-config-manager
utility) and set up the stable repository.
sudo yum install -y yum-utils
sudo yum-config-manager \
--add-repo \
https://downloads.regulaforensics.com/repo/centos/regula.repo
- Install the latest version of SDK or go to the next step to install a specific version:
or
sudo yum install face-rec-service-cpu
sudo yum install face-rec-service-gpu
- To install a specific version of SDK, list the available versions in the repo, then select and install the required version.
a. List the versions available in your repo:
sudo yum list face-rec-service-cpu --showduplicates | sort -r
sudo yum list face-rec-service-gpu --showduplicates | sort -r
sudo yum install face-rec-service-cpu-<VERSION>
sudo yum install face-rec-service-gpu-<VERSION>
Install from a package
Note
Regula packages require the following dependencies to be installed before SDK is downloaded: debconf (>= 0.2.26), libusb-1.0-0 (>= 2:1.0.20), udev, pcscd, libccid
- Open https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/f/, browse the required package dir and download the .deb file for the SDK version you want to install:
or
wget https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/f/face-rec-service-cpu/<package>.deb
wget https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/f/face-rec-service-gpu/<package>.deb
- Install the SDK:
sudo dpkg -i <package>.deb
Note
Regula packages require the following dependencies to be installed before SDK is downloaded: debconf (>= 0.2.26), libusb-1.0-0 (>= 2:1.0.20), udev, pcscd, libccid
- Open https://downloads.regulaforensics.com/repo/debian/pool/stable/f/, browse the required package dir and download the .deb file for the SDK version you want to install:
or
wget https://downloads.regulaforensics.com/repo/debian/pool/stable/f/face-rec-service-cpu/<package>.deb
wget https://downloads.regulaforensics.com/repo/debian/pool/stable/f/face-rec-service-gpu/<package>.deb
- Install the SDK:
sudo dpkg -i <package>.deb
Note
Regula packages require the following dependencies to be installed before SDK is downloaded: libusb, pcsc-lite
- Open https://downloads.regulaforensics.com/repo/centos/x86_64/stable/Packages/ and download the .rpm file for the SDK version you want to install:
wget https://downloads.regulaforensics.com/repo/centos/x86_64/stable/Packages/<package>.rpm
- Install the SDK:
sudo rpm -ivh <package>.rpm
Set Up License
To access all the capabilities of the Face Web API, a license is required.
To obtain the production license or other purchasing information, please submit an inquiry and our sales team will contact you shortly.
Note
Assuming that the regula.license file is located at your user's home directory "$HOME/regula.license"
1. Copy the regula.license file to the following folder:
sudo cp -ar ~/regula.license /opt/regula/face-rec-service/extBin/unix_x64/cpu/
sudo cp -ar ~/regula.license /opt/regula/face-rec-service/extBin/unix_x64/gpu/
2. Restart the Face Web API service:
sudo systemctl restart face-rec-service.service