Installing Yadle: Self-Hosted: Yadle servers
The Yadle servers manage all file data and thumbnails as well as providing the API services. The servers run inside a Docker container enabling ease of deployment.Pre-requisites:
1. Linux Host Machine or VM
- RHEL/CentOS or Debian/Ubuntu Linux Distributions
- System Minimum Requirements
- 4 Cores, 32 GB RAM, 1 TB Disk Space (with ability to grow as needed)
- Curl and Gunzip
3. Install Docker Compose
Download Yadle agent installation script from:
$ curl -O https://download.yadle.com/docker/install_yadle_servers
After you download the script, set the execute bit:
$ chmod +x install_yadle_agent_serversNote:
- This is a bash script that will execute the steps needed to download, deploy, and configure a Docker container of the Yadle servers 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.
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 /yadleNote:
- 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.
Run the Yadle servers installation script. Since Docker is being used, the script must be run as a sudoer or root user.
$ sudo ./install_yadle_servers
The Yadle servers install script will execute and you will be prompted for the following values:
Enter the name of your organization:
– Organization name will be provided to you by Yadle.
Enter Organization ID:
– The Organization ID is provided to you by Yadle.
– Recommended: /opt/<org> Replace
Data Root Path:
– Recommended: /yadle
Email server hostname:
– Email server used for sending emails to Yadle users for initial account creation,password recovery, and File Channel invitations.
Email server SMTP port:
– Port used for email server. Typically 465 (secure) or 25 (un-secure)
Email address and password:
– Email credentials that will be used for sending emails.
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.
- The script will output many messages. Progress messages will be displayed as the images are downloaded, containers started and configured.
- Any problems will be displayed in red text and the script will stop.
- Successful installation will output docker status and “Servers installation completed”.
Starting and Stopping Yadle servers:
The installer for the Yadle servers will generate scripts to stop and start the Docker containers with the proper parameters. The
stop_yadle.sh and located in the default install directory.
$ sudo /opt/<org>/servers/start_yadle.sh
$ sudo /opt/<org>/servers/stop_yadle.shNote:
- If you reboot the system that is running the Yadle agent, the containers will NOT be restarted by
default. Start them with
stop_yadle.shneed to run as sudoer.
The installer for the Yadle servers will also generate a script to run for updating the servers. It is named
<org>_update_yadle_servers.sh and located in default install location
$ sudo /opt/<org>/servers/<org>_update_yadle_servers.sh
<org>_update_yadle_servers.sh needs to run as sudoer.