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

Tasks and Concepts

• Bareos Console
  • Console Configuration
  • Running the Console Program
    • Exit the Console Program
    • Running the Console from a Shell Script
  • Console Keywords
  • Console Commands
    • Special dot (.) Commands
    • Special At (@) Commands
  • Adding Volumes to a Pool
• The Restore Command
  • General
  • Restore Command
  • Selecting Files by Filename
  • Replace Options
  • Command Line Arguments
  • Using File Relocation
    • Introduction
    • RegexWhere Format
      • Examples
  • Restoring Directory Attributes
  • Restoring on Windows
  • Restore Errors
  • Example Restore Job Resource
  • File Selection Commands
• Volume Management
  • Key Concepts and Resource Records
    • Pool Options to Limit the Volume Usage
    • Automatic Volume Labeling
    • Restricting the Number of Volumes and Recycling
  • Concurrent Disk Jobs
    • Example for two clients, separate devices and recycling
    • Using Multiple Storage Devices
      • Example: use four storage devices pointing to the same directory
  • Automatic Volume Recycling
    • Automatic Pruning
    • Pruning Directives
    • Recycling Algorithm
    • Recycle Status
    • Daily, Weekly, Monthly Tape Usage Example
    • Automatic Pruning and Recycling Example
    • Manually Recycling Volumes
• Automated Disk Backup
  • Overall Design
    • Full Pool
    • Differential Pool
    • Incremental Pool
  • Configuration Files
• Autochanger Support
  • Knowing What SCSI Devices You Have
    • Linux
    • FreeBSD
    • Solaris
  • Slots
  • Multiple Devices
  • Device Configuration Records
  • Specifying Slots When Labeling
  • Changing Cartridges
  • Dealing with Multiple Magazines
  • Update Slots Command
  • Using the Autochanger
  • Barcode Support
  • Use bconsole to display Autochanger content
  • Bareos Autochanger Interface
  • Tapespeed and blocksizes
    • Possible Problems
    • How can I find out which block size was used when the tape was written?
    • Direct access to Volumes with with non-default block sizes
    • How to configure the block sizes in your environment
  • Tape Drive Cleaning
• Using Tape Drives without Autochanger
  • Simple One Tape Backup
    • Advantages
    • Disadvantages
    • Practical Details
  • Manually Changing Tapes
  • Daily Tape Rotation
    • Advantages of Daily Tape Rotation
    • Disadvantages of Daily Tape Rotation
    • Practical Details of Daily Tape Rotation
• Storage Backends
  • Droplet Storage Backend
    • Requirements
    • Installation
    • Configuration
      • AWS S3
        • Director
        • Storage Daemon
      • CEPH Object Gateway S3
    • Troubleshooting
      • iothreads
      • New AWS S3 Buckets
        • Workaround:
      • AWS S3 Logging
  • GFAPI Storage Backend
  • Rados Storage Backend
• Data Spooling
  • Data Spooling Directives
    • Additional Notes
• Migration and Copy
  • Important Migration Considerations
  • Configure Copy or Migration Jobs
    • Job Resource
    • Pool Resource
      • Example Migration Jobs
        • Multiple Storage Daemons
• Always Incremental Backup Scheme
  • Conventional Backup Scheme Drawbacks
  • Always Incremental Concept
  • How to configure in Bareos
    • Always Incremental Backup Job
    • Consolidate Job
    • Storages and Pools
  • How it works
  • Enhancements for the Always Incremental Backup Scheme
    • The basic always incremental scheme
    • Always Incremental Max Full Age
    • Max Full Consolidations
  • Long Term Storage of Always Incremental Jobs
    • Copy Jobs
    • Virtual Full Jobs
• How to manually transfer data/volumes
  • Import Data from a Remote Storage Daemon
  • Import Data from a Independent Remote Full Bareos Installation
• File Deduplication using Base Jobs
• Plugins
  • Python Plugins
    • Modernization of the Python plugin API
      • Description of the Bareos Python plugin API for Bareos < 20
      • Description of the new Bareos Python plugin API for Bareos >= 20
      • Porting existing Python plugins
      • Switching to Python 3
      • Recovering old backups
  • File Daemon Plugins
    • bpipe Plugin
    • MySQL Plugin
    • MSSQL Plugin
    • LDAP Plugin
    • Cephfs Plugin
    • Rados Plugin
    • GlusterFS Plugin
    • python-fd Plugin
      • Command Plugins
      • Option Plugins
    • VMware Plugin
      • Status
      • Requirements
      • Installation
      • Configuration
      • Backup
      • Restore
      • Restore to local VMDK File
      • Debugging in case of problems
    • oVirt Plugin
      • Status of oVirt Plugin
      • Requirements of oVirt Plugin
      • Installation of oVirt Plugin
      • Configuration of oVirt Plugin
      • Backup with oVirt Plugin
      • Restore with oVirt Plugin
      • Restore to local disk image
    • Apache Libcloud Plugin
      • Status of Libcloud Plugin
      • Requirements of Libcloud Plugin
      • Installation of Libcloud Plugin
      • Configuration of Libcloud Plugin
    • Percona XtraBackup Plugin
      • Prerequisites of percona XtraBackup Plugin
      • Installation of percona XtraBackup Plugin
      • Configuration of percona XtraBackup Plugin
      • Restore with percona XtraBackup Plugin
        • Troubleshooting
    • PostgreSQL Plugin
      • Concept
      • Prerequisites for the PostgreSQL Plugin
      • Installation of the PostgreSQL Plugin
      • Configuration of the PostgreSQL Plugin
      • Restore with the PostgreSQL Plugin
        • PostgreSQL >= 12
        • PostgreSQL < 12
        • Initiate the Recovery Process
      • Troubleshooting the PostgreSQL Plugin
  • Storage Daemon Plugins
    • autoxflate-sd
    • scsicrypto-sd
      • General
        • LTO Hardware Encryption
        • The scsicrypto-sd plugin
        • Changes in the director
      • Configuration of the scsicrypto-sd plugin
        • SCSI crypto setup
        • Security Setup
        • Changes in bareos-sd.conf
        • Changes in bareos-dir.conf
      • Testing
      • Disaster Recovery
    • scsitapealert-sd
    • python-sd Plugin
  • Director Plugins
    • python-dir Plugin
      • Loading plugins
      • Write your own Python Plugin
• The Windows Version of Bareos
  • Windows Installation
    • Graphical Installation
    • Command Line (Silent) Installation
      • Commandline Switches
  • Dealing with Windows Problems
    • Antivirus Program
    • Enable Debuggging
  • Windows Compatibility Considerations
    • Exclusively Opened Files
    • Backing up the Windows Registry
    • Windows Reparse Points
      • VMPs and VSS Snapshots
    • Hard Links
    • FilesNotToBackup Registry Key
    • Windows dedup support
    • Store all file attributes
    • Support for Windows EFS filesystems
  • Volume Shadow Copy Service (VSS)
    • VSS Problems
  • Backup/Restore of Windows Registry
    • Well-Known Hives
    • Restoring the Registry
  • Windows Firewalls
    • Network TCP Port
  • Windows Restore Problems
  • Windows Backup Problems
  • Windows Ownership and Permissions Problems
  • Advanced Windows Configuration
    • Windows Service
      • Installing multiple Windows filedaemon services
    • Windows Specific Command Line Options
• Network setup
  • Client Initiated Connection
  • Passive Clients
    • Usage
  • Using different IP Adresses for SD – FD Communication
• Network Connections Overview
  • Full connection overview
  • Named Console and Default Console
  • Default Backup/Restore
  • Client Initiated Backup/Restore
  • Passive Client Backup/Restore
  • Storage-Storage Migration
  • Tray-Monitor
• Transport Encryption
  • TLS Configuration Directives
  • Getting TLS Certificates
  • Example TLS Configuration Files
    • Bareos Director
    • Bareos Storage Daemon
    • Bareos File Daemon
  • Compatibility with Bareos File Daemon
    • Bareos File Daemon connection handshake probing
    • Bareos File Daemon 18.2 with Bareos before 18.2
      • Bareos Director configuration
      • Bareos Storage Daemon configuration
      • Bareos File Daemon configuration before 18.2
    • Bareos File Daemon before 18.2 with Bareos 18.2
      • Bareos File Daemon configuration
  • Bareos Webui
    • Configuration example for Bareos 17.2
    • Configuration example for Bareos 18.2
    • Overview of the settings in the Bareos Webui directors.ini file
  • TLS Configuration Reference
• Data Encryption
  • Encryption Technical Details
  • Generating Private/Public Encryption Keys
  • Example Data Encryption Configurations (bareos-fd.conf)
  • Decrypting with a Master Key
• NDMP Backups with Bareos
  • NDMP Basics
    • NDMP Topologies
      • NDMP 3-way Backup: Data Agent and Tape Agent running on different systems
      • NDMP 2-way Backup: Data Agent and Tape Agent running on the same system
      • Properties of the different NDMP Backup topologies
  • NDMP Backup in Bareos
  • NDMP_BAREOS
    • Example Setup for NDMP_BAREOS backup
      • Enable NDMP on your storage appliance
      • Bareos Director: Configure NDMP Client Resource
      • Bareos Storage Daemon: Configure NDMP
        • Enabling NDMP
        • Add a NDMP resource
      • Bareos Director: Configure a Paired Storage
      • Bareos Director: Configure NDMP Fileset
        • Example NDMP Fileset to backup a subset of a NDMP filesystem
      • Bareos Director: Configure NDMP Jobs
    • Run NDMP Backup
    • Run NDMP Restore
      • Full Restore
      • Restore files to original path
      • Restore files to different path
    • NDMP Copy Jobs
      • Restore to NDMP Primary Storage System
    • Limitations
      • NDMP Job limitations when scanning in volumes
      • Restore always transfers the full main backup file to the Primary Storage System
  • NDMP_NATIVE
    • Example Setup for NDMP_NATIVE backup
      • Configure a NDMP Client
      • Configure a NDMP Fileset
      • Configure a NDMP Storage
      • Configure a Pool for the NDMP Tapes
      • Configure NDMP Jobs
    • Label Tapes
    • Run NDMP_NATIVE Backup
    • Run NDMP_NATIVE Restore
  • NDMP Common
    • NDMP Backup Level
      • Differential Backups
      • Incremental Backups
    • NDMP Debugging
    • Bareos NDMP Common Limitations
      • NDMP Fileset limitations
      • Single file restore on incremental backups
      • Temporary memory mapped database
    • Tested Environments
• Catalog Maintenance
  • Catalog Database
    • dbconfig-common (Debian)
    • Manual Configuration
      • PostgreSQL configuration
      • Remote PostgreSQL Database
  • Retention Periods
    • Database Size
    • Setting Retention Periods
      • Job Statistics
  • PostgreSQL Database
    • Compacting Your PostgreSQL Database
      • What To Do When The Database Keeps Growing
    • Repairing Your PostgreSQL Database
  • Backing Up Your Bareos Database
• Bareos Security Issues
  • Configuring and Testing TCP Wrappers
  • Secure Erase Command
• Pluggable Authentication Modules (PAM)
  • Introduction
  • Configuration
    • PAM Module
      • Upgrading from previous versions
    • Bareos Console
    • PAM User