Linux

Prerequisites

To install the SDK, you need a 64-bit version of one of the following supported OS versions (see the table below).

OS / Architecture	x86_64 (amd64)	aarch64 (arm64)
Ubuntu	20.04—24.04	20.04—24.04
Debian	11—12	11—12
RHEL	9	9

Available packages

regula-drivers

Software drivers for Regula devices, combined in the single package.

regula-reader

Core SDK for support of optical and RFID reader devices.

regula-reader-dev

Resources for developers:

documentation
examples
headers

Documentation and examples can be found in the following folder:

/usr/share/regula

regula-reader-service

Warning

Available only for x86_64 (amd64)

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/. You can find the source code of the page here:

/usr/share/regula/Examples/LocalServiceExample

Install SDK

Install Using Repository

DEBRPM

Ubuntu Debian

Set up the repository

1. Update the apt package index and install packages to allow apt to use repositories over HTTPS:

sudo apt-get update

sudo apt-get install -y \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
    software-properties-common

2. Add the official Regula GPG key:

curl -fsSL https://downloads.regulaforensics.com/repo/ubuntu/regula.gpg | sudo apt-key add -

3. Use the following command to set up the stable repository:

sudo add-apt-repository \
    "deb [arch=$(dpkg --print-architecture)] https://downloads.regulaforensics.com/repo/ubuntu \
    $(lsb_release -cs) \
    stable"

Install Regula Packages

DriversSDKService

1. Update the apt package index and install the latest version of the drivers, or proceed to the next step to install a specific version:

sudo apt-get update

sudo apt-get install regula-drivers

2. To install a specific version of the drivers, list the available versions in the repo, then select and install the required one:

a. List the versions available in your repo:

apt-cache madison regula-drivers

b. Install a specific version using the version string from the second column:

sudo apt-get install regula-drivers=<VERSION>

1. Update the apt package index and install the latest version of the SDK, or proceed to the next step to install a specific version:

sudo apt-get update

sudo apt-get install regula-reader

2. To install a specific version of the SDK, list the available versions in the repo, then select and install the required one:

a. List the versions available in your repo:

apt-cache madison regula-reader

b. Install a specific version using the version string from the second column:

sudo apt-get install regula-reader=<VERSION>

1. Update the apt package index and install the latest version of the reader service, or proceed to the next step to install a specific version:

sudo apt-get update

sudo apt-get install regula-reader-service

2. To install a specific version of the reader service, list the available versions in the repo, then select and install the required one:

a. List the versions available in your repo:

apt-cache madison regula-reader-service

b. Install a specific version using the version string from the second column:

sudo apt-get install regula-reader-service=<VERSION>

Set up the repository

1. Update the apt package index and install packages to allow apt to use repositories over HTTPS:

sudo apt-get update

sudo apt-get install -y \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
    software-properties-common

2. Add the official Regula GPG key:

curl -fsSL https://downloads.regulaforensics.com/repo/debian/regula.gpg | sudo apt-key add -

3. Use the following command to set up the stable repository:

sudo add-apt-repository \
    "deb [arch=$(dpkg --print-architecture)] https://downloads.regulaforensics.com/repo/debian \
    $(lsb_release -cs) \
    stable"

Install Regula Packages

DriversSDKService

1. Update the apt package index and install the latest version of the drivers, or proceed to the next step to install a specific version:

sudo apt-get update

sudo apt-get install regula-drivers

2. To install a specific version of the drivers, list the available versions in the repo, then select and install the required one:

a. List the versions available in your repo:

apt-cache madison regula-drivers

b. Install a specific version using the version string from the second column:

sudo apt-get install regula-drivers=<VERSION>

1. Update the apt package index and install the latest version of the SDK, or proceed to the next step to install a specific version:

sudo apt-get update

sudo apt-get install regula-reader

2. To install a specific version of the SDK, list the available versions in the repo, then select and install the required one:

a. List the versions available in your repo:

apt-cache madison regula-reader

b. Install a specific version using the version string from the second column:

sudo apt-get install regula-reader=<VERSION>

1. Update the apt package index and install the latest version of the reader service, or proceed to the next step to install a specific version:

sudo apt-get update

sudo apt-get install regula-reader-service

