Demo Application

The Document Reader SDK Web Service instance, deployed on the Web Server, is shipped with the pre-installed demo application. This application provides the same functionality that api.regulaforensics.com does, but locally.

Warning

The demo app must be used for testing purposes only. It's strongly recommended to disable the demo app in production for security purposes.

To disable the demo application, use:

config.yaml

service:
  webServer:
    demoApp:
      enabled: false

Available Options

config.yaml

service:
  webServer:
    demoApp:
      enabled: true
      webComponent: 
        enabled: true

Parameter	Type	Default	Description
`enabled`	boolean	`true`	Whether to enable the demo web application, available at the host root URL (for example, `localhost:8080/`).
`webComponent` → `enabled`	boolean	`false`	Whether to use the Web Components for the demo app. That allows you to capture documents with a camera, same as on api.regulaforensics.com. Note that Web Components work only under the HTTPS protocol.

When running the Docker container, no extra steps needed for enabling the Web Component, as it uses the same license as the Web Service.

When running the Web Service on Windows or Linux, you need to manually place the regula.license file to the /app/view/static/assets/files directory. See the examples below.

Linux Windows x64 Windows x86

/opt/regula/document-reader-webapi/view/static/assets/files/regula.license

C:\Program Files\Regula\Document Reader Web API\view\static\assets\files\regula.license

C:\Program Files (x86)\Regula\Document Reader Web API\view\static\assets\files\regula.license