Agent Configuration File
Mover generates a Files.com Agent configuration file when you create the Agent connection. Download it from the connection's setup page.
The file uses TOML syntax and can be reviewed and customized by the system administrator before the Agent starts.
Prior to use, the system administrator can review and update the following fields of the TOML file:
root
The top-level directory the Agent can access. Enclose the path in single quotes, such as '/path/to/agent/folder', 'C:\windows\folder', '/mnt/otherserverfolder', or '\\networkservername\c$\folder'. The user or service account running the Agent must have access to the path. Mount network locations on the host before starting the Agent.
permission_set
The Agent's access level. Valid values are read_write, read_only, and write_only.
follow_links
Whether the Agent can follow links to folders outside root. Valid values are true and false. The default is false.
auto_update_policy
How the Agent installs updates. Valid values are always, critical_only, manual_trigger, and never. The default is always.
override_max_concurrent_jobs
The maximum number of jobs the Agent processes at once. The default is 500. Increase this value only after testing the host's available memory and I/O capacity.
show_hidden_files
Whether the Agent can access hidden files and folders on Windows. Valid values are true and false. The default is false.
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:
id
The unique ID for this Agent connection. Do not edit it.
private_key
The private key that authenticates this Agent. Do not edit or disclose it.
subdomain
The Files.com custom subdomain associated with the Agent.
prefer_protocol
The preferred connection protocol. The Agent uses UDP by default and falls back to TCP when UDP is unavailable. Set this to tcp to use only TCP.
dns
The DNS lookup method. Valid values are auto, doh, and system. The default auto method tries public DNS before falling back to system DNS. doh uses DNS over HTTPS through https://cloudflare-dns.com; system uses the host's DNS settings.
proxy_all_outbound
Whether all Agent connections are proxied through Files.com. Enable this when network policy prevents the Agent from connecting directly to external services.
endpoint_override
The custom domain the Agent uses when connecting to Files.com.
log_file
The log file name and location. When blank, the Agent uses its default log location.
log_level
The minimum severity written to the Agent log. Valid values are debug, info, warn, error, and fatal. The default is info; debug produces the largest and most detailed logs.
log_rotate_num
The number of rotated log files to retain. The default is 5.
log_rotate_size
The log file size in MB that triggers rotation. The default is 20. A value of 0 uses the default.
graceful_shutdown_timeout
The number of seconds allowed for in-progress tasks to finish during shutdown. The default is 15. A value of 0 uses the default.
transfer_rate_limit
The Agent upload and download bandwidth cap. The default is unlimited. Set a limit when the Agent must avoid saturating a constrained network. This setting does not control rate limits imposed by a cloud provider.
Last updated
