Resilio Agent installation

Resilio Active Everywhere Agents are light-weight applications that enable file transfers between job participants.

Resilio Agents are available on:

• Windows
• Windows - Silent
• macOS
• Linux
• NAS devices (Synology, QNAP, WD)
• Android

Prerequisites

Before installing Resilio Agent, make sure you have:

• A hardware platform that meets the minimum system requirements.
• A download page URL. You should receive it along with your license. If you already have a license, reach out to our support team for the latest version available.
• Firewall rules and port forwarding set up to allow traffic on a set of ports. For details, see Ports protocols & ports forwarding required by Resilio Connect.
  Note: For the Windows' built-in firewall, the installer will automatically configure the necessary rules.

Generate Configuration File

Configuration file contains a set of parameters that enable linking a Resilio Agent instance to the Management Console.

To generate a configuration file:

1. Log in to the Management Console.
2. From the Settings menu, select General and in the MANAGEMENT CONSOLE SETTINGS section, click Generate Agent config.
   
   or navigate to Agents, then click + CONNECT NEW AGENT and select GENERATE AGENTS CONFIG.
   
3. Provide the following:
   • Management Console address - The Management Console's IP address or hostname.
   • Management Console port - The port number on which the Management Console's listens for incoming connection.
     Note: Management Console's incoming connections port number is read only. It can be changed by editing the configuration file.
   • Bootstrap token - The bootstrap token authenticates the connection between Resilio Agents and the Management Console.
   • Default storage path - The default storage path for the jobs.
   • Enable Agent UI - Enables user interface for Resilio Agents running on Microsoft Windows.
   • Enable limited user - The limited user mode restricts access to the operating system. It disables file system browsing, and scripts and triggers execution. For details, see Limiting admin’s access to the Agent.
   • Add Agent tags - Tags enable automated assignment of Agents to groups.
4. Click Save/Download.

Install Resilio Agent

Windows

To install Resilio Agent on Windows:

1. Download the Agent installer.
2. (Optional) Copy the Agent configuration file to the folder where the installer is located.
3. Launch the installer.
4. On the welcome page, click Next.
5. (Optional) Customize your installation, then click Next.
   • Resilio Connect Agent Service - The Resilio Agent service that enables participating in different transfer jobs.
   • Firewall exception - Rules in Windows Firewall allowing Resilio Active Everywhere to establish network connections.
   • File Locking driver - OS level driver that enables the file locking feature.
     Important: Installing the File Locking driver later, after the Resilio Agent has been installed initially, is difficult. We highly recommend installing the locking driver with the Resilio Agent if you plan on using file locking.

6. On the Configure connection with Management Console screen choose one of the options:

   Enter Console's address after installation (UI is required)

   If you select this option, you will be prompted to input the Management Console's IP address the first time you start the Resilio Agent application.

   Select Enter Console's address after installation (UI is required), then click Next.

   Paste agent config as text

   1. Select Paste agent config as text, then click Next.
   2. Paste the contents of the configuration file, then click Next.
      Note: Make sure the use_gui parameter's value is set to true.
   3. Click Next to confirm that the use_gui option is enabled.

   Choose folder that contains sync.conf

   1. Select Choose folder that contains sync.conf.
   2. Provide path to the folder where the configuration file is located or click Browse to locate the folder, then click Next.
      Note: Make sure the use_gui parameter's value is set to true.
   3. Click Next to confirm that the use_gui option is enabled.
7. Enter the destination folder, then click Next.
8. Click Install to begin the installation.

Windows - Silent

For silent installation, run the msiexec.exe utility with additional parameters:

msiexec.exe /i Filename.msi ADDSOURCE=ALL /qn SERVICE_USER="Local System" CONFIG_SRC_PATH="C:\path\to\config\Downloads\" /norestart

• ADDSOURCE=ALL flag can be replaced with ADDLOCAL="MainApplication,AgentUi,FileLockingDriver" to specify which extensions you'd like to install.
• SERVICE_USER="Local System" flag can be used to specify service installation under System or a local user. Otherwise, can be omitted, and service will be installed as Local System by default. Add SERVICE_USER_PASSWORD when installing as local user.

• CONFIG_SRC_PATH="C:\path\to\config\Downloads\" flag is necessary to point the service to the config file downloaded from the Management Console. Note the trailing slash in the path, and make sure that the configuration file is named sync.conf.

  CONFIG_SRC_PATH

  The path to the configuration file must be absolute and must be specified if you want MSI to load the configuration during installation.

• /norestart parameter blocks the automatic reboot of the system right after installation. Reboot is not always required to complete Agent installation. You can manually reboot later at a convenient time if required.

Also note that being silently installed, agent won't open its UI automatically, even though agent UI is enabled in config. One needs to use agent's shortcut on desktop to open it.

macOS

To install Resilio Agent on macOS:

1. Download the Agent installer.
2. Open the installer image, then drag and drop the Resilio Agent on to the Applications folder.
3. Open the Resilio Agent application.

4. On the Configure connection with Management Console screen, select how you want to connect to the Management Console and proceed accordingly:

   Host

   If you select this option, you will be prompted to input the Management Console's IP address the first time you start the Resilio Agent application.

   Select Host, then click Ok.

   Editor

   Select Editor, paste the contents of the configuration file, and click Ok.

   Config file

   1. Select Config file.
   2. Click Choose File, then browse the file system to locate the configuration file.
   3. Click Ok.

Linux

You can install Resilio Agent using tarball archive, DEB and RPM packages, or using apt-get and yum package managers.