Skip to content

Linux

How to install the Document Reader Web API.

Supported OS

To install the Document Reader Web API, 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 16.04—24.04 18.04—24.04
Debian 9—12 10—12
RHEL 8—9 8—9

Install Document Reader Web API

Using Repository

Set up the repository

1. Update the apt package index and install packages to allow apt 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

2. Add the Regula official GPG key:

curl -fsSL https://downloads.regulaforensics.com/repo/ubuntu/regula.gpg | sudo gpg --no-default-keyring --keyring gnupg-ring:/etc/apt/trusted.gpg.d/regula.gpg --import

curl -fsSL https://downloads.regulaforensics.com/repo/debian/regula.gpg | sudo gpg --no-default-keyring --keyring gnupg-ring:/etc/apt/trusted.gpg.d/regula.gpg --import

sudo chmod 644 /etc/apt/trusted.gpg.d/regula.gpg

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"

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

Install Document Reader Web API

1. Update the apt package index and install the latest version of Document Reader Web API, or go to the next step to install a specific version:

sudo apt-get update

sudo apt-get install regula-document-reader-webapi

2. To install a specific version of Document Reader Web API, 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 regula-document-reader-webapi

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

sudo apt-get install regula-document-reader-webapi=<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 Document Reader Web API

1. Install the latest version of Document Reader Web API or go to the next step to install a specific version:

sudo yum install regula-document-reader-webapi

2. To install a specific version of Document Reader Web API, 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 regula-document-reader-webapi --showduplicates | sort -r

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

sudo yum install regula-document-reader-webapi-<VERSION>

From Package

Info

Regula packages require the following dependencies to be installed before the SDK is downloaded: pcscd, libccid.

  1. Open Regula Downloads repository and download the .deb file for the Document Reader Web API version you want to install:
wget https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-document-reader-webapi/<package>.deb

Info

Regula packages require the following dependencies to be installed before the SDK is downloaded: pcscd, libccid.

  1. Open Regula Downloads repository and download the .deb file for the Document Reader Web API version you want to install:
wget https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-document-reader-webapi/<package>.deb

2. Install Document Reader Web API:

sudo dpkg -i <package>.deb

Info

Regula packages require the following dependencies to be installed before the SDK is downloaded: libusb, pcsc-lite.

  1. Open Regula Downloads repository and download the .rpm file for the Document Reader Web API version you want to install:
wget https://downloads.regulaforensics.com/repo/centos/x86_64/stable/Packages/<package>.rpm

Info

Regula packages require the following dependencies to be installed before the SDK is downloaded: libusb, pcsc-lite.

  1. Open Regula Downloads repository and download the .rpm file for the Document Reader Web API version you want to install:
wget https://downloads.regulaforensics.com/repo/centos/aarch64/stable/Packages/<package>.rpm

2. Install Document Reader Web API:

sudo rpm -ivh <package>.rpm

Resolve Dependencies

Some Linux distributions contain the implicit dependency to the cryptographic library. Depending on the version, install the additional package as follows below:

  • For Debian 11+ and Ubuntu 24.04+ install libcrypt1
sudo apt-get update

sudo apt-get -y install libcrypt1
  • For RHEL 8+ (for example, Rocky Linux 9, RH9, Fedora 36) install libxcrypt-compat
dnf install libxcrypt-compat

Set Up License

To access all the capabilities of Regula Document Reader 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.

Info

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/document-reader-webapi/extBin/unix/

Please make sure that the regula.license file has read, write, and execute file permissions. If not, grant them:

chmod 764 /opt/regula/document-reader-webapi/extBin/unix/regula.license

And the license file ownership is regula:regula for group and owner group. If not, change file owner:

sudo chown regula:regula /opt/regula/document-reader-webapi/extBin/unix/regula.license

2. Restart the Document Reader Web API service:

sudo systemctl restart regula-document-reader-webapi.service

FAQ

The "Take a photo" button doesn't work when running the demo application locally

Have a look at the Demo Application page.