Docbox File Agent Installation

  1. Prerequisites

    • The Docbox File Agent requires a Java 17 or newer runtime and the .NET Framework V4 to run as a Windows service.
    •  A web browser is required to administer and monitor the service after installation. (Refer to Supported Browsers)‍ 

  2. Download the Docbox File Agent

    • Download the docbox-file-agent.zip package from the URL you were supplied with. 
    • Create an installation folder, e.g. C:\DocboxFileAgent and unzip the downloaded package into that folder.

  3. Configure Storage (Optional)

    • Docbox File Agent creates a number of files which are essential to its operation, e.g. a configuration database, a directory to store encrypted keys and a staging folder to temporarily store files when transferring them to Docbox. By default, these files are stored in the directory created above.
    • If you would prefer to store the working files elsewhere, e.g. on another drive, edit the application.properties file and set the base.storage.path property as required. The nominated folder should be secured and, preferably, not a network share.

  4. Configure Proxy Server (Optional)

    • If you need to connect to the Docbox Server via a proxy server, you will need to configure the application.properties file and set the proxy.host and proxy.port properties as required.

  5. Configure Java Path (Optional)

    • The service configuration assumes that the main java.exe executable is available in the path environment variable. If Java is not available on the path, modify the <executable> line in the docbox-file-agent.xml to reference an installed java.exe. 

  6. Configure Service Port (Optional)

    • The web-based administration interface runs on port 9091 by default. If you would prefer to run the service on a different port, edit the docbox-file-agent.xml and modify the server.port setting in the <arguments> line as appropriate.

  7. Configure Service Network Access (Optional)

    • Access to the web-based administration interface is restricted to localhost only by default. 
    • If you would prefer to allow users to access the service from anywhere on your network and to secure it via other means, e.g. your firewall, edit the docbox-file-agent.xml file and remove the server.address=127.0.0.1 parameter in the <arguments> line.

  8. Installing the Windows Service

    • Run the following command to install the Docbox File Agent as a background service: C:\DocboxFileAgent\docbox-file-agent.exe install
    • The service is installed as the LocalSystem user by default. We recommend creating a specific service account, limiting access to the installation and storage folders to that account, and updating the user settings in the Windows Services control panel accordingly.
    • The service will not start automatically on initial install but will start automatically on reboot. The service will also restart automatically if it fails.

  9. Starting the Service

    • You can start the service via the command line or via the Windows Services control panel. 
    • Several additional directories and files are created when the service is run for the first time. These files should not be deleted or manually modified. 
    • To start the service via the command line, run: C:\DocboxFileAgent\docbox-file-agent.exe start
    • Alternatively, to start the service via the Windows Services control panel, locate the “Docbox File Agent” service then press “Start”.

  10. Stopping the Service

    • You can stop the service via the command line or via the Windows Services control panel. 
    • To stop the service via the command line, run:  C:\DocboxFileAgent\docbox-file-agent.exe stop
    • Alternatively, to stop the service via the Windows Services control panel, locate the “Docbox File Agent” service then press “Stop”.