Local Installation
Handl is a server-side solution. If you want to test it, use the web demo. We do not use long-term data storage, all incoming files are transferred to the server via a secure protocol, processed in RAM and deleted immediately after the results are returned to the user.
Use the instructions below if you want to deploy a Handl solution in your own closed IT loop.
Hardware Requirements
Configuration scenarios:
1. Minimum - no more than 1 document per minute
Processor: 6 cores, 4.1 GHz, AVX 2 expansion; benchmark: Intel Core i5-10600KF
RAM: 32 Gb
Mass storage: 500 Gb SSD
2. Standard - up to 60 documents per minute
Graphics Card: Nvidia Tesla T4
Processor: 8 cores, 3.9 GHz, AVX 2 expansion; Benchmark: Intel Xeon W-2245
RAM: 64GB
Disk Drive: 1 Tb NVMe
3. Corporate - up to 600 documents per minute
Graphics Card
Nvidia Tesla T4 x2
Processor: 8 cores, 3.9 GHz, AVX 2 expansion; benchmark: Intel Xeon W-2245 x2
RAM: 128GB
Storage: 1 Tb NVMe x2
The above are the hardware requirements for productive operation. Handl also runs on weak configurations, such as a Core i5-8250U 1.6 GHz / 8 Gb RAM / 250 Gb SSD laptop. However, performance on such weak configurations is not guaranteed
Environment requirements:
Ubuntu operating system version 18.04
Docker container management system
docker-compose
Nvidia drivers with the latest version available:
nvidia-docker
Nvidia drivers with the latest version available
CUDA version 11.1 or later
Internet access for license conformation:
https://license.ml.handl.ai/check/v2
Dynamic IP
Port: 443
Protocol: TCP
Request: POST
Configuration files
I. docker-compose.yml
Create a docker-compose.yml file depending on the specification of your server.
Copy the following settings:
II. env и nginx.conf
Create file .env:
Copy the following settings:
Download the nginx.conf file:
Put the three files docker-compose.yml, .env, and nginx.conf in the same directory.
Running Handl
Navigate to the directory containing the three configuration files. Type the following command at the command line:
You are all set! You can now use the local version of the web demo by opening the http://localhost:8080 link in your browser. You can also access the server using the API.
Instructions for using Debian 10 (buster) + Nvidia Tesla T4 (example)
Add non-free contrib repositories to /etc/apt/sources.list:
deb http://deb.debian.org/debian buster-backports main non-free contrib
deb-src http://deb.debian.org/debian buster-backports main non-free contrib
apt updateapt install linux-headers-$(uname -r) make gcc acpid dkms nvidia-tesla-418-driver nvidia-tesla-418-smi nvidia-cuda-toolkitsystemctl reboot
After that, follow the instructions in Ubuntu related section.
You can install Handl on a Windows 10 computer. To do this, you will need to perform the following steps.
1. Install Docker
Download the Docker installer from the official website. We recommend using the version from the Stable channel.
Run the installer and follow the instructions on the screen. At the end of the installation, you need to reboot your computer.
After restarting, check the notification area in the bottom right corner. If the whale icon isn't there, your account probably doesn't have permissions to run Docker. If this is the case, type the word Docker into the search box. Right-click on the Docker Desktop application and select "Run as administrator"
2. Install PowerShell
Download the PowerShell installer from the official repository. We recommend using a stable version from the Windows (x64) line.
Run the installer and follow the instructions on the screen.
Type the word PowerShell into the search box. Right-click on the PowerShell application and select "Run as administrator".
3. Verify that the environment is prepared
Run the
docker versioncommand in PowerShell.Run the
docker run hello-worldcommand.If you don't get any errors in these two steps, then everything is working fine
4. Prepare the .env configuration file
Create a folder on your computer with any name, for example Handl. Create an untitled file with an .env extension. Open that file with a text editor, for example Notepad, and copy there the contents of the window below:
Replace the "your_key_license" text with your license key. Save the resulting file in the Handl folder.
5. Prepare the docker-compose.yml and nginx.conf configuration files
Download the docker-compose.yml file and nginx.conf:
Put these files in the Handl folder.
6. Give Docker access to the folder with the configuration files
Right-click the Docker icon in the bottom right corner of the screen
Select Settings from the drop down menu
Select the Resources section, File Sharing sub-item.
Click on the blue plus icon in the circle and specify the path to the Handl directory, for example
C:\HandlClick Apply & Restart button
7. Running Handl
Go back to the PowerShell that you started in step 2.
Navigate to the Handl folder using the command
cd C:\HandlRun the
docker-compose up -d --force-recreatecommand and wait for all containers to finish their start up
You are all set!
You can now use the local version of the web demo by opening the http://localhost:8080 link in your browser.
You can also access the local version of Handl using the API. To do this:
Put an image of a passport or other type document in the Handl folder.
In PowerShell, run
curl -X POST "http://localhost:12345/recognize?doc_type=passport_main&quality=75&dpi=300&auto_pdf_raw_images=true&pdf_raw_images=true&token=ваш_ключ_лицензии" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "image=@C:\Handl\Pasport_RF.jpg;type=image/jpeg"
Last updated