Contents

Part I
Introduction and Tutorial

#

Chapter 1
What is Bareos?

Bareos is a set of computer programs that permits the system administrator to manage backup, recovery, and verification of computer data across a network of computers of different kinds. Bareos can also run entirely upon a single computer and can backup to various types of media, including tape and disk.

In technical terms, it is a network Client/Server based backup program. Bareos is relatively easy to use and efficient, while offering many advanced storage management features that make it easy to find and recover lost or damaged files. Due to its modular design, Bareos is scalable from small single computer systems to systems consisting of hundreds of computers located over a large network. #

1.1 History

Bareos is a fork of the open source project Bacula version 5.2. In 2010 the Bacula community developer Marco van Wieringen started to collect rejected or neglected community contributions in his own branch. This branch was later on the base of Bareos and since then was enriched by a lot of new features.

This documentation also bases on the original Bacula documentation, it is technically also a fork of the documenation created following the rules of the GNU Free Documentation License.

Original author of Bacula and its documentation is Kern Sibbald. We thank Kern and all contributors to Bacula and it’s documentation. We maintain a list of contributors to Bacula (until the time we’ve started the fork) and Bareos in our AUTHORS file.

#

1.2 Who Needs Bareos?

If you are currently using a program such as tar, dump, or bru to backup your computer data, and you would like a network solution, more flexibility, or catalog services, Bareos will most likely provide the additional features you want. However, if you are new to Unix systems or do not have offsetting experience with a sophisticated backup package, the Bareos project does not recommend using Bareos as it is much more difficult to setup and use than tar or dump.

If you want Bareos to behave like the above mentioned simple programs and write over any tape that you put in the drive, then you will find working with Bareos difficult. Bareos is designed to protect your data following the rules you specify, and this means reusing a tape only as the last resort. It is possible to ”force” Bareos to write over any tape in the drive, but it is easier and more efficient to use a simpler program for that kind of operation.

If you would like a backup program that can write to multiple volumes (i.e. is not limited by your tape drive capacity), Bareos can most likely fill your needs.

If you are currently using a sophisticated commercial package such as Legato Networker, ARCserveIT, Arkeia, IBM Tivoli Storage Manager or PerfectBackup+, you may be interested in Bareos, which provides many of the same features and is free software available under the GNU AGPLv3 software license.

#

1.3 Bareos Components or Services

Bareos is made up of the following major components or services: Director, Console, File, Storage, and Monitor services.

Bareos Director

The Director is the central control program for all the other daemons. It schedules and supervises all the backup, restore, verify and archive operations. The system administrator uses the Bareos Director to schedule backups and to recover files. The Director runs as a daemon (or service) in the background.

Bareos Console

The Bareos Console (bconsole) is the program that allows the administrator or user to communicate with the Bareos Director. It runs in a shell window (i.e. TTY interface). Most system administrators will find this completely adequate. For more details see the Bareos Console.

Bareos File Daemon

The Bareos File Daemon is a program that must be installed on each (Client) machine that should be backed up. At the request of the Bareos Director, it finds the files to be backed up and sends them (their data) to the Bareos Storage Daemon.

It is specific to the operating system on which it runs and is responsible for providing the file attributes and data when requested by the Bareos Director.

The Bareos File Daemon is also responsible for the file system dependent part of restoring the file attributes and data during a recovery operation. This program runs as a daemon on the machine to be backed up.

Bareos Storage Daemon

The Bareos Storage Daemon is responsible, at the Bareos Director request, for accepting data from a Bareos File Daemon and storing the file attributes and data to the physical backup media or volumes. In the case of a restore request, it is responsible to find the data and send it to the Bareos File Daemon.

There can be multiple Bareos Storage Daemon in your environment, all controlled by the same Bareos Director.

The Storage services runs as a daemon on the machine that has the backup device (such as a tape drive).

Catalog

The Catalog services are comprised of the software programs responsible for maintaining the file indexes and volume databases for all files backed up. The Catalog services permit the system administrator or user to quickly locate and restore any desired file. The Catalog services sets Bareos apart from simple backup programs like tar and bru, because the catalog maintains a record of all Volumes used, all Jobs run, and all Files saved, permitting efficient restoration and Volume management. Bareos currently supports three different databases, MySQL, PostgreSQL, and SQLite, one of which must be chosen when building Bareos.

The three SQL databases currently supported (MySQL, PostgreSQL or SQLite) provide quite a number of features, including rapid indexing, arbitrary queries, and security. Although the Bareos project plans to support other major SQL databases, the current Bareos implementation interfaces only to MySQL, PostgreSQL and SQLite.

To perform a successful save or restore, the following four daemons must be configured and running: the Director daemon, the File daemon, the Storage daemon, and the Catalog service (MySQL, PostgreSQL or SQLite).

#

1.4 Bareos Version Numbers and Releases

Bareos version numbers consists of three parts: YY.Q.C

Following information can be determined from the Bareos release bareos-16.2.4:

• 16.2: Code freeze have been in the second quarter of 2016
• 4: this is the first stable release of the bareos-16.2 branch

For details about the different releases see Release Notes.

#

1.5 Bareos Packages

Following Bareos Linux packages are available (release 17.2.4):

Not all packages (especially optional backends and plugins) are available on all platforms. For details, see Packages for the different Linux platforms.

Additionally, packages containing debug information are available. These are named differently depending on the distribution (bareos-debuginfo or bareos-dbg or …).

Not all packages are required to run Bareos.

• For the Bareos Director, the package bareos-director and one of bareos-database-postgresql, bareos-database-mysql or bareos-database-sqlite3 are required. It is recommended to use bareos-database-postgresql.
• For the Bareos Storage Daemon, the package bareos-storage is required. If you plan to connect tape drives to the storage director, also install the package bareos-storage-tape. This is kept separately, because it has additional dependencies for tape tools.
• On a client, only the package bareos-filedaemon is required. If you run it on a workstation, the packages bareos-traymonitor gives the user information about running backups.
• On a Backup Administration system you need to install at least bareos-bconsole to have an interactive console to the Bareos Director.

