The Files.com Agent is an installable piece of software that allows you to integrate any supported on-premise or cloud system with Files.com.
It provides a convenient method for securely connecting remote file systems with Files.com, allowing you to push and pull files between Files.com and local file systems. Local file systems can include locally attached storage, such as local disks and drives, and network attached storage, such as network drives that use CIFS, SMB, and NFS.
The Agent can be used to integrate your business processes that use on-premise file storage locations with Files.com. It can allow you to use your on-premise folders as sources or destinations for FTP(S), SFTP, AS2, and WebDAV connections. You can make your on-premise folders become sources or destinations for automations and workflows. On-premise folders can become destinations for inboxes, allowing you to easily collect data. Your on-premise folders can become sources for outboxes, share links, and public hosting, allowing for data distribution to any audience. You can also push, pull, or synchronize data between your on-premise folders and other storage providers such as Amazon S3, Microsoft Azure, Google Cloud Storage, Google Drive, BackBlaze B2, Box, Dropbox, Microsoft Sharepoint, Microsoft OneDrive, Rackspace Cloud Files, Wasabi Hot Cloud Storage, and more.
Any attached or mounted storage that the operating system has permission to access can be used with the Agent.
The Files.com Agent is supported on Windows (64bit), Linux, and MacOS (64bit).
The Files.com platform will connect to the Agent using a secure encrypted connection. You will need to open an inbound port from the Internet to the server that is hosting the Agent. The system account running the Agent should have privileges to open a network port. On locked down systems, this may require Administrator privileges.
First, create a Remote Server for the Agent in your Files.com site. Download and install the Agent (Files.com CLI App) to the system that you want the Agent to run on. Download, review, and update the Agent configuration file to meet your needs.
Before attempting to run the Agent, open an inbound port on your firewall from the Internet to the server that is hosting the Agent.
After you've installed the Agent, configured it, and made sure that your firewall isn't blocking any connections to the Agent from Files.com, run the Agent using the configuration file.
Once the Agent is running, you can use its Remote Server on Files.com to access local folders and integrate them with other Files.com features and capabilities. Use a Remote Mount to access local folders interactively through Files.com or use a Remote Sync to push files to, and pull files from, folders on the system that is hosting the Agent.
Type "Remote servers" in the search box at the top of every page, and then click on the matching result. Click the Add new remote server button and select Files.com Agent.
Enter a name for this connection. This internal name is only used to reference this connection to this Agent.
Select the permissions for the Agent. These permissions will restrict Files.com to only be able to perform those actions.
|Read and write||Two way file transmission. Files can be sent to, and retrieved from, the Agent. Files.com will be able to create files and folders, read files and folders, update files and folders, and delete files and folders using the Agent.|
|Read only||One way file transmission. Files can only be retrieved from the Agent. Files.com will be able to read files and folders using the Agent.|
|Write only||One way file transmission. Files can only be sent to the Agent. Files.com will be able to create files and folders, read folders, update files and folders, and delete files and folders using the Agent.|
Click the Save button.
Use the Download configuration file button to download the configuration file.
Once saved, the new Remote Server will be re-opened for further configuration. You can also use the Edit button to re-open the Remote Server for further configuration.
In addition to the instructions for downloading, configuring, and running the Agent, there will be configuration options for selecting your preferences for the Dedicated IPs and Data Regional Routing settings for this Agent.
The options for specifying Dedicated IPs and Data Regional Routing will only appear if your site is configured to allow those options. Dedicated IPs are only available when a Custom Domain has been configured. Data Regional Routing is only available if your top-level, or root, folder is set to a non-USA geographic region.
The Files.com Agent is built into version 2.1 and later of the cross-platform Files.com Command Line Interface (CLI) App.
On the download page, choose the version that matches your operating system.
No installation is necessary. The CLI app is a self contained app which can be stored anywhere on your computer. We recommend placing it in a directory that is contained in the PATH environment variable of your Operating System.
The Files.com Agent uses a single inbound network port, by default port
58550. The Agent also sends a "heartbeat" back to Files.com using port
The Agent will send its heartbeat to Files.com using the general pool of Files.com IP addresses. Make sure that outbound connections to these IP addresses using port
443 are allowed through your firewall.
Files.com will establish an inbound encrypted and authenticated connection, across the Internet, to the Agent.
Configure your firewall and router to forward incoming connections to the Agent using the port specified in the configuration file. The Agent will only accept connections from Files.com. If required, you can configure your firewall for a list of allowed IP addresses from Files.com.
If your site has Dedicated IPs enabled, then Files.com will establish the connection to the Agent from the dedicated IP addresses. The Agent cannot send its "heartbeat" to the dedicated IPs as the Agent is unaware of the dedicated IPs until it receives the response to the heartbeat.
The Files.com Agent is run from the command line. You can use a command line terminal, start it from a script, or configure your system to run it as a system service.
You should first run the Agent manually to test connectivity and functionality. Only after successfully running the Agent manually should you attempt to install it as a system service or start it from a script.
The Agent will only run on the system that it has been installed on. However, it can access network folders that have been mounted on the local system.
Once the Files.com CLI App is installed, and the configuration file is saved onto your system, use the following command to start the Agent:
files-cli agent --config files_agent_config.json
The Agent will connect back to Files.com to register its current status. To confirm the status of the Agent, type "Remote servers" in the search box at the top of every page, and then click on the matching result. Selecting the Edit button for the Agent Remote Server. The following fields will show the Agent status information:
|Agent host||The IP address or Fully Qualified Domain Name (FQDN) of the Agent. This is the address that Files.com will use to connect to the Agent.|
|Agent port||The network port of the Agent. This is the network port that Files.com will use to connect to the Agent.|
|Agent root folder||The top-level folder that the Agent has access to on the server. You will be able to configure multiple Remote Mounts, or Remote Syncs, to any subfolders within this top-level folder.|
|Agent permissions||The permissions that the Agent has been configured with by the system administrator.|
|Agent status||The status of the Agent. When the Agent sends a heartbeat back to Files.com then this status will change from "Waiting for connection..." to "Connected." The "Connected" status confirms that the Agent has been able to "call home" but does not confirm that Files.com will be able to connect back to the Agent through your firewall. Make sure that your firewall has been configured to allow connections to the Agent from Files.com.|
Remote Server Mounts are created by mounting them onto an empty folder in Files.com. This folder should ideally not be the Root of your site, although that is supported if you need it.
From the Files icon on the left, navigate to the location where you want the mounted folder to be and create a new folder. Navigate into the newly created folder and click the Storage Location (Flag icon) button on the top right.
Select Remote Server Mount from the list and select the Agent remote server.
Choose the Remote folder, which is the portion of the remote file system that will be mounted into this folder on Files.com. You can either by leave the default "
/" (i.e., the remote server's root directory) or click on Choose a different folder link and navigate to the remote folder you want to this folder to connect to.
Click the Save button. The folder will reload and immediately list the remote folders/files from the selected remote path.
If you instead prefer to do a Sync with the remote, follow these directions.
From Files, navigate into the folder where you would like to add the remote server sync and click Folder settings > Sync to/from remote server.
Click the Add new remote server sync button to reveal the form.
Select the server you would like to transfer to or from by clicking on the Remote server menu.
Next choose your Sync direction. You have three choices:
|Push to the remote server||This option uploads files and folders from your designated folder in your Files.com site to the remote server.|
|Pull from the remote server||This option downloads files from the remote server and saves them in your designated folder in your Files.com site.|
|Two-way sync||This option will push files from either server to the other so that both servers have the complete collection of all files. If the same file name exists on both servers with different file contents (as determined by file size), the last modification date is used to determine which version to keep. The file with the most recent modification date is then pushed to the other server. This option does not ever delete files from either server.|
You have the option to delete files on the source server after a push or pull. Use the After copying menu to select whether you would like files that are successfully transferred to be deleted from or kept on the source server.
Enter the remote path to or from which you would like files and folders transferred, starting after the folder/directory your remote user lands in upon authentication.
For example: if the remote server has a folder structure
folderA/folderB/folderC, and the user credentials that you have configured your sync server to log in with automatically land that user inside
folderA, then to properly configure your sync folder behavior to transfer files to or from
folderC, you would enter the path as
A single Agent can be used to securely access multiple folders of a system.
root option in the Agent configuration file specifies the top-most folder that the Agent itself is allowed to access.
For example, let's say you want to provide secure access to 3 specific folders on your local Windows Server. In this example we'll say there are 2 folders for trading partners and 1 folder for an internal team:
All of the above folders share the common top-level folder of
C:\ so that is what we'll specify in the Agent configuration file for the
Now we can set up 3 different Remote Mounts, each targeting one of the above lower-level folders. A Remote Mount for Acme will be configured to point to the
C:\Partners\Acme folder via the Agent. Another Remote Mount, for BinaryBros, will be configured to point to the
C:\Partners\BinaryBros folder. A final Remote Mount, for the internal Vendor Relations team, will be configured to point to the
Each Remote Mount is limited to accessing only its corresponding lower-level folder. The Acme users will only be able to access the
C:\Partners\Acme folder, the BinaryBros users will only be able to access the
C:\Partners\BinaryBros folder, and the internal Vendor Relations users will only be able to access the
Installing the Files.com Agent as a system service allows the Agent to automatically start when the system is started or rebooted.
System services allow programs and applications, such as the Agent, to automatically start without requiring a user login. When the Agent is installed as a system service, it will automatically start when the system is powered on and online.
For Windows based systems, the Files.com Agent can be installed as a Windows Service using this command:
files-cli agent install --config files_agent_config.json
To start the service, use this command:
files-cli agent start
You can also open the Windows Services app, select the files-cli entry, right-click on it, and select Start.
To check the status of the service, use this command:
files-cli agent status
To stop the service, use this command:
files-cli agent stop
You can also open the Windows Services app, select the files-cli entry, right-click on it, and select Stop.
To uninstall the service, use this command:
files-cli agent uninstall
Refer to the Systemd documentation of your Linux system for instructions on how to configure the Files.com Agent to start automatically at system startup.
- Systemd documentation for Red Hat based Linux systems.
- Systemd documentation for Debian based Linux systems.
Refer to the Launchd documentation for instructions on how to configure the Files.com Agent to start automatically at system startup.
All actions performed within Agent folders are stored in the corresponding logs in exactly the same way as all other types of Remote Server and History actions are logged.
If you need to enable local logging by the Agent, such as for troubleshooting purposes, then you can specify a log file to save logs to using the
files-cli agent --config files_agent_config.json --log-file-path outputfile.log
To upgrade the Agent, download the latest version of the Files.com Command Line Interface (CLI) App and replace the previous files-cli executable with the newer downloaded version.
Stop and restart the Agent. No changes to the configuration file are required for an upgrade.
If the Agent has been installed as a system service, stop and restart the system service.
Get Instant Access to Files.com
The button below will take you to our Free Trial signup page. Click on the white "Start My Free Trial" button, then fill out the short form on the next page. Your account will be activated instantly. You can dive in and start yourself or let us help. The choice is yours.Start My Free Trial