How to Change the Server Address in Document Reader Web API

Table of Contents

• Prerequirements
• Required Actions
• Result Verification
• Common Errors and Solutions

Summary

This guide explains how to change the server address in the Document Reader Web API configuration file and ensure the service operates correctly with the new settings.

Prerequirements

• Access to the configuration file:
  • C:\Program Files\Regula\Document Reader Web API\.env for version x64
  • C:\Program Files (x86)\Regula\Document Reader Web API\.env for version x86
• Administrator rights to edit the file and restart the service.

Required Actions

1. Open the corresponding .env file in a text editor with administrator privileges.
2. Locate the parameter DOCREADER_BIND.
3. Change the value of the parameter to the desired server address. For example:
   • "0.0.0.0:8080" for HTTP
   • "0.0.0.0:443" for HTTPS
4. Save the changes to the file.
5. Restart the Regula Document Reader Service to apply the new settings.

Result Verification

To ensure that the changes have been applied:

• Check the availability of the new server address through a browser or the corresponding client.
• Verify that the Regula Document Reader Service is running and functioning correctly.

Common Errors and Solutions

• Error: "Access Denied" when saving the file.
  • Solution: Ensure that you opened the text editor with administrator privileges.
• The service does not start after changing the settings.
  • Solution: Check the address format in the DOCREADER_BIND parameter. It must match the format "IP:PORT".