2. To install a specific version of the reader service, list the available versions in the repo, then select and install the required one:

a. List the versions available in your repo:

apt-cache madison regula-reader-service

b. Install a specific version using the version string from the second column:

sudo apt-get install regula-reader-service=<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/rhel/9/regula.repo

Info

If you are using a RHEL-based OS version earlier than 9, use the following repository. However, note that support for RHEL-based OS versions older than 9 ended with Document Reader SDK version 7.6.

https://downloads.regulaforensics.com/repo/centos/regula.repo

Install Regula Packages

DriversSDKService

1. Install the latest version of the drivers, or proceed to the next step to install a specific version:

sudo yum install regula-drivers

2. To install a specific version of the drivers, list the available versions in the repo, then select and install the required one:

a. List the versions available in your repo:

sudo yum list regula-drivers --showduplicates | sort -r

b. Install a specific version by its fully qualified package name:

sudo yum install regula-drivers-<VERSION>

1. Install the latest version of the SDK, or proceed to the next step to install a specific version:

sudo yum install regula-reader

2. To install a specific version of the SDK, list the available versions in the repo, then select and install the required one:

a. List the versions available in your repo:

sudo yum list regula-reader --showduplicates | sort -r

b. Install a specific version by its fully qualified package name:

sudo yum install regula-reader-<VERSION>

1. Install the latest version of the reader service or proceed to the next step to install a specific version::

sudo yum install regula-reader-service

2. To install a specific version of the reader service, list the available versions in the repo, then select and install the required one:

a. List the versions available in your repo:

sudo yum list regula-reader-service --showduplicates | sort -r

b. Install a specific version by its fully qualified package name:

sudo yum install regula-reader-service-<VERSION>

Install from Package

DEBRPM

Ubuntu Debian

Info

Regula packages require the following dependencies to be installed before downloading:

debconf (>= 0.2.26)
libusb-1.0-0 (>= 2:1.0.20)
udev
pcscd
libccid

DriversSDKService

1. Open https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-drivers/, browse the required package directory and download the .deb file for the drivers version you want to install:

wget https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-drivers/<package>.deb

2. Install the drivers:

sudo dpkg -i <package>.deb

1. Open https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-reader/, browse the required package directory and download the .deb file for the SDK version you want to install:

wget https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-reader/<package>.deb

2. Install the SDK:

sudo dpkg -i <package>.deb

1. Open https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-reader-service/, browse the required package directory and download the .deb file for the reader service version you want to install:

wget https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-reader-service/<package>.deb

2. Install the reader service:

sudo dpkg -i <package>.deb

Info

Regula packages require the following dependencies to be installed before downloading:

debconf (>= 0.2.26)
libusb-1.0-0 (>= 2:1.0.20)
udev
pcscd
libccid

DriversSDKService

1. Open https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-drivers/, browse the required package directory and download the .deb file for the drivers version you want to install:

wget https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-drivers/<package>.deb

2. Install the drivers:

sudo dpkg -i <package>.deb

1. Open https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-reader/, browse the required package directory and download the .deb file for the SDK version you want to install:

wget https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-reader/<package>.deb

2. Install the SDK:

sudo dpkg -i <package>.deb

1. Open https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-reader-service/, browse the required package directory and download the .deb file for the reader service version you want to install:

wget https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-reader-service/<package>.deb

2. Install the reader service:

sudo dpkg -i <package>.deb

x86_64 (amd64)aarch64 (arm64)

Info

Regula packages require the following dependencies to be installed before downloading:

libusb
pcsc-lite

1. Open https://downloads.regulaforensics.com/repo/rhel/9/x86_64/stable/Packages/ and download the .rpm file for the package version you want to install:

wget https://downloads.regulaforensics.com/repo/rhel/9/x86_64/stable/Packages/<package>.rpm

Info

Regula packages require the following dependencies to be installed before downloading:

libusb
pcsc-lite

1. Open https://downloads.regulaforensics.com/repo/rhel/9/aarch64/stable/Packages/ and download the .rpm file for the package version you want to install:

wget https://downloads.regulaforensics.com/repo/rhel/9/aarch64/stable/Packages/<package>.rpm

2. Install the downloaded package:

sudo rpm -ivh <package>.rpm