Skip to content

Configuration

This article shows an example configuration for the docker deployment but can be easily adapted to all the provided platforms.

HTTPS

Run nginx as a frontend container for HTTPS processing and proxy service requests to the backend docreader container. Here you can find the docker-compose.yml file and the Nginx default.conf file for a reference.

Option 2. Docreader via HTTPS

To run the docreader service via HTTPS: - add 644 permissions to certificates so the server is able to read certificates - pass cert.crt & cert.key files to the container - pass DOCREADER_HTTPS environment variable - forward container port to 8443 host port

chmod 644 ~/cert.crt ~/cert.key
docker run -it -p 8443:8080 -v ~/regula.license:/app/extBin/unix_x64/regula.license -v ~/cert.crt:/app/certs/tls.crt -v ~/cert.key:/app/certs/tls.key -e DOCREADER_HTTPS="true" regulaforensics/docreader

Logging

Access logs

The Document Reader Access logs are a gunicorn server Access log file. To enable the Document Reader Access logs, set the ENV variable DOCREADER_LOGS_ACCESS_FILE to true. You may customize the access log file location via the DOCREADER_LOGS_ACCESS_FILE_PATH ENV variable.

To get access to the Access log file from the host machine, it is required to:

  1. Create a folder for logs and ensure the group is root and group members have the write & execute permissions over the created folder.
  2. Mount the host folder to the application log folder inside the container.
    mkdir ~/docreader-logs
    chmod g+wx ~/docreader-logs
    sudo chgrp root ~/docreader-logs
    
docker run -p host_port:8080 -v host_path_to_license_folder/regula.license:/app/extBin/unix_x64/regula.license -v ~/docreader-logs:/app/logs -e DOCREADER_LOGS_ACCESS_FILE="true" regulaforensics/docreader

Application logs

The Document Reader Application logs are a gunicorn server Application log file. To enable the Document Reader Application logs, set the ENV variable DOCREADER_LOGS_APP_FILE to true. You may customize the application log file location via the DOCREADER_LOGS_APP_FILE_PATH ENV variable.

To get access to the Application log file from the host machine, it is required to:

  1. Create a folder for logs and ensure the group is root and group members have write & execute permissions over the created folder.
  2. Mount the host folder to the application log folder inside the container.
    mkdir ~/docreader-logs
    chmod g+wx ~/docreader-logs
    sudo chgrp root ~/docreader-logs
    
docker run -p host_port:8080 -v host_path_to_license_folder/regula.license:/app/extBin/unix_x64/regula.license -v ~/docreader-logs:/app/logs -e DOCREADER_LOGS_APP_FILE="true" regulaforensics/docreader

Processed results logs

The Document Reader Processed results logs are the artifacts of the processed request. To enable the processed results logs, set the ENV variable DOCREADER_PROCESS_RESULTS_LOG_FILE to true. You may customize the processed results log folder path via the DOCREADER_PROCESS_RESULTS_LOG_PATH ENV variable. To get access to the processed results logs from the host machine, it is required to:

  1. Create a folder for logs and ensure the group is root and group members have write & execute permissions over the created folder.
  2. Mount the host folder to the application log folder inside the container.
    mkdir ~/docreader-logs
    chmod g+wx ~/docreader-logs
    sudo chgrp root ~/docreader-logs
    
docker run -p host_port:8080 -v host_path_to_license_folder/regula.license:/app/extBin/unix_x64/regula.license -v ~/docreader-logs:/app/logs -e DOCREADER_PROCESS_RESULTS_LOG_FILE="true" regulaforensics/docreader

RFID PKD

To verify PA for the RFID sessions:

  1. Create a folder and copy masterlists there.
  2. Mount the host folder to the folder inside the container and point to that specific folder using the RFID_PKD_PA_PATH ENV variable or simply enable RFID_PKD_PA ENV variable (uses default masterlists location "/app/rfid_pkd").
mkdir ~/masterlists
cp *.ldif ~/masterlists/

RFID_PKD_PA option

docker run -it -p 8080:8080 -v ~/regula.license:/app/extBin/unix_x64/regula.license -v ~/masterlists:/app/rfid_pkd -e RFID_PKD_PA="true" regulaforensics/docreader

RFID_PKD_PA_PATH option

docker run -it -p 8080:8080 -v ~/regula.license:/app/extBin/unix_x64/regula.license -v ~/masterlists:/app/masterlists -e RFID_PKD_PA_PATH="/app/masterlists" regulaforensics/docreader