Linux

Prerequisites

To install Document Reader Web API you need, a 64-bit version of one of these supported OS versions:
Ubuntu
    Ubuntu 16.04 (xenial)
    Ubuntu 18.04 (bionic)
    Ubuntu 20.04 (focal)
Debian
    Debian 8 (Jessie)
    Debian 9 (Stretch)
    Debian 10 (Buster)
CentOS
    CentOS 7
    CentOS 8
Document Reader Web API is supported onx86_64or(amd64)architectures.

Install Document Reader Web API

Install using the repository

Ubuntu
Debian
CentOS

Set up the repository

1. Update the apt package index and install packages to allow apt using the repository over HTTPS:
1
sudo apt-get update
Copied!
1
sudo apt-get install -y \
2
apt-transport-https \
3
ca-certificates \
4
curl \
5
gnupg-agent \
6
software-properties-common
Copied!
2. Add Regula official GPG key:
1
curl -fsSL https://downloads.regulaforensics.com/repo/ubuntu/regula.gpg | sudo apt-key add -
Copied!
3. Use the following command to set up the stable repository.
1
sudo add-apt-repository \
2
"deb [arch=amd64] https://downloads.regulaforensics.com/repo/ubuntu \
3
$(lsb_release -cs) \
4
stable"
Copied!

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:
1
sudo apt-get update
Copied!
1
sudo apt-get install regula-document-reader-webapi
Copied!
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:
1
apt-cache madison regula-document-reader-webapi
Copied!
b. Install a specific version using the version string from the second column
1
sudo apt-get install regula-document-reader-webapi=<VERSION>
Copied!

Set up the repository

1. Update the apt package index and install packages to allow apt using the repository over HTTPS:
1
sudo apt-get update
Copied!
1
sudo apt-get install -y \
2
apt-transport-https \
3
ca-certificates \
4
curl \
5
gnupg-agent \
6
software-properties-common
Copied!
2. Add Regula official GPG key:
1
curl -fsSL https://downloads.regulaforensics.com/repo/debian/regula.gpg | sudo apt-key add -
Copied!
3. Use the following command to set up the stable repository.
1
sudo add-apt-repository \
2
"deb [arch=amd64] https://downloads.regulaforensics.com/repo/debian \
3
$(lsb_release -cs) \
4
stable"
Copied!

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:
1
sudo apt-get update
Copied!
1
sudo apt-get install regula-document-reader-webapi
Copied!
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:
1
apt-cache madison regula-document-reader-webapi
Copied!
b. Install a specific version using the version string from the second column
1
sudo apt-get install regula-document-reader-webapi=<VERSION>
Copied!

Set up the repository

Install the yum-utils package (which provides the yum-config-manager utility) and set up the stable repository.
1
sudo yum install -y yum-utils
Copied!
1
sudo yum-config-manager \
2
--add-repo \
3
https://downloads.regulaforensics.com/repo/centos/regula.repo
Copied!

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:
1
sudo yum install regula-document-reader-webapi
Copied!
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:
1
sudo yum list regula-reader --showduplicates | sort -r
Copied!
b. Install a specific version by its fully qualified package name
1
sudo yum install regula-document-reader-webapi-<VERSION>
Copied!

Install from a package

Ubuntu
Debian
CentOS
    1.
    Open https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-document-reader-webapi/, browse the required package dir and download the .deb file for the Document Reader Web API version you want to install
    1
    wget https://downloads.regulaforensics.com/repo/ubuntu/pool/stable/r/regula-document-reader-webapi/<package>.deb
    Copied!
    2.
    Install Document Reader Web API
    1
    sudo dpkg -i <package>.deb
    Copied!
    1.
    Open https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-document-reader-webapi/, browse the required package dir and download the .deb file for the Document Reader Web API version you want to install
    1
    wget https://downloads.regulaforensics.com/repo/debian/pool/stable/r/regula-document-reader-webapi/<package>.deb
    Copied!
    2.
    Install Document Reader Web API
    1
    sudo dpkg -i <package>.deb
    Copied!
    1.
    Open https://downloads.regulaforensics.com/repo/centos/x86_64/stable/Packages/ and download the .rpm file for the Document Reader Web API version you want to install
    1
    wget https://downloads.regulaforensics.com/repo/centos/x86_64/stable/Packages/<package>.rpm
    Copied!
    2.
    Install Document Reader Web API
    1
    sudo rpm -ivh <package>.rpm
    Copied!

Set up the license

To access all the capabilities of Regula Document Reader Web API, a license is required.
To obtaining the production license or other purchasing information, please submit an inquiry and our sales team will contact you shortly.
Assuming that regula.license file is located at your user's home directory "$HOME/regula.license"
1. Copy the obtained regula.license file to the specific folder
1
sudo cp -ar ~/regula.license /opt/regula/document-reader-webapi/extBin/unix_x64/
Copied!
2. Restart Document Reader Web API service
1
sudo systemctl restart regula-document-reader-webapi.service
Copied!
Last modified 6h ago