Warning: This document is for the development version of Bareos Documentation. The main version is bareos-23.

Installing a Bareos Client

When installing a Bareos client, you should choose the same release as on the Bareos server.

The package bareos-client is a meta-package. Installing it will also install the bareos-filedaemon, bareos-bconsole and suggests the installation of the bareos-traymonitor.

If you prefer to install just the backup client, it is sufficient to only install the package bareos-filedaemon.

After installing the client, please read the chapter Adding a Client about how to configurre the client.

Installing a Bareos Client on Linux Distributions

The installation of a Bareos client on a Linux (and FreeBSD) system is identical as described for Bareos server installations.

Just install the package bareos-filedaemon or bareos-client (bareos-filedaemon, bareos-bconsole and bareos-traymonitor) instead of the meta-package bareos.

If there is no specific Bareos repository for your Linux distribution, consider using the Installing the Bareos Universal Linux Client instead.

Installing the Bareos Universal Linux Client

The Bareos project provides packages for the current releases of all major Linux distributions. In order to support even more platforms Bareos Version >= 21.0.0 provides the so called Universal Linux Client (ULC).

The Universal Linux Client is a Bareos File Daemon, built in a way to have minimal dependencies to other libraries.

Note

The Universal Linux Client depends on the OpenSSL library of the host in order to utilize security updates for this library.

It incorporates all functionality for normal backup and restore operations, however it has only limited plugin support.

Currently it is provided as a Debian package. However, it is planed to provide it also in other formats.

The ULC have extra repositories, their names starting with ULC_ (e.g. ULC_deb_OpenSSL_1.1) at https://download.bareos.com/bareos/release/ and https://download.bareos.org/current/. There will be different repositories depending on packaging standard and remaining dependencies. These repositories contain the bareos-universal-client package and sometimes their corresponding debug package. You can either add the repository to your system or only download and install the package file.

One of ULC’s goals is to support new platforms for which native packages are not yet available. As soon as native packages are available, their repository can be added and on an update the ULC package will be seamlessly replaced by the normal Bareos File Daemon package. No change to the Bareos configuration is required.

Warning

While ULC packages are designed to run on as many Linux platforms as possible, they should only be used if this platform is not directly supported by the Bareos project. When available, native packages should be preferred.

Feature overview:

  • Single package installation

  • Repository based installation

  • Minimal dependencies to system libraries (except OpenSSL)

  • Uses host OpenSSL library

  • Replaceable by the normal Bareos File Daemon. No configuration change required.

Installing a Bareos Client on FreeBSD

Installing the Bareos client is very similar to Install on FreeBSD based Distributions.

Get the add_bareos_repositories.sh matching the requested Bareos release and the distribution of the target system from https://download.bareos.org/ or https://download.bareos.com/ and execute it on the target system:

Shell example script for Bareos installation on FreeBSD
root@host:~# sh ./add_bareos_repositories.sh
root@host:~# pkg install --yes bareos.com-filedaemon

## enable services
root@host:~# sysrc bareosfd_enable=YES

## start services
root@host:~# service bareos-fd start

Installing a Bareos Client on Oracle Solaris

The Bareos File Daemon is available as IPS (Image Packaging System) packages for Oracle Solaris 11.4.

First, download the Solaris package to the local disk and add the package as publisher bareos:

Add bareos publisher
root@solaris114:~# pkg set-publisher -p bareos-fd-<version>.p5p  bareos
pkg set-publisher:
  Added publisher(s): bareos

Then, install the filedaemon with pkg install:

Install solaris package
root@solaris114:~# pkg install bareos-fd
          Packages to install:  1
           Services to change:  1
      Create boot environment: No
Create backup boot environment: No

DOWNLOAD                                PKGS         FILES    XFER (MB)   SPEED
Completed                                1/1         44/44      1.0/1.0  4.8M/s

PHASE                                          ITEMS
Installing new actions                         94/94
Updating package state database                 Done
Updating package cache                           0/0
Updating image state                            Done
Creating fast lookup database                working |

After installation, check the bareos-fd service status with svcs bareos-fd:

Check solaris service
root@solaris114:~# svcs bareos-fd
STATE          STIME      FMRI
online         16:16:14   svc:/bareos-fd:default

Finish the installation by adapting the configuration in /usr/local/etc/bareos and restart the service with svcadm restart bareos-fd:

Restart solaris service
root@solaris114:~# svcadm restart bareos-fd

The Bareos File Daemon service on solaris is now ready for use.

Installing a Bareos Client on macOS

Bareos for macOS is available either

However, you have to choose upfront, which client you want to use. Otherwise conflicts do occur.

Both packages contain the Bareos File Daemon and bconsole.

Installing the Bareos Client as PKG

The Bareos installer package for macOS contains the Bareos File Daemon for macOS 10.5 or later.

On your local Mac, you must be an admin user. The main user is an admin user.

Download the bareos-*.pkg installer package from https://download.bareos.org/ or https://download.bareos.com/.

Find the .pkg you just downloaded. Install the .pkg by holding the CTRL key, left-clicking the installer and choosing “open”.

Follow the directions given to you and finish the installation.

Alternatively you can install the package via command line:

sudo installer -pkg bareos-*.pkg -target /

Configuration

To make use of your Bareos File Daemon on your system, it is required to configure the Bareos Director and the local Bareos File Daemon.

Configure the server-side by follow the instructions at Adding a Client.

After configuring the server-side you can either transfer the necessary configuration file using following command or configure the client locally.

The configuration path differs from a Linux installation. On Linux the configuration files are located under /etc/bareos/. On macOS pkg installations, the configuration path is /usr/local/bareos/etc/bareos/. On macOS Homebrew installatons, the configuration path is /usr/local/etc/bareos/.

Option 1: Copy the director resource from the Bareos Director to the Client

Assuming your client has the DNS entry client2.example.com and has been added to Bareos Director as client2-fd (Dir->Client):

copy director resource to a macOS pkg installation client
scp /etc/bareos/bareos-dir-export/client/client2-fd/bareos-fd.d/director/bareos-dir.conf root@client2.example.com:/usr/local/bareos/etc/bareos/bareos-fd.d/director/

Option 2: Edit the director resource on the Client

Alternatively, you can edit the file /usr/local/bareos/etc/bareos/bareos-fd.d/director/bareos-dir.conf.

This can be done by right-clicking the finder icon in your task bar, select “Go to folder …” and paste /usr/local/bareos/etc/bareos/bareos-fd.d/director/.

Select the bareos-dir.conf file and open it.

Alternatively you can also call following command on the command console:

open -t /usr/local/bareos/etc/bareos/bareos-fd.d/director/bareos-dir.conf

The file should look similar to this:

bareos-fd.d/director/bareos-dir.conf
Director {
  Name = bareos-dir
  Password = "SOME_RANDOM_PASSWORD"
  Description = "Allow the configured Director to access this file daemon."
}

Set this client-side password to the same value as given on the server-side.

Warning

The configuration file contains passwords and therefore must not be accessible for any users except admin users.

Restart bareos-fd after changing the configuration

The bareos-fd must be restarted to reread its configuration:

Restart the Bareos File Daemon
sudo launchctl stop  com.bareos.bareos-fd
sudo launchctl start com.bareos.bareos-fd

Verify that the Bareos File Daemon is working

Open the bconsole on your Bareos Director and check the status of the client with

*status client=client2-fd

In case, the client does not react, following command are useful the check the status:

Verify the status of Bareos File Daemon
# check if bareos-fd is started by system:
sudo launchctl list com.bareos.bareos-fd

# get process id (PID) of bareos-fd
pgrep bareos-fd

# show files opened by bareos-fd
sudo lsof -p `pgrep bareos-fd`

# check what process is listening on the |fd| port
sudo lsof -n -iTCP:9102 | grep LISTEN

You can also manually start bareos-fd in debug mode by:

Start Bareos File Daemon in debug mode
cd /usr/local/bareos
sudo /usr/local/bareos/sbin/bareos-fd -f -d 100

Installing a Bareos Client on Windows

See Windows Installation.