Skip to content

Install Agent

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

Resilio Agents are available on:

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 Port Forwarding.
    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.
    Install Agent Generate Agent Config
    or navigate to Agents , then click + CONNECT NEW AGENT and select GENERATE AGENTS CONFIG.
    Install Agent Generate Agent Config Alt

  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.

    Note

    You can create a custom installer package containing both the installer and the configuration file. For details, see Packaging installer and configuration file.

    • /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 its configuration file. One needs to use agent's shortcut on desktop to open it.

Packaging installer and configuration file

The silent Agent installation to endpoint computer implies bringing at least two files: the installer or archive and the configuration file sync.conf which contains information to connect to your Management Console.

Sometimes it is preferable to package sync.conf inside the installer to get a single-file-installer which does not require any extra actions, in cases like:

  • The installation process is done by a novice user and not supervised by the Administrator.
  • The administrator has several configuration files for different groups of users\locations.
  • For centrally managed deployment systems where Applications are installed without any user interaction.

Important

The resulting .pkg or .msi files are unsigned. If your installation policy requires files to be signed, you'll have to sign them with your own digital certificate.

  1. Download the script from the Resilio, Inc. public Git repository.

    Note

    The packaging script requires Powershell v5.0 or newer to run.

  2. Download the Resilio Active Everywhere Agent MSI installers from Connect download site and your sync.conf from your Management Console. Running the script depends on the shell you use.

  • If you run the script from Powershell:

    Set-ExecutionPolicy -ExecutionPolicy Bypass -Force  
attach-sync-conf-to-msi.ps1 -MSIPath <path_to_msi> -SyncConfPath <path_to_config>

  • If you run the script from the command prompt: 

    powershell.exe -ExecutionPolicy Bypass -Noprofile attach-sync-conf-to-msi.ps1 -MSIPath <path_to_msi> -SyncConfPath <path_to_config>

Result

The script will exit and rename the MSI to <MSI_Name>_configured.msi. If you plan to install Resilio Active Everywhere Agents on computers with different architectures (x86 and x64), you need to run the script separately for each MSI installer.

  1. Downloads the script from the Resilio, Inc. public Git repository. The packaging shell script requires the pkgbuild tool to be installed (bundled with XCode tool and is often is preinstalled on your Mac).

    Tipe

    The downloaded package has a readme file with the below instructions as well.

  2. Download the Resilio Active Everywhere Agent for Macs from our download page and also the sync.conf file from your Resilio Active Everywhere Management Console. You need to create a folder that has the following set of files in it (in the screenshot below we created one called script):

    • make_package.sh (downloaded in step 1)
    • scripts (the folder containing deployment scripts, downloaded in step 1)
    • Resilio-Connect-Agent.dmg (use the version you want to deploy)
    • sync.conf (download from your management console)

    Example

    Install Agent Create Package

  3. Open Terminal and navigate to the folder containing make_package.sh, then run commands:

    chmod +x make_package.sh  
./make_package.sh

Result

The script will create a Resilio-Connect-Agent.pkg file in the same directory. This package uses standard macOS installation dialog and registers Agent as LaunchAgent which starts as soon as the user logs in to their macOS.

Important for MDM deployments

If you plan to centrally deploy Resilio Active Everywhere Agents 2.11 or higher via an MDM, you should also whitelist the Resilio Active Everywhere Kernel Extension. Fore more information, see How To Whitelist The Resilio Agent For Mac Kernel Extensions Using Jamf Pro 10.

WindowsPE

WindowsPE is a limited environment, not intended for installing and operating applications. Full installation of the Agent is not supported, you can only launch the Agent process.

System requirements

  • WinPE 7 and newer, x64/x86.
  • Network connectivity.

  1. Download the sync.conf configuration file from from the Management Console. Depending on whether Windows Explorer is available or not, keep or un-check the Enable Agent UI option when generating the configuration file.

  2. Configure the storage path - location in the file system where the Agent will keep its settings, database, logs. If it's not configured in the sync.conf file, the Agent will create the storage in %appdata% folder of the currently logged in user, which may be not available. Open the sync.conf in a text editor and add line "storage_path":"C:\\pathto\\storage\\folder", . Mind the double backslash and be sure to preserve JSON format.

    {
    "storage_path": "C:\\path_to\\storage\\folder"
    "management_server": {
        "host": "172.16.0.55:8444",
        "cert_authority_fingerprint": "5a64afb72c575db714a*******",
        "bootstrap_token": "2RJ7TIJN3TZOPTQPV7NFOO5B7BZ*******",
        "disable_cert_check": false
},

  3. Download Resilio Active Everywhere Agent executable file from downloads page and place it together in a folder with the sync.conf file.

    Running Resilio On Windows Pe Download Exe

  4. Launch Command Prompt as Admin, navigate to the directory with those files and launch the Agent from there. Not receiving any error message in CMD means that the Agent launched successfully.

    C:\Resilio>
C:\Resilio>Resilio-Connect-Agent_x64.exe /config sync.conf

C:\Resilio>_

Warning

Since Windows PE is a limited functionality, the following peculiarities apply:

  • Further management - starting, stopping - of the process shall be done manually either through CMD or a script.
  • All available functionality of Resilio Agent is not guaranteed.

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.

Linux - Tarball

To install Resilio Agent from a tarball archive:

  1. Download, then extract the Resilio Agent tarball archive:

     tar zxf resilio-connect-agent_x64.tar.gz -C /home/vboxuser/apps/resilio-agent

  2. Start the Resilio Agent with specifying the location of the configuration file:

     ./rslagent --config /home/vboxuser/Downloads/sync.conf

or start the Resilio Agent with specifying the IP address of the Management Console:

     ./rslagent --server 192.168.0.41:8444

Note : When you start the agent with specifying the IP address, log in to the Management Console and approve the pending Agent connection request.

Note : Files created by Resilio Agent are owned by the user running the rslagent process and with its umask. Resilio Agent uses POSIX.1 permissions and it's unaware of any ACLs applied to your filesystem.

Tip : Resilio Agents 2.12's and newer tarball archive comes with the adjustsettings.sh script that changes some of system settings to boost Agent's performance.

To run the script:

  1. Add the executable attribute:

     sudo chmod +x adjust adjustsettings.sh

  2. Run the script:

     ./adjustsettings.sh

The script performs the following:

  • Increases system socket buffers to increase speed of synchronization over ZGT protocol.
  • Increases number of notify watchers so that the Agent receives file system notifications about all files and does not run out of the watchers.
  • Removes core dumps limits. With the limits removed, the Agent will be able to create core dump if it crashes. Note, the limit is removed for other applications on the computer as well, thus core dumps created by them may take a lot of storage space.
Linux - DEB

Install from a DEB package

To install Resilio Agent from a DEB package:

  1. Download the .deb package, then run the following command:

     sudo dpkg -i resilio-agent_<version>_<architecture>.deb

  2. (Optional) Enable automatic startup of the Resilio Agent service:

     sudo systemctl enable resilio-agent

  3. Start the Resilio Agent service:

     sudo systemctl start resilio-agent

Install via Resilio repository

To install Resilio Agent from a DEB package via Resilio repository:

  1. Register Resilio repository, make sure to change the revision number for the one you want to install:

     echo "deb http://linux-packages.resilio.com/resilio-agent-4.2/deb resilio-agent non-free" | sudo tee -a /etc/apt/sources.list.d/resilio-agent.list

  2. Add public key:

     wget -qO - https://linux-packages.resilio.com/resilio-agent/key.asc | sudo apt-key add -

  3. Update your repository:

     sudo apt-get update

  4. Install Resilio Agent:

     sudo apt-get install resilio-agent

  5. (Optional) Enable automatic startup of the Resilio Agent service:

     sudo systemctl enable resilio-agent

  6. Start the Resilio Agent service:

     sudo systemctl start resilio-agent
Linux - RPM

Install from an RPM package

To install Resilio Agent from an RPM:

  1. Download the sync.conf configuration file and place it in the /etc/resilio-agent folder.

  2. Download the .rpm package, then run the following command:

     sudo rpm -Uhv resilio-agent_<version>_<architecture>.rpm

Note : In case the installer was unable to find the sync.conf file, enter the IP address of the Management Console, then approve the pending Agent connection request in the Management Console.

  1. (Optional) Enable automatic startup of the Resilio Agent service:

     sudo systemctl enable resilio-agent

  2. Start the Resilio Agent service:

     sudo systemctl start resilio-agent

Install via Resilio repository

To install Resilio Agent from an RPM package via Resilio repository:

  1. Register Resilio repository, make sure to change the revision number for the one you want to install:

     printf "[resilio-agent-4.2]\nname=Resilio Agent\nbaseurl=http://linux-packages.resilio.com/resilio-agent-3.7/rpm/\$basearch\nenabled=1\ngpgcheck=1" | sudo tee /etc/yum.repos.d/resilio-agent.repo

  2. Add public key:

     sudo rpm --import https://linux-packages.resilio.com/resilio-agent/key.asc

  3. Update your repository:

     sudo yum install resilio-agent

  4. Install Resilio Agent:

     sudo apt-get install resilio-agent

  5. (Optional) Enable automatic startup of the Resilio Agent service:

     sudo systemctl enable resilio-agent

  6. Start the Resilio Agent service:

     sudo systemctl start resilio-agent

Note

Resilio Agent creates rslagent user and runs with it. Files created by the Agent service are owned by the user running the rslagent process and with its umask. Resilio Agent uses POSIX.1 permissions and it's unaware of any ACLs applied to your filesystem. Additionally, Resilio creates the /home/rslagent/Resilio Connect Agent folder which is used as the default %DOWNLOADS% folder storage path macro. For other path macros see Path macros.

Run the Agent service as a different user

To run the Agent as a different user, on systemd or sysvinit systems, edit the service's configuration file and change the user and group related variables:

  • sysvinit: /etc/init.d/resilio-agent
  • systemd: /lib/systemd/system/resilio-agent.service