Agent configuration file in detail

Overview

The Resilio Agent configuration file is a JSON formatted file, pre-generated by the Connect Management Console. Agent uses this config to connect to MC and to receive some settings from it.

Config file can be generated from MC Settings page.

There are two check boxes:
Enable Agent UI - adds "use_gui":true into config and enables UI for agents. It's off by default.
Add Agents Tags - allows to add some tags to config. Enter tag name (only upper case is allowed) and its value, click + to save the tags. This is especially useful when agents are going to be sorted by groups automatically.

When done, click Save. After that three options will be presented:

Download - save the config file as a sync.conf JSON file. It can be delivered to agent later.
Copy - copies the JSON into clipboard. Can be pasted anywhere and later pasted directly into agent installer.
Show QR Code - generated QR code that can be scanned by mobile agent.

Here's the list of parameters that are saved in generated config. Config file can be edited in a text editor. Stick to JSON format when updating it (some fancy editor might add their own format and break JSON).

Field	Purpose
`folders_storage_path`	Default value %DOWNLOADS%. You can use it to configure where Agent should create folders when they arrive from the Connect Management Console. This variable points to a different location on different platforms. Fore more information, see Path macros.
`host`	IP:port pair where client will attempt to connect to Connect Management Console, supports DNS name. You can put IPv6 or IPv4 address there. The correct syntax for IPv6 is:`"host":"[ip:v6:add:r]:8444"`.
`cert_authority_fingerprint`	Management Console certificate fingerprint
`bootstrap_token`	pre-generated authentication token. Used by Management Console to authenticate client initial connection.
`disable_cert_check`	Setting to true will prevent client to check Management Console's certificate fingerprint.
`use_gui`	Default is true. If option " Enable Agent UI" is unchecked, value changes to false and agents will show an error when trying to open its UI. For more information, see Resilio Agent UI.
`tags`	JSON block appears if tags are set when generating config.
`cmd_pipe_name`	Default value "syncsvccmd_server". This is a pipe name for Management Console to communicate with Management Server Agent. Used only in this agent's config.

After performing installation steps, the sync.conf file is moved to its destination directory. Its location depends on the operating syste:

WindowsmacOSLinuxNAS

C:\Program Files\Resilio Connect Agent (default, or another dir selected for agent installation)

Management Console Agent

Management Console Agent builds a new sync.conf file on each MC start. To add changes to config file, edit sync.conf.template instead:
C:\ProgramData\Resilio\Connect Server\sync.conf.template

/Users/username/Library/Application Support/Resilio Connect Agent

If installed manually, the selected dir.
If installed from package, it'll be /etc/resilio-agent or /home/username/.config/resilio-agent/ depending on configuration.

Management Console Agent

Management Console Agent builds a new sync.conf file on each MC start. To add changes to config file, edit sync.conf.template instead: /MC_installation_path/sync.conf.template

Agent for NAS keeps its sync.conf inside storage folder. Therefore the path depends on your NAS vendor.

Config file can be used to add some custom settings that cannot be overwritten by Management Console. For example, give agent a custom name. Add line below to config, top level. Be sure to preserve JSON format. Restart the Agent after editing config.

"device_name": "Windows Agent-8",

Also, you can overwrite the default path macros using the following parameters.

"downloads_folder_path" : "/volume1/Resilio Agent/Downloads",  
"user_profile_folder_path" : "/volume1/Resilio Agent",  
"home_folder_path" : "C:\\Temp\\Folder",