#

1.6 Quick Start

To get Bareos up and running quickly, the author recommends that you first scan the Terminology section below, then quickly review the next chapter entitled The Current State of Bareos, then the Installing Bareos, the Getting Started with Bareos, which will give you a quick overview of getting Bareos running. After which, you should proceed to the chapter How to Configure Bareos, and finally the chapter on Running Bareos.

#

1.7 Terminology

Administrator

The person or persons responsible for administrating the Bareos system.

Backup

The term Backup refers to a Bareos Job that saves files.

Bootstrap File

The bootstrap file is an ASCII file containing a compact form of commands that allow Bareos or the stand-alone file extraction utility (bextract) to restore the contents of one or more Volumes, for example, the current state of a system just backed up. With a bootstrap file, Bareos can restore your system without a Catalog. You can create a bootstrap file from a Catalog to extract any file or files you wish.

Catalog

The Catalog is used to store summary information about the Jobs, Clients, and Files that were backed up and on what Volume or Volumes. The information saved in the Catalog permits the administrator or user to determine what jobs were run, their status as well as the important characteristics of each file that was backed up, and most importantly, it permits you to choose what files to restore. The Catalog is an online resource, but does not contain the data for the files backed up. Most of the information stored in the catalog is also stored on the backup volumes (i.e. tapes). Of course, the tapes will also have a copy of the file data in addition to the File Attributes (see below).

The catalog feature is one part of Bareos that distinguishes it from simple backup and archive programs such as dump and tar.

Client

In Bareos’s terminology, the word Client refers to the machine being backed up, and it is synonymous with the File services or File daemon, and quite often, it is referred to it as the FD. A Client is defined in a configuration file resource.

Console

The program that interfaces to the Director allowing the user or system administrator to control Bareos.

Daemon

Unix terminology for a program that is always present in the background to carry out a designated task. On Windows systems, as well as some Unix systems, daemons are called Services.

Directive

The term directive is used to refer to a statement or a record within a Resource in a configuration file that defines one specific setting. For example, the Name directive defines the name of the Resource.

Director

The main Bareos server daemon that schedules and directs all Bareos operations. Occasionally, the project refers to the Director as DIR.

Differential

A backup that includes all files changed since the last Full save started. Note, other backup programs may define this differently.

File Attributes

The File Attributes are all the information necessary about a file to identify it and all its properties such as size, creation date, modification date, permissions, etc. Normally, the attributes are handled entirely by Bareos so that the user never needs to be concerned about them. The attributes do not include the file’s data.

File daemon

The daemon running on the client computer to be backed up. This is also referred to as the File services, and sometimes as the Client services or the FD.

FileSet

A FileSet is a Resource contained in a configuration file that defines the files to be backed up. It consists of a list of included files or directories, a list of excluded files, and how the file is to be stored (compression, encryption, signatures). For more details, see the FileSet Resource in the Director chapter of this document.

Incremental

A backup that includes all files changed since the last Full, Differential, or Incremental backup started. It is normally specified on the Level directive within the Job resource definition, or in a Schedule resource.

Job

A Bareos Job is a configuration resource that defines the work that Bareos must perform to backup or restore a particular Client. It consists of the Type (backup, restore, verify, etc), the Level (full, differential, incremental, etc.), the FileSet, and Storage the files are to be backed up (Storage device, Media Pool). For more details, see the Job Resource in the Director chapter of this document.

Monitor

The program that interfaces to all the daemons allowing the user or system administrator to monitor Bareos status.

Resource

A resource is a part of a configuration file that defines a specific unit of information that is available to Bareos. It consists of several directives (individual configuration statements). For example, the Job resource defines all the properties of a specific Job: name, schedule, Volume pool, backup type, backup level, ...

Restore

A restore is a configuration resource that describes the operation of recovering a file from backup media. It is the inverse of a save, except that in most cases, a restore will normally have a small set of files to restore, while normally a Save backs up all the files on the system. Of course, after a disk crash, Bareos can be called upon to do a full Restore of all files that were on the system.

Schedule

A Schedule is a configuration resource that defines when the Bareos Job will be scheduled for execution. To use the Schedule, the Job resource will refer to the name of the Schedule. For more details, see the Schedule Resource in the Director chapter of this document.

Service

This is a program that remains permanently in memory awaiting instructions. In Unix environments, services are also known as daemons.

Storage Coordinates

The information returned from the Storage Services that uniquely locates a file on a backup medium. It consists of two parts: one part pertains to each file saved, and the other part pertains to the whole Job. Normally, this information is saved in the Catalog so that the user doesn’t need specific knowledge of the Storage Coordinates. The Storage Coordinates include the File Attributes (see above) plus the unique location of the information on the backup Volume.

Storage Daemon

The Storage daemon, sometimes referred to as the SD, is the code that writes the attributes and data to a storage Volume (usually a tape or disk).

Session

Normally refers to the internal conversation between the File daemon and the Storage daemon. The File daemon opens a session with the Storage daemon to save a FileSet or to restore it. A session has a one-to-one correspondence to a Bareos Job (see above).

Verify

A verify is a job that compares the current file attributes to the attributes that have previously been stored in the Bareos Catalog. This feature can be used for detecting changes to critical system files similar to what a file integrity checker like Tripwire does. One of the major advantages of using Bareos to do this is that on the machine you want protected such as a server, you can run just the File daemon, and the Director, Storage daemon, and Catalog reside on a different machine. As a consequence, if your server is ever compromised, it is unlikely that your verification database will be tampered with.

Verify can also be used to check that the most recent Job data written to a Volume agrees with what is stored in the Catalog (i.e. it compares the file attributes), *or it can check the Volume contents against the original files on disk.

