Installing Yadle: Self-Hosted: Yadle agent

The Yadle agent is responsible for the indexing of your files. The agent runs inside a Docker container enabling ease of deployment.

1. Successfully deployed Yadle servers containers
2. If running on separate machine from Yadle servers.
  • a. Linux Host Machine or VM
    • RHEL/CentOS or Debian/Ubuntu Linux Distributions
    • System Minimum Requirements
    • 4 Cores, 4GB RAM, 100GB Disk Space
    • Curl and Gunzip
  • b. Install Docker Community Edition (CE) for your OS
3. Install Docker Compose

Step 1:

Download Yadle agent installation script from:

$ curl -O

After you download the script, set the execute bit:

$ chmod +x install_yadle_agent_selfhosted
  • This is a bash script that will execute the steps needed to download, deploy, and configure a Docker version of the Yadle agent on your host. Where you save the downloaded script is unimportant – it will download the container, add it to Docker, and then configure itself.
  • The installation script can be run multiple times without issue. Each time it is run, it examines and determines the state of the container, repairing or configuring any elements that are not correct.

Step 2:

Configure Yadle Data Directory.

The Yadle agent installer will prompt you for a “Data root path”. This is the location of the volumes that you want to index with Yadle.

Yadle will only index files that are at or below this path. It is recommended to create a directory /yadle, and put mount points under this directory for the volumes you want Yadle to index. This will allow you to easily add or remove subfolders to the /yadle directory as you want to add or remove volumes to be indexed.

$ sudo mkdir /yadle
  • It is NOT necessary for the mount points on the Yadle agent to be the same as the user’s mount points. Yadle provides a mechanism that allows you to map the mount points on a Yadle agent system to user map points via File Mapping.

Step 3:

Run the Yadle agent installation script. Since docker is being used, the script must be run as a sudoer or root user.

$ sudo ./install_yadle_agent_selfhosted

The Yadle agent script will execute and you will be prompted for the following values:

Application ID:
– The Application ID is provided to you by Yadle.

IP address where Yadle servers are running:
– IPv4 address where you have deployed Yadle servers

Servers admin username:
– The servers admin username is provided to you by Yadle

Servers admin password:
– The servers admin password is provided to you by yadle

Yadle admin account password:
– default password:password

Organization ID:
– The Organization ID is provided to you by Yadle

Install Directory For Yadle agent:
– Recommended:/opt/<org> Replace <org> with the organization name assigned to you by Yadle.

Data Root Path:
– Recommended: /yadle

  • The script will output many messages. Progress messages will be displayed as the container is downloaded, started and configured.
  • Any problems will be displayed in red text and the script will stop.
  • Successful installation will output docker status and “Installation completed”

Starting and Stopping Yadle Agent:

The installer for the Yadle agent will generate scripts to stop and start the Docker container with the proper parameters. The scripts are and and located in the default install directory.

$ sudo /opt/<org>/agent/
$ sudo /opt/<org>/agent/
  • If you reboot the system that is running the Yadle agent, the containers will NOT be restarted by default. Start them with
  • and need to run as sudoer.

Updating the Yadle agent:

To update the Yadle agent, the process is the same as the initial installation. Be sure to use the same setup parameters regarding the data root path and install directory to keep things in sync. The latest docker image will be downloaded and container launched from it.

Mounting File Systems to /yadle Data Root:

After successful installation of the Yadle agent, the next step is to mount the desired file systems to be indexed by Yadle under the /yadle Data Root Path.

Let’s imagine you have three network volumes that you want to index with Yadle:


The above three network volumes are mounted on the Yadle data root path /yadle with the following mount points:

/nas/images              —> /yadle/images/
/server/data/videos    —> /yadle/videos/
/ssd_array/admin/local   —> /yadle/local/

  • Yadle agent only requires read access to mounted volumes. Best practice to mount with as read-only
  • It is recommended to add these mounts to /etc/fstab file so that they are mounted each time the Yadle agent host system starts.