# Agent Configuration File

The Files.com Agent configuration file is generated when the Connection for the Agent is created. You can download the configuration file from the Connection's setup page.

The configuration file is [TOML](https://en.wikipedia.org/wiki/TOML) formatted so that it is both human-readable and machine-readable. The configuration file is designed (and intended) to be edited manually for customization by the system administrator. This gives a system administrator the opportunity to review an Agent's configuration in cases where the Agent was created by someone else.

Prior to use, the system administrator can review and update the following fields of the TOML file:

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"></td><td valign="top"></td></tr><tr><td valign="top"><code>root</code></td><td valign="top">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, <code>'/path/to/agent/folder'</code>, <code>'C:\windows\folder'</code>, <code>'/mnt/otherserverfolder'</code>, or <code>'\\networkservername\c$\folder'</code>. The specified path location must have the correct access permissions for the user, or service account, that is running the Agent. Network mount locations must be mounted on the host system, with the correct access permissions, prior to use by the Agent.</td></tr><tr><td valign="top"><code>permission_set</code></td><td valign="top">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 <code>read_write</code>, <code>read_only</code>, and <code>write_only</code>.</td></tr><tr><td valign="top"><code>follow_links</code></td><td valign="top">This option specifies whether the Agent is allowed to follow links, allowing access to linked folders that exist outside of the <code>root</code> option. Valid options are <code>true</code> or <code>false</code>. The default value is <code>false</code> when this option is omitted from the configuration file.</td></tr><tr><td valign="top"><code>auto_update_policy</code></td><td valign="top">This option controls how the Agent updates itself. Valid options are <code>manual_trigger</code>, <code>critical_only</code>, <code>always</code> and <code>never</code>. When set to <code>always</code>, the Agent will update itself whenever there is a new version available. When set to <code>critical_only</code>, the Agent will update only to versions that solve reliability, performance, or security issues. When set to <code>never</code>, the Agent will not update itself. When set to <code>manual_trigger</code>, the Agent will only update itself when manually triggered from Files.com. The default value is <code>manual_trigger</code>.</td></tr><tr><td valign="top"><code>override_max_concurrent_jobs</code></td><td valign="top">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 <code>job queue is full</code> errors, you may consider increasing this value, depending on the constraints of your system.</td></tr><tr><td valign="top"><code>show_hidden_files</code></td><td valign="top">This option specifies whether the Agent is allowed to access hidden files and folders on Windows based systems. Valid options are <code>true</code> or <code>false</code>. The default value is <code>false</code> when this option is omitted from the configuration file.</td></tr></tbody></table>

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:

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"><code>id</code></td><td valign="top">The unique remote server ID of the agent. This identifies this remote server on your site. Do not edit or change.</td></tr><tr><td valign="top"><code>private_key</code></td><td valign="top">The unique key that identifies and authenticates this agent to your site. Do not edit or change.</td></tr><tr><td valign="top"><code>subdomain</code></td><td valign="top">The unique <a href="/spaces/y2P2qRcQfZaft8upoWJn/pages/d2z2Vr33r6i6tT2lQZwT">custom subdomain</a> of the site that this agent is associated with.</td></tr><tr><td valign="top"><code>prefer_protocol</code></td><td valign="top">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 <code>tcp</code> to force the agent to only use a TCP based connection. When left blank, the default value <code>udp</code> setting will be used.</td></tr><tr><td valign="top"><code>dns</code></td><td valign="top">The DNS lookup method for the agent. The default value of <code>auto</code> 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 <code>doh</code> (DNS over HTTPS) option tells the agent to look up public DNS information using <code>https://cloudflare-dns.com</code>. The <code>system</code> option tells the agent to look up DNS information using the local host's DNS settings.</td></tr><tr><td valign="top"><code>proxy_all_outbound</code></td><td valign="top">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.</td></tr><tr><td valign="top"><code>endpoint_override</code></td><td valign="top">If your site has a <a href="/spaces/y2P2qRcQfZaft8upoWJn/pages/EYeT0mbTb3qOZckKv639">custom domain</a> then this option specifies the domain name to use when the agent connects back to your site.</td></tr><tr><td valign="top"><code>log_file</code></td><td valign="top">The log file name and location. Use this option to specify the log file location. When blank, the <a href="/spaces/y2P2qRcQfZaft8upoWJn/pages/Iya9HdMPzrc9lK1CDIx4">default agent log location</a> will be used.</td></tr><tr><td valign="top"><code>log_level</code></td><td valign="top">Specifies the amount of detail to include in the agent log. The <code>debug</code> option includes all other log levels, provides the most detailed information, and will create the largest log file size. The <code>info</code> option, which includes <code>warn</code>, <code>error</code>, and <code>fatal</code> level information, provides normal operational information about the tasks and operations that the agent is performing. The <code>warn</code> option, which includes <code>error</code> and <code>fatal</code> level information, provides information about unexpected conditions or events. Warnings indicate that an unexpected condition occurred but the agent continued to function. The <code>error</code> option, which includes <code>fatal</code> 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 <code>fatal</code> option provides information about critical issues that cause the agent to stop working. When blank, the default <code>info</code> level is used.</td></tr><tr><td valign="top"><code>log_rotate_num</code></td><td valign="top">The number of log files to retain. The default value is 5.</td></tr><tr><td valign="top"><code>log_rotate_size</code></td><td valign="top">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.</td></tr><tr><td valign="top"><code>graceful_shutdown_timeout</code></td><td valign="top">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.</td></tr><tr><td valign="top"><code>transfer_rate_limit</code></td><td valign="top">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.<br></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://moverdocs.files.com/connections/any-server-with-files.com-agent/agent-configuration-file.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