Retention Period

There are various kinds of retention periods that Bareos recognizes. The most important are the File Retention Period, Job Retention Period, and the Volume Retention Period. Each of these retention periods applies to the time that specific records will be kept in the Catalog database. This should not be confused with the time that the data saved to a Volume is valid.

The File Retention Period determines the time that File records are kept in the catalog database. This period is important for two reasons: the first is that as long as File records remain in the database, you can ”browse” the database with a console program and restore any individual file. Once the File records are removed or pruned from the database, the individual files of a backup job can no longer be ”browsed”. The second reason for carefully choosing the File Retention Period is because the volume of the database File records use the most storage space in the database. As a consequence, you must ensure that regular ”pruning” of the database file records is done to keep your database from growing too large. (See the Console prune command for more details on this subject).

The Job Retention Period is the length of time that Job records will be kept in the database. Note, all the File records are tied to the Job that saved those files. The File records can be purged leaving the Job records. In this case, information will be available about the jobs that ran, but not the details of the files that were backed up. Normally, when a Job record is purged, all its File records will also be purged.

The Volume Retention Period is the minimum of time that a Volume will be kept before it is reused. Bareos will normally never overwrite a Volume that contains the only backup copy of a file. Under ideal conditions, the Catalog would retain entries for all files backed up for all current Volumes. Once a Volume is overwritten, the files that were backed up on that Volume are automatically removed from the Catalog. However, if there is a very large pool of Volumes or a Volume is never overwritten, the Catalog database may become enormous. To keep the Catalog to a manageable size, the backup information should be removed from the Catalog after the defined File Retention Period. Bareos provides the mechanisms for the catalog to be automatically pruned according to the retention periods defined.

Scan

A Scan operation causes the contents of a Volume or a series of Volumes to be scanned. These Volumes with the information on which files they contain are restored to the Bareos Catalog. Once the information is restored to the Catalog, the files contained on those Volumes may be easily restored. This function is particularly useful if certain Volumes or Jobs have exceeded their retention period and have been pruned or purged from the Catalog. Scanning data from Volumes into the Catalog is done by using the bscan program. See the bscan section of the Bareos Utilities chapter of this manual for more details.

Volume

A Volume is an archive unit, normally a tape or a named disk file where Bareos stores the data from one or more backup jobs. All Bareos Volumes have a software label written to the Volume by Bareos so that it identifies what Volume it is really reading. (Normally there should be no confusion with disk files, but with tapes, it is easy to mount the wrong one.)

#

1.8 What Bareos is Not

Bareos is a backup, restore and verification program and is not a complete disaster recovery system in itself, but it can be a key part of one if you plan carefully and follow the instructions included in the Disaster Recovery chapter of this manual.

#

1.9 Interactions Between the Bareos Services

The following block diagram shows the typical interactions between the Bareos Services for a backup job. Each block represents in general a separate process (normally a daemon). In general, the Director oversees the flow of information. It also maintains the Catalog.

#

1.10 The Current State of Bareos

#

1.10.1 What is Implemented

• Job Control
  • Network backup/restore with centralized Director.
  • Internal scheduler for automatic Job execution.
  • Scheduling of multiple Jobs at the same time.
  • You may run one Job at a time or multiple simultaneous Jobs (sometimes called multiplexing).
  • Job sequencing using priorities.
  • Console interface to the Director allowing complete control. Some GUIs are also available.
• Security
  • Verification of files previously cataloged, permitting a Tripwire like capability (system break-in detection).
  • CRAM-MD5 password authentication between each component (daemon).
  • Configurable TLS (SSL) communications encryption between each component.
  • Configurable Data (on Volume) encryption on a Client by Client basis.
  • Computation of MD5 or SHA1 signatures of the file data if requested.
• Restore Features
  • Restore of one or more files selected interactively either for the current backup or a backup prior to a specified time and date.
  • Listing and Restoration of files using stand-alone bls and bextract tool programs. Among other things, this permits extraction of files when Bareos and/or the catalog are not available. Note, the recommended way to restore files is using the restore command in the Console. These programs are designed for use as a last resort.
  • Ability to restore the catalog database rapidly by using bootstrap files (previously saved).
  • Ability to recreate the catalog database by scanning backup Volumes using the bscan program.
• SQL Catalog
  • Catalog database facility for remembering Volumes, Pools, Jobs, and Files backed up.
  • Support for PostgreSQL, MySQL and SQLite Catalog databases.
  • User extensible queries to the PostgreSQL, MySQL and SQLite databases.
• Advanced Volume and Pool Management
  • Labeled Volumes, preventing accidental overwriting (at least by Bareos).
  • Any number of Jobs and Clients can be backed up to a single Volume. That is, you can backup and restore Linux, Unix and Windows machines to the same Volume.
  • Multi-volume saves. When a Volume is full, Bareos automatically requests the next Volume and continues the backup.
  • Pool and Volume library management providing Volume flexibility (e.g. monthly, weekly, daily Volume sets, Volume sets segregated by Client, ...).
  • Machine independent Volume data format. Linux, Solaris, and Windows clients can all be backed up to the same Volume if desired.
  • The Volume data format is upwards compatible so that old Volumes can always be read.
  • A flexible message handler including routing of messages from any daemon back to the Director and automatic email reporting.
  • Data spooling to disk during backup with subsequent write to tape from the spooled disk files. This prevents tape ”shoe shine” during Incremental/Differential backups.
• Advanced Support for most Storage Devices
  • Autochanger support using a simple shell interface that can interface to virtually any autoloader program. A script for mtx is provided.
  • Support for autochanger barcodes – automatic tape labeling from barcodes.
  • Automatic support for multiple autochanger magazines either using barcodes or by reading the tapes.
  • Support for multiple drive autochangers.
  • Raw device backup/restore. Restore must be to the same device.
  • All Volume blocks contain a data checksum.
  • Migration support – move data from one Pool to another or one Volume to another.
• Multi-Operating System Support
  • Programmed to handle arbitrarily long filenames and messages.
  • Compression on a file by file basis done by the Client program if requested before network transit.
  • Saves and restores POSIX ACLs and Extended Attributes on most OSes if enabled.
  • Access control lists for Consoles that permit restricting user access to only their data.
  • Support for save/restore of files larger than 2GB.
  • Support ANSI and IBM tape labels.
  • Support for Unicode filenames (e.g. Chinese) on Win32 machines
  • Consistent backup of open files on Win32 systems using Volume Shadow Copy (VSS).
  • Support for path/filename lengths of up to 64K on Win32 machines (unlimited on Unix/Linux machines).
• Miscellaneous
  • Multi-threaded implementation.

#

1.10.2 Advantages Over Other Backup Programs

• Bareos handles multi-volume backups.
• A full comprehensive SQL standard database of all files backed up. This permits online viewing of files saved on any particular Volume.
• Automatic pruning of the database (removal of old records) thus simplifying database administration.
• The modular but integrated design makes Bareos very scalable.
• Bareos has a built-in Job scheduler.
• The Volume format is documented and there are simple C programs to read/write it.
• Bareos uses well defined (IANA registered) TCP/IP ports – no rpcs, no shared memory.
• Bareos installation and configuration is relatively simple compared to other comparable products.
• Aside from several GUI administrative interfaces, Bareos has a comprehensive shell administrative interface, which allows the administrator to use tools such as ssh to administrate any part of Bareos from anywhere.

#

1.10.3 Current Implementation Restrictions

• It is possible to configure the Bareos Director to use multiple Catalogs. However, this is neither advised, nor supported. Multiple catalogs require more management because in general you must know what catalog contains what data, e.g. currently, all Pools are defined in each catalog.
• Bareos can generally restore any backup made from one client to any other client. However, if the architecture is significantly different (i.e. 32 bit architecture to 64 bit or Win32 to Unix), some restrictions may apply (e.g. Solaris door files do not exist on other Unix/Linux machines; there are reports that Zlib compression written with 64 bit machines does not always read correctly on a 32 bit machine).

#

1.10.4 Design Limitations or Restrictions

• Names (resource names, volume names, and such) defined in Bareos configuration files are limited to a fixed number of characters. Currently the limit is defined as 127 characters. Note, this does not apply to filenames, which may be arbitrarily long.
• Command line input to some of the stand alone tools – e.g. btape, bconsole is restricted to several hundred characters maximum. Normally, this is not a restriction, except in the case of listing multiple Volume names for programs such as bscan. To avoid this command line length restriction, please use a .bsr file to specify the Volume names.
• Bareos configuration files for each of the components can be any length. However, the length of an individual line is limited to 500 characters after which it is truncated. If you need lines longer than 500 characters for directives such as ACLs where they permit a list of names are character strings simply specify multiple short lines repeating the directive on each line but with different list values.

#

1.10.5 Items to Note

• Bareos’s Differential and Incremental normal backups are based on time stamps. Consequently, if you move files into an existing directory or move a whole directory into the backup fileset after a Full backup, those files will probably not be backed up by an Incremental save because they will have old dates. This problem is corrected by using Accurate mode backups or by explicitly updating the date/time stamp on all moved files.
• In non Accurate mode, files deleted after a Full save will be included in a restoration. This is typical for most similar backup programs. To avoid this, use Accurate mode backup.

#

Chapter 2
Installing Bareos

If you are like me, you want to get Bareos running immediately to get a feel for it, then later you want to go back and read about all the details. This chapter attempts to accomplish just that: get you going quickly without all the details.

Bareos comes prepackaged for a number of Linux distributions. So the easiest way to get to a running Bareos installation, is to use a platform where prepacked Bareos packages are available. Additional information can be found in the chapter Operating Systems.

If Bareos is available as a package, only 4 steps are required to get to a running Bareos system:

1. Decide about the Bareos release to use
2. Install the Bareos Software Packages
3. Prepare Bareos database
4. Start the daemons

This will start a very basic Bareos installation which will regularly backup a directory to disk. In order to fit it to your needs, you’ll have to adapt the configuration and might want to backup other clients. #

2.1 Decide about the Bareos release to use

• http://download.bareos.org/bareos/release/latest/

You’ll find Bareos binary package repositories at http://download.bareos.org/. The latest stable released version is available at http://download.bareos.org/bareos/release/latest/.

The public key to verify the repository is also in repository directory (Release.key for Debian based distributions, repodata/repomd.xml.key for RPM based distributions).

Section Install the Bareos Software Packages describes how to add the software repository to your system.

#

2.2 Decide about the Database Backend

Bareos offers the following database backends:

• PostgreSQL by package bareos-database-postgresql. This is the recommended backend.
• MariaDB/MySQL by package bareos-database-mysql
• Sqlite by package bareos-database-sqlite3
  Please note! The Sqlite backend is only intended for testing, not for productive use.

PostgreSQL is the default backend.

MariaDB/MySQL backend is also included.

Sqlite backend is intended for testing purposes only.

The Bareos database packages have there dependencies only to the database client packages, therefore the database itself must be installed manually.

If you do not explicitly choose a database backend, your operating system installer will choose one for you. The default should be PostgreSQL, but depending on your operating system and the already installed packages, this may differ.

#

2.3 Install the Bareos Software Packages

The package bareos is only a meta package, that contains dependencies to the main components of Bareos, see Bareos Packages. If you want to setup a distributed environment (like one Director, separate database server, multiple Storage daemons) you have to choose the corresponding Bareos packages to install on each hosts instead of just installing the bareos package.

#

2.3.1 Install on RedHat based Linux Distributions

RHEL≥7, CentOS≥7, Fedora

Bareos Version >= 15.2.0 requires the Jansson library package. On RHEL 7 it is available through the RHEL Server Optional channel. On CentOS 7 and Fedora is it included on the main repository.

 
# 
# define parameter 
# 
 
DIST=RHEL_7 
# or 
# DIST=CentOS_7 
# DIST=Fedora_26 
# DIST=Fedora_25 
 
RELEASE=release/17.2/ 
# or 
# RELEASE=release/latest/ 
# RELEASE=experimental/nightly/ 
 
# add the Bareos repository 
URL=http://download.bareos.org/bareos/$RELEASE/$DIST 
wget -O /etc/yum.repos.d/bareos.repo $URL/bareos.repo 
 
# install Bareos packages 
yum install bareos bareos-database-postgresql
 

RHEL 6, CentOS 6

Bareos Version >= 15.2.0 requires the Jansson library package. This package is available on EPEL 6. Make sure, it is available on your system.

 
# 
# add EPEL repository, if not already present. 
# Required for the jansson package. 
# 
rpm -Uhv https://dl.fedoraproject.org/pub/epel/epel-release-latest-6.noarch.rpm 
 
# 
# define parameter 
# 
 
DIST=RHEL_6 
# DIST=CentOS_6 
 
RELEASE=release/17.2/ 
# or 
# RELEASE=release/latest/ 
# RELEASE=experimental/nightly/ 
 
# add the Bareos repository 
URL=http://download.bareos.org/bareos/$RELEASE/$DIST 
wget -O /etc/yum.repos.d/bareos.repo $URL/bareos.repo 
 
# install Bareos packages 
yum install bareos bareos-database-postgresql
 

RHEL 5

yum in RHEL 5/CentOS 5 has slightly different behaviour as far as dependency resolving is concerned: it sometimes install a dependent package after the one that has the dependency defined. To make sure that it works, install the desired Bareos database backend package first in a separate step:

 
# 
# define parameter 
# 
 
DIST=RHEL_5 
 
RELEASE=release/17.2/ 
# or 
# RELEASE=release/latest/ 
# RELEASE=experimental/nightly/ 
 
# add the Bareos repository 
URL=http://download.bareos.org/bareos/$RELEASE/$DIST 
wget -O /etc/yum.repos.d/bareos.repo $URL/bareos.repo 
 
# install Bareos packages 
yum install bareos-database-postgresql 
yum install bareos
 

#

2.3.2 Install on SUSE based Linux Distributions

SUSE Linux Enterprise Server (SLES), openSUSE

 
# 
# define parameter 
# 
 
DIST=SLE_12_SP3 
# or 
# DIST=SLE_12_SP2 
# DIST=SLE_12_SP1 
# DIST=SLE_11_SP4 
# DIST=openSUSE_Leap_42.3 
# DIST=openSUSE_Leap_42.2 
 
RELEASE=release/17.2/ 
# or 
# RELEASE=release/latest/ 
# RELEASE=experimental/nightly/ 
 
# add the Bareos repository 
URL=http://download.bareos.org/bareos/$RELEASE/$DIST 
zypper addrepo --refresh $URL/bareos.repo 
 
# install Bareos packages 
zypper install bareos bareos-database-postgresql
 

#

2.3.3 Install on Debian based Linux Distributions

Debian / Ubuntu

Bareos Version >= 15.2.0 requires the Jansson library package. On Ubuntu is it available in Ubuntu Universe. In Debian, is it included in the main repository.

 
# 
# define parameter 
# 
 
DIST=Debian_9.0 
# or 
# DIST=Debian_8.0 
# DIST=xUbuntu_16.04 
# DIST=xUbuntu_14.04 
# DIST=xUbuntu_12.04 
 
RELEASE=release/17.2/ 
# or 
# RELEASE=release/latest/ 
# RELEASE=experimental/nightly/ 
 
URL=http://download.bareos.org/bareos/$RELEASE/$DIST 
 
# add the Bareos repository 
printf "deb $URL /\n" > /etc/apt/sources.list.d/bareos.list 
 
# add package key 
wget -q $URL/Release.key -O- | apt-key add - 
 
# install Bareos packages 
apt-get update 
apt-get install bareos bareos-database-postgresql
 

If you prefer using the versions of Bareos directly integrated into the distributions, please note that there are some differences, see Limitations of the Debian.org/Ubuntu Universe version of Bareos.

#

2.3.4 Install on Univention Corporate Server

Univention

Bareos offers additional functionality and integration into an Univention Corporate Server environment. Please follow the intructions in Univention Corporate Server.

If you are not interested in this additional functionality, the commands described in Install on Debian based Linux Distributions will also work for Univention Corporate Servers.

#

2.4 Prepare Bareos database

We assume that you have already your database installed and basically running. Using the PostgreSQL database backend is recommended.

The easiest way to set up a database is using an system account that have passwordless local access to the database. Often this is the user root for MySQL and the user postgres for PostgreSQL.

For details, see chapter Catalog Maintenance.

#

2.4.1 Debian based Linux Distributions

Since Bareos Version >= 14.2.0 the Debian (and Ubuntu) based packages support the dbconfig-common mechanism to create and update the Bareos database.

Follow the instructions during install to configure it according to your needs.

If you decide not to use dbconfig-common (selecting <No> on the initial dialog), follow the instructions for Other Platforms.

The selectable database backends depend on the bareos-database-* packages installed.

For details see dbconfig-common (Debian).

#

2.4.2 Other Platforms

PostgreSQL

If your are using PostgreSQL and your PostgreSQL administration user is postgres (default), use following commands:

 
su postgres -c /usr/lib/bareos/scripts/create_bareos_database 
su postgres -c /usr/lib/bareos/scripts/make_bareos_tables 
su postgres -c /usr/lib/bareos/scripts/grant_bareos_privileges
 

MySQL/MariaDB

Make sure, that root has direct access to the local MySQL server. Check if the command mysql connects to the database without defining the password. This is the default on RedHat and SUSE distributions. On other systems (Debian, Ubuntu), create the file ~/.my.cnf with your authentication informations:

 
[client] 
host=localhost 
user=root 
password=YourPasswordForAccessingMysqlAsRoot
 

It is recommended, to secure the Bareos database connection with a password. See Catalog Maintenance – MySQL about how to archieve this. For testing, using a password-less MySQL connection is probable okay. Setup the Bareos database tables by following commands:

 
/usr/lib/bareos/scripts/create_bareos_database 
/usr/lib/bareos/scripts/make_bareos_tables 
/usr/lib/bareos/scripts/grant_bareos_privileges
 

As some Bareos updates require a database schema update, therefore the file /root/.my.cnf might also be useful in the future.

#

2.5 Start the daemons

 
service bareos-dir start 
service bareos-sd start 
service bareos-fd start
 

You will eventually have to allow access to the ports 9101-9103, used by Bareos.

Now you should be able to access the director using the bconsole.

When you want to use the bareos-webui, please refer to the chapter Installing Bareos Webui.

#

Chapter 3
Installing Bareos Webui

This chapter addresses the installation process of the Bareos Webui.

Since Version >= 15.2.0 Bareos Webui is part of the Bareos project and available for a number of platforms.

3.1 Features

• Intuitive web interface
• Multilinugual
• Can access multiple directors and catalogs
• Individual accounts and ACL support via Bareos restricted named consoles
• Tape Autochanger management, with the possibility to label, import/export media and update your autochanger slot status
• Temporarly enable or disable jobs, clients and schedules and also see their current state
• Show
  • Detailed information about Jobs, Clients, Filesets, Pools, Volumes, Storages, Schedules, Logs and Director messages
  • Filedaemon, Storage- and Director updates
  • Client, Director, Storage and Scheduler status
• Backup Jobs
  • Start, cancel, rerun and restore from.
  • Show the file list of backup jobs
• Restore files by browsing through a filetree of your backup jobs.
  • Merge your backup jobs history and filesets of a client or use a single backup job for restore.
  • Restore files to a different client instead of the origin
• bconsole interface (limited to non-interactive commands)

#

3.2 System Requirements

• A platform, for which the bareos-webui package is available, see Bareos Packages.
• A working Bareos environment.
• Bareos Director version >= Bareos Webui version.
• The Bareos Webui can be installed on any host. It does not have to be installed on the same as the Bareos Director.
• The default installation uses an Apache webserver with mod-rewrite, mod-php and mod-setenv.
• PHP >= 5.3.23
• On SUSE Linux Enterprise 12 you need the additional SUSE Linux Enterprise Module for Web Scripting 12.

#

3.2.1 Version < 16.2

Bareos Webui Version >= 16.2.4 incorporates the required Zend Framework 2 components, no extra Zend Framework installation is required. For older versions of bareos-webui, you must install Zend Framework separately. Unfortunately, not all distributions offer Zend Framework 2 packages. The following list shows where to get the Zend Framework 2 package:

• RHEL, CentOS
  • https://fedoraproject.org/wiki/EPEL
  • https://apps.fedoraproject.org/packages/php-ZendFramework2
• Fedora
  • https://apps.fedoraproject.org/packages/php-ZendFramework2
• SUSE, Debian, Ubuntu
  • http://download.bareos.org/bareos

Also be aware, that older versions of Bareos Director do not support the Subdirectory Configuration Scheme and therefore Bareos configuration resource files must be included manually.

#

3.3 Installation

#

3.3.1 Adding the Bareos Repository

If not already done, add the Bareos repository that is matching your Linux distribution. Please have a look at the chapter Install the Bareos Software Packages for more information on how to achieve this.

#

3.3.2 Install the bareos-webui package

After adding the repository simply install the bareos-webui package via your package manager.

• RHEL, CentOS and Fedora

   
  yum install bareos-webui
        
  

  Commands 3.1:

  or

   
  dnf install bareos-webui
        
  

  Commands 3.2:

• SUSE Linux Enterprise Server (SLES), openSUSE

   
  zypper install bareos-webui
        
  

  Commands 3.3:

• Debian, Ubuntu

   
  apt-get install bareos-webui
        
  

  Commands 3.4:

#

3.3.3 Minimal Configuration

This assumes, Bareos Director and Bareos Webui are installed on the same host.

1. If you are using SELinux, allow HTTPD scripts and modules make network connections:

    
   setsebool -P httpd_can_network_connect on
         
   

   Commands 3.5:

   For details, see SELinux.

2. Restart Apache (to load configuration provided by bareos-webui, see Configure your Apache Webserver)
3. Use bconsole to create a user with name admin and password secret and permissions defined in webui-adminDir Profile:

    
   *configure add console name=admin password=secret profile=webui-admin
         
   

   bconsole 3.6: add a named console

   Of course, you can choose other names and passwords. For details, see Create a restricted consoles.

4. Login to http://HOSTNAME/bareos-webui with username and password as created in 3.

#

3.3.4 Configuration Details

Create a restricted consoles

There is not need, that Bareos Webui itself provide a user management. Instead it uses so named ConsoleDir defined in the Bareos Director. You can have multiple consoles with different names and passwords, sort of like multiple users, each with different privileges.

At least one ConsoleDir is required to use the Bareos Webui.

To allow a user with name admin and password secret to access the Bareos Director with permissions defined in the webui-adminDir Profile (see Configuration of profile resources), either

• create a file /etc/bareos/bareos-dir.d/console/admin.conf with following content:

   
  Console { 
    Name = "admin" 
    Password = "secret" 
    Profile = "webui-admin" 
  }
        
  

  Resource 3.7: bareos-dir.d/console/admin.conf

  To enable this, reload or restart your Bareos Director.

• or use the bconsole:

   
  *configure add console name=admin password=secret profile=webui-admin
        
  

  bconsole 3.8: add console

For details, please read Console Resource.

Configuration of profile resources

The package bareos-webui comes with a predefined profile for Bareos Webui: webui-adminDir Profile.

If your Bareos Webui is installed on another system than the Bareos Director, you have to copy the profile to the Bareos Director.

This is the default profile, giving access to all Bareos resources and allowing all commands used by the Bareos Webui:

 
Profile { 
  Name = webui-admin 
  CommandACL = !.bvfs_clear_cache, !.exit, !.sql, !configure, !create, !delete, !purge, !sqlquery, !umount, !unmount, *all* 
  Job ACL = *all* 
  Schedule ACL = *all* 
  Catalog ACL = *all* 
  Pool ACL = *all* 
  Storage ACL = *all* 
  Client ACL = *all* 
  FileSet ACL = *all* 
  Where ACL = *all* 
  Plugin Options ACL = *all* 
}
 

The ProfileDir itself does not give any access to the Bareos Director, but can be used by ConsoleDir, which do give access to the Bareos Director, see Create a restricted consoles.

For details, please read Profile Resource.

SELinux

To use Bareos Director on a system with SELinux enabled, permission must be given to HTTPD to make network connections:

 
setsebool -P httpd_can_network_connect on
 

Configure your Apache Webserver

The package bareos-webui provides a default configuration for Apache. Depending on your distribution, it is installed at /etc/apache2/conf.d/bareos-webui.conf, /etc/httpd/conf.d/bareos-webui.conf or /etc/apache2/available-conf/bareos-webui.conf.

The required Apache modules, setenv, rewrite and php are enabled via package postinstall script. However, after installing the bareos-webui package, you need to restart your Apache webserver manually.

Configure your /etc/bareos-webui/directors.ini

Configure your directors in /etc/bareos-webui/directors.ini to match your settings.

The configuration file /etc/bareos-webui/directors.ini should look similar to this:

 
; 
; Bareos WebUI Configuration File 
; 
; File: /etc/bareos-webui/directors.ini 
; 
 
;------------------------------------------------------------------------------ 
; Section localhost-dir 
;------------------------------------------------------------------------------ 
[localhost-dir] 
 
; Enable or disable section. Possible values are "yes" or "no", the default is "yes". 
enabled = "yes" 
 
; Fill in the IP-Address or FQDN of you director. 
diraddress = "localhost" 
 
; Default value is 9101 
dirport = 9101 
 
; Set catalog to explicit value if you have multiple catalogs 
;catalog = "MyCatalog" 
 
; TLS verify peer 
; Possible values: true or false 
tls_verify_peer = false 
 
; Server can do TLS 
; Possible values: true or false 
server_can_do_tls = false 
 
; Server requires TLS 
; Possible values: true or false 
server_requires_tls = false 
 
; Client can do TLS 
; Possible values: true or false 
client_can_do_tls = false 
 
; Client requires TLS 
; Possible value: true or false 
client_requires_tls = false 
 
; Path to the certificate authority file 
; E.g. ca_file = "/etc/bareos-webui/tls/BareosCA.crt" 
;ca_file = "" 
 
; Path to the cert file which needs to contain the client certificate and the key in PEM encoding 
; E.g. ca_file = "/etc/bareos-webui/tls/restricted-named-console.pem" 
;cert_file = "" 
 
; Passphrase needed to unlock the above cert file if set 
;cert_file_passphrase = "" 
 
; Allowed common names 
; E.g. allowed_cns = "host1.example.com" 
;allowed_cns = "" 
 
;------------------------------------------------------------------------------ 
; Section another-host-dir 
;------------------------------------------------------------------------------ 
[another-host-dir] 
enabled = "no" 
diraddress = "192.168.120.1" 
dirport = 9101 
;catalog = "MyCatalog" 
;tls_verify_peer = false 
;server_can_do_tls = false 
;server_requires_tls = false 
;client_can_do_tls = false 
;client_requires_tls = false 
;ca_file = "" 
;cert_file = "" 
;cert_file_passphrase = "" 
;allowed_cns = ""
 

You can add as many directors as you want, also the same host with a different name and different catalog, if you have multiple catalogs.

Configure your /etc/bareos-webui/configuration.ini

Since Version >= 16.2.2 you are able to configure some parameters of the Bareos Webui to your needs.

 
; 
; Bareos WebUI Configuration File 
; 
; File: /etc/bareos-webui/configuration.ini 
; 
 
;------------------------------------------------------------------------------ 
; SESSION SETTINGS 
;------------------------------------------------------------------------------ 
; 
[session] 
; Default: 3600 seconds 
timeout=3600 
 
;------------------------------------------------------------------------------ 
; DASHBOARD SETTINGS 
;------------------------------------------------------------------------------ 
[dashboard] 
; Autorefresh Interval 
; Default: 60000 milliseconds 
autorefresh_interval=60000 
 
;------------------------------------------------------------------------------ 
; TABLE SETTINGS 
;------------------------------------------------------------------------------ 
[tables] 
; Possible values for pagination 
; Default: 10,25,50,100 
pagination_values=10,25,50,100 
 
; Default number of rows per page 
; for possible values see pagination_values 
; Default: 25 
pagination_default_value=25 
 
; State saving - restore table state on page reload. 
; Default: false 
save_previous_state=false 
 
;------------------------------------------------------------------------------ 
; VARIOUS SETTINGS 
;------------------------------------------------------------------------------ 
[autochanger] 
; Pooltype for label to use as filter. 
; Default: none 
labelpooltype=scratch
 

#

3.4 Upgrade from 15.2 to 16.2

#

3.4.1 Console/Profile changes

The Bareos Webui Director profile shipped with Bareos 15.2 (webuiDir Profile in the file /etc/bareos/bareos-dir.d/webui-profiles.conf) is not sufficient to use the Bareos Webui 16.2. This has several reasons:

1. The handling of acls is more strict in Bareos 16.2 than it has been in Bareos 15.2. Substring matching is no longer enabled, therefore you need to change .bvfs_* to .bvfs_.* in your Command ACL Dir Profile to have a proper regular expression. Otherwise the restore module won’t work any longer, especially the file browser.
2. The Bareos Webui 16.2 uses following additional commands:
   • .help
   • .schedule
   • .pools
   • import
   • export
   • update
   • release
   • enable
   • disable

If you used an unmodified /etc/bareos/bareos-dir.d/webui-profiles.conf file, the easiest way is to overwrite it with the new profile file /etc/bareos/bareos-dir.d/profile/webui-admin.conf. The new webui-adminDir Profile allows all commands, except of the dangerous ones, see Configuration of profile resources.

#

3.4.2 directors.ini

Since Version >= 16.2.0 it is possible to work with different catalogs. Therefore the catalog parameter has been introduced. If you don’t set a catalog explicitly the default MyCatalogDir Catalog will be used. Please see Configure your /etc/bareos-webui/directors.ini for more details.

#

3.4.3 configuration.ini

Since 16.2 the Bareos Webui introduced an additional configuration file besides the directors.ini file named configuration.ini where you are able to adjust some parameters of the webui to your needs. Please see Configure your /etc/bareos-webui/directors.ini for more details.

#

3.5 Additional information

#

3.5.1 NGINX

If you prefer to use Bareos Webui on Nginx with php5-fpm instead of Apache, a basic working configuration could look like this:

 
server { 
 
        listen       9100; 
        server_name  bareos; 
        root         /var/www/bareos-webui/public; 
 
        location / { 
                index index.php; 
                try_files $uri $uri/ /index.php?$query_string; 
        } 
 
        location ~ .php$ { 
 
                include snippets/fastcgi-php.conf; 
 
                # php5-cgi alone: 
                # pass the PHP 
                # scripts to FastCGI server 
                # listening on 127.0.0.1:9000 
                #fastcgi_pass 127.0.0.1:9000; 
 
                # php5-fpm: 
                fastcgi_pass unix:/var/run/php5-fpm.sock; 
 
                # APPLICATION_ENV:  set to ’development’ or ’production’ 
                #fastcgi_param APPLICATION_ENV development; 
                fastcgi_param APPLICATION_ENV production; 
 
        } 
 
}
 

This will make the Bareos Webui accessible at http://bareos:9100/ (assuming your DNS resolve the hostname bareos to the NGINX server).

#

Chapter 4
Updating Bareos

In most cases, a Bareos update is simply done by a package update of the distribution. Please remind, that Bareos Director and Bareos Storage Daemon must always have the same version. The version of the File Daemon may differ, see chapter about ??. #

4.1 Updating the configuration files

When updating Bareos through the distribution packaging mechanism, the existing configuration kept as they are.

If you don’t want to modify the behavior, there is normally no need to modify the configuration.

However, in some rare cases, configuration changes are required. These cases are described in the Release Notes.

With Bareos version 16.2.4 the default configuration uses the Subdirectory Configuration Scheme. This scheme offers various improvements. However, if your are updating from earlier versions, your existing single configuration files (/etc/bareos/bareos-*.conf) stay in place and are contentiously used by Bareos. The new default configuration resource files will also be installed (/etc/bareos/bareos-*.d/*/*.conf). However, they will only be used, when the legacy configuration file does not exist.

See Updates from Bareos < 16.2.4 for details and how to migrate to Subdirectory Configuration Scheme.

#

4.2 Updating the database scheme

Sometimes improvements in Bareos make it necessary to update the database scheme.

Please note! If the Bareos catalog database does not have the current schema, the Bareos Director refuses to start.

Detailed information can then be found in the log file /var/log/bareos/bareos.log.

Take a look into the Release Notes to see which Bareos updates do require a database scheme update.

Please note! Especially the upgrade to Bareos ≥ 17.2.0 restructures the File database table. In larger installations this is very time consuming and temporarily doubles the amount of required database disk space.

#

4.2.1 Debian based Linux Distributions

Since Bareos Version >= 14.2.0 the Debian (and Ubuntu) based packages support the dbconfig-common mechanism to create and update the Bareos database. If this is properly configured, the database schema will be automatically adapted by the Bareos packages.

Please note! When using the PostgreSQL backend and updating to Bareos < 14.2.3, it is necessary to manually grant database permissions, normally by using

 
root@linux:~#
 su - postgres -c /usr/lib/bareos/scripts/grant_bareos_privileges
 

For details see dbconfig-common (Debian).

If you disabled the usage of dbconfig-common, follow the instructions for Other Platforms.

#

4.2.2 Other Platforms

This has to be done as database administrator. On most platforms Bareos knows only about the credentials to access the Bareos database, but not about the database administrator to modify the database schema.

The task of updating the database schema is done by the script /usr/lib/bareos/scripts/update_bareos_tables.

However, this script requires administration access to the database. Depending on your distribution and your database, this requires different preparations. More details can be found in chapter Catalog Maintenance.

Please note! If you’re updating to Bareos <= 13.2.3 and have configured the Bareos database during install using Bareos environment variables (db_name, db_user or db_password, see Catalog Maintenance), make sure to have these variables defined in the same way when calling the update and grant scripts. Newer versions of Bareos read these variables from the Director configuration file /etc/bareos/bareos-dir.conf. However, make sure that the user running the database scripts has read access to this file (or set the environment variables). The postgres user normally does not have the required permissions.

PostgreSQL

If your are using PostgreSQL and your PostgreSQL administrator is postgres (default), use following commands:

 
su postgres -c /usr/lib/bareos/scripts/update_bareos_tables 
su postgres -c /usr/lib/bareos/scripts/grant_bareos_privileges