OptimiDoc Server Help Center
OptimiDoc Server Help Center
Breadcrumbs

FTP Configuration

FTP Configuration is how OptimiDoc receives scans from certain multifunction devices. OptimiDoc does not run an FTP server of its own — instead it points a device at an existing external FTP server and watches the local folder where those uploads land, turning each new file into a scan job. Konica Minolta and Epson devices use this path; Xerox no longer does.

https://optimidoc.atlassian.net/wiki/download/attachments/42533128/ftp-config.png?api=v2

Screenshot: FTP Configuration settings

This is not the scan-to-FTP destination. Sending scanned documents out to an FTP server is configured on an FTP scan destination and is a completely separate mechanism. The settings on this page are strictly for ingesting scans that devices push in over FTP.

Overview

Some MFP families deliver a scan by uploading the file to an FTP server rather than posting it to OptimiDoc directly. To support them, OptimiDoc needs to know two things: where the device should upload (the external FTP server and folder it advertises to the device) and where those files appear on disk (a local folder it can watch). When a new file shows up in the watched folder, OptimiDoc picks it up and runs it through the normal scan pipeline.

Because OptimiDoc is not itself the FTP server, you must provide one. In practice the FTP server's upload directory and OptimiDoc's Local Path are the same physical folder — either the FTP server runs on the OptimiDoc host, or both point at shared storage.

Accessing FTP Configuration

  1. Open the React administration interface as an Admin user.

  2. Go to Settings in the left sidebar (route /config).

  3. Select the FTP tab.

How It Works

  1. OptimiDoc hands the device the FTP Server, Port, Remote Path and credentials (for Konica Minolta via its FTP image-transfer setting, for Epson via its scan configuration).

  2. The user scans at the device, which uploads the resulting file to that FTP server.

  3. The FTP server writes the file into the folder OptimiDoc knows as Local Path.

  4. A directory monitor watches Local Path and reacts to new files whose names match the vendor patterns — Konica Minolta (*_2.kmcf), Epson (epson*) and legacy Xerox (*.xst).

  5. Each matched file becomes a job in the scan pool and is processed like any other scan.

Settings

Setting

Description

FTP Server

Hostname or IP of the external FTP server that devices upload to (e.g. ftp.example.com or 192.168.1.50). Advertised to the device.

Port

The FTP control port. Defaults to 21.

Remote Path

The directory on the FTP server that the device uploads into (default /). This is the FTP-visible path, not a Windows path.

Local Path

The Windows folder OptimiDoc watches for incoming files (e.g. C:\OptimiDoc\FTP). It must be the same physical location the FTP server writes uploads to. The configuration is only considered active once this folder exists.

Username / Password

Credentials the device uses to authenticate to the FTP server. The password is masked; leave it blank to keep the stored value.

Testing the Connection

Test Connection opens a connection to the external FTP server and lists the Remote Path directory using the configured credentials, with a ten-second timeout. It confirms that the FTP server is reachable and the credentials and remote path are valid.

The test only checks the outbound FTP connection. It does not verify that the Local Path watcher is working or that the FTP server actually writes into that folder — those depend on how your FTP server maps its home directory to disk.

Troubleshooting

Issue

Resolution

Connection refused

Verify the FTP server address and port and that the FTP service is running.

Authentication failed

Check the username and password and that the account can access the remote path.

Timeout

Check connectivity between OptimiDoc and the FTP server and that firewalls allow FTP on the configured port.

Files upload but nothing is processed

The FTP upload directory and Local Path are not the same folder, or the filenames do not match the expected vendor patterns. Confirm the FTP home directory maps to the watched folder.

In Summary

Use this page only when Konica Minolta or Epson devices deliver scans over FTP. Stand up an FTP server, point its upload directory at the folder you enter as Local Path, fill in the server, port, remote path and credentials that the device will use, and confirm reachability with Test Connection. OptimiDoc then watches that folder and ingests every scan that arrives. To send scans out to an FTP server, use an FTP scan destination instead.

Related articles