Agent Configuration File
The Files.com Agent configuration file is generated by Files.com when the Remote Server for the Agent is created.
You can download the configuration file for an existing Agent Remote Server from within its Remote Server settings.
The configuration file is TOML formatted and should be reviewed by the system administrator prior to use. The configuration file is designed (and intended) to be edited manually for customization by the system administrator.
Prior to use, the system administrator should review the following fields of the TOML file:
| Field | Description |
|---|---|
root | This specifies the top-level directory that the Agent has access to. Set this value to a directory location on the system that you wish the Agent to access. Make sure that the path is enclosed in single quotes. For example, '/path/to/agent/folder', 'C:\windows\folder', '/mnt/otherserverfolder', or 'M:\mounted\networkfolder'. |
permission_set | This shows the permissions that your Files.com administrator specified for the Agent. If the system administrator disagrees, they can change this value. Valid options are read_write, read_only, and write_only. |
follow_links | This option specifies whether the Agent is allowed to follow links, allowing access to linked folders that exist outside of the root option. Valid options are true or false. The default is false when this option is omitted from the configuration file. |
override_max_concurrent_jobs | This option adjusts the number of jobs that can be processed simultaneously. By default, it scales based on the number of CPUs multiplied by 4. If the agent is encountering |
show_hidden_files | This option specifies whether the Agent is allowed to access hidden files and folders on Windows based systems. Valid options are true or false. The default is false when this option is omitted from the configuration file. |
Do not edit or change any other fields in the configuration file unless asked to by our Support team.
The other fields of the configuration file are described in the following table:
| Field | Description |
|---|---|
id | The unique remote server ID of the agent. This identifies this remote server on your site. Do not edit or change. |
private_key | The unique key that identifies and authenticates this agent to your site. Do not edit or change. |
subdomain | The unique custom subdomain of the site that this agent is associated with. |
prefer_protocol | The preferred network protocol for the agent to use when connecting with your Files.com site. By default, the agent will try to use the faster UDP protocol but will fall back to using TCP when a UDP connection cannot be established. You can set this option to tcp to force the agent to only use a TCP based connection. When left blank, the default udp setting will be used. |
dns | The DNS lookup method for the agent. The default setting of auto tells the agent to try looking up public DNS information and to fall back to local system DNS information if the public DNS registry cannot be reached. The doh (DNS over HTTPS) option tells the agent to look up public DNS information using https://cloudflare-dns.com. The system option tells the agent to look up DNS information using the local host's DNS settings. |
proxy_all_outbound | This option specifies whether agent connections are proxied via Files.com. This can be useful when the agent resides within a locked down network that prohibits it from connecting directly to internet services and locations. |
endpoint_override | If your site has a custom domain then this option specifies the domain name to use when the agent connects back to your site. |
log_file | The log file name and location. Use this option to specify the log file location. When blank, the default agent log location will be used. |
log_level | Specifies the amount of detail to include in the agent log. The debug option includes all other log levels, provides the most detailed information, and will create the largest log file size. The info option, which includes warn, error, and fatal level information, provides normal operational information about the tasks and operations that the agent is performing. The warn option, which includes error and fatal level information, provides information about unexpected conditions or events. Warnings indicate that the an unexpected condition occurred but the agent continued to function. The error option, which includes fatal level information, provides information about errors that occur during particular tasks or operations. Errors indicate that a specific operation cannot be performed but that the agent continued to function. The fatal option provides information about critical issues that cause the agent to stop working. When blank, the default info level is used. |
log_rotate_num | The number of log files to retain. The default value is 5. |
log_rotate_size | The size in MB that the log file should reach before it is rotated. The default value is 20. Specifying a value of 0 (zero) will cause the default value to be used. |
graceful_shutdown_timeout | The number of seconds that the agent has to complete any in-progress tasks prior to being shut down. The default value is 15. Specifying a value of 0 (zero) will cause the default value to be used. |
transfer_rate_limit | The file transfer (upload/download) rate limit for the agent. The default is no limit. This setting is useful when the agent resides on a low bandwidth network or when rate limiting is required so that the network bandwidth isn't saturated by the Agent. |