Installation

Run the .run file which can be downloaded from https://bi.ceejay.com. This is a self-extracting archive, and will need to be executed in an elevated environment.

The installer will

  1. install the software into a branded /opt/backupintelligence/ subdirectory

  2. prompt you for an initial username and password

  3. register the current Linux device into that Backup Intelligence account

  4. start running Backup Intelligence Backup in the background.

If you make a mistake with the username/password prompt, you should follow the instructions below to completely remove the software, and then start the installation again.

Linux Installation options

You can control the installer by setting environment variables in your shell before running the .run file.

The following options are available:

  • WRITE_INSTALL_LOG. Set this to a file path, to record details of the installation.

  • OVERRIDE_INSTALL_SERVER. Set this to a URL (including http/https and trailing slash) to override the Backup Intelligence Server URL used by Backup Intelligence Backup correct URL is bi.ceejay.com

You can set an environment variable in bash either on the same line (e.g. WRITE_INSTALL_LOG=install.log ./Backup Intelligence_Backup-xx.x.x.run) or as a separate export command (e.g. export WRITE_INSTALL_LOG=install.log followed by ./Backup Intelligence_Backup-xx.x.x.run).

Silent installation (Linux advanced)

Backup Intelligence allows you to install and configure the software silently. This allows you to remotely push client installations remotely, using your preferred remote management software.

To run the installer silently, run:

  1. export Backup Intelligence_USERNAME=xxxx

  2. export Backup Intelligence_PASSWORD=xxxx

  3. (echo $Backup Intelligence_USERNAME; echo $Backup Intelligence_PASSWORD;) | ./Backup Intelligence_Backup-xx.x.x

NOTE: Backup Intelligence_USERNAME and Backup Intelligence_PASSWORD are for the user profile, not the Backup Intelligence Server administrator.


Restarting at boot

The installer creates a backup-daemon-start.sh script that can start the service. The Backup Intelligence agent on "Other Distribution" Linux can be restarted by running the backup-daemon-start.sh script.

In order for Backup Intelligence to start after a system reboot, you must configure this script to be run on system boot. Different Linux distributions support different methods for running commands on system boot: choose the most appropriate method for your Linux distribution. Some common choices are documented below.


Preserve HOME environment variable

Backup Intelligence uses the $HOME environment variable to find its saved credentials. When configuring Backup Intelligence to start at system boot, ensure that the $HOME environment variable is set (i.e. to /root/), to ensure that Backup Intelligence can find its saved credentials. If Backup Intelligence is unable to log in, it's possible that your Linux distribution does not set $HOME at this early-boot stage. In that case, you should try running HOME=/root/ /opt/Backup Intelligence/backup-daemon-start.sh & instead. Backup Intelligence 19.8.0 and later will automatically try to use /root/ as the $HOME directory if $HOME is not already set or if it is set to a blank path.

Note: If you execute the .run installation script as root, this may have different results than if you execute the .run script using an elevated terminal session with 'sudo'. The 'sudo' command preserves the $HOME variable on Ubuntu; whilst on Debian the $HOME variable is erased, and sudo then sets it to the home directory of the originating user.


Start in the background

If you are running commands over SSH, please be aware that the backup-daemon-start.sh script runs in the foreground and will die when the SSH session is closed. You can avoid this by running the script in the background.

You can run the script in the background (daemonize) by using the backup-daemon-start-background.sh file instead.

Prior to Backup Intelligence 19.5.0, the backup-daemon-start-background.sh file is not available, and you must daemonize it yourself via nohup / disown / double-fork (e.g. ( cd /opt/Backup Intelligence ; ./backup-daemon-start.sh >/dev/null 2>/dev/null & ) &).


Startup via rc.local

You can make Backup Intelligence start at system boot by adding an entry to the rc.local file.

First, find the rc.local file on your system:

  • /etc/rc.local (Debian/Ubuntu)

  • /etc/rc.d/rc.local (CentOS/RHEL)

Add the following content to the rc.local file:

/opt/Backup Intelligence/backup-daemon-start.sh &

If the rc.local file contains an exit 0 statement, the additional command should be added before such a statement.

As of CentOS 7, the rc.local file is not executable by default. You should run chmod +x on the rc.local file to enable using this method for startup scripts.


Startup via rc.d

You can make Backup Intelligence start at system boot by adding a file to the rc.d directory.

First, find the rc.d directory on your system:

  • /usr/local/etc/rc.d (Synology DSM 6.1+)

Add a new file to the rc.d directory with the following contents:

#!/bin/bash

/opt/BackupIntelligence/backup-daemon-start-background.sh

Mark the file as executable: chmod +x /usr/local/etc/rc.d/my-Backup Intelligence-startup-script.sh


Startup via cron

You can make Backup Intelligence start at system boot by adding an entry to root's crontab.

  1. Run crontab -e -u root to launch a crontab editor

  2. Add the line @reboot /opt/BackupIntelligence/backup-daemon-start-background.sh


Startup via init.d

No further documentation is available for this topic.


Startup via systemd

You can use the following unit as an basic example:

[Unit]

Description=Backup Intelligence Client

After=network-online.target


[Service]

Type=simple

RemainAfterExit=true

KillMode=process

User=root

ExecStart=/opt/BackupIntelligence/backup-daemon-start.sh


[Install]

WantedBy=multi-user.target

This unit file correctly starts the Backup Intelligence service at system boot.

However, the process management in systemd is not fully compatible with the way Backup Intelligence's multi-process model works. In particular, there are compatibility issues with the software updater. As a result, the above unit is (A) unable to take advantage of process group cleanup; (B) unable to auto-restart the Backup Intelligence Backup agent service; and (C) after a software upgrade, Backup Intelligence will keep running but the unit will remain in "exited" state.


Autostart for graphical desktop application

In the "Other Distribution" package, the graphical application is not automatically configured to start when the desktop logs in. You may add backup-interface --background as an autostart command to your desktop environment's settings.


Upgrading

The "Other Distribution" version of Backup Intelligence supports upgrading the software, with some caveats:

  • The .run file will automatically upgrade the existing version

  • The software can be remotely upgraded via the Backup Intelligence Server web interface.

However, the existing service will only be replaced with the upgraded version if the product brand name is unchanged.

Note: If you delete the branded Backup Intelligence directory and all its contents in /opt/, this will trigger a full-reinstallation of the client software, requiring the username and password.


Uninstall

To uninstall "Other Distribution" versions of Backup Intelligence, you should

  1. Stop all Backup Intelligence processes

  2. Remove the relevant subdirectory under /opt/

  3. Remove any custom startup scripts


Change password on Linux client

Use the 'Change Password' function in the client web interface, or change the password in the admin web interface.

Then fully uninstall and reinstall the client, using the new credential. Your device settings and Protected Items will be preserved.


Graphical desktop application for Linux

This feature is available in Backup Intelligence 21.3.6 and later.

By default, the Backup Intelligence application for Linux runs on the command-line only. You can control and configure the application via the web interface at https://bi.ceejay.com

If you have a graphical Linux desktop environment (e.g. GNOME / KDE / XFCE, using X11 / Wayland), it is optionally possible to run the Backup Intelligence desktop application. In addition to the general Linux system requirements, use of this feature has the following additional requirements:

  • x86_64 CPU architecture

  • Qt 5.7 or later

  • Glibc 2.24 or later

These Qt and Glibc versions are present on most Linux distributions from 2017 or later, such as Ubuntu 17.04 "Zesty Zapus", Debian 9 "Stretch", Fedora 25 Workstation, CentOS 8, and any more recent Linux distribution version.

On Debian/Ubuntu, you may need to install the following package dependencies:

  • apt-get install libqt5gui5 libqt5svg5

On Fedora/CentOS, you may need to install the following package dependencies:

  • yum install qt5-qtbase.x86_64 qt5-qtsvg.x86_64

After installing Backup Intelligence for Linux for command-line usage, you can launch the /opt/BackupIntelligence/backup-interface program. It is not necessary to launch this program as root; it will communicate with the installed Backup Intelligence Backup background service regardless of what user account it runs as.

Did this answer your question?