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

Bareos Main Reference and Documentation

For information regarding the newest release see the release notes.

• Introduction and Tutorial
  • What is Bareos?
    • History
    • Who Needs Bareos?
    • Bareos Components or Services
      • Bareos Director
      • Bareos Console
      • Bareos File Daemon
      • Bareos Storage Daemon
      • Catalog
    • Bareos Version Numbers and Releases
    • Bareos Packages
    • Quick Start
    • Terminology
    • What Bareos is Not
    • Interactions Between the Bareos Services
    • The Current State of Bareos
      • What is Implemented
      • Advantages Over Other Backup Programs
      • Current Implementation Restrictions
        • Multiple Catalogs
      • Design Limitations or Restrictions
      • Items to Note
  • Installing Bareos
    • Decide about the Bareos release to use
    • Decide about the Database Backend
    • Install the Bareos Software Packages
      • Install on RedHat based Linux Distributions
        • RHEL>7, CentOS>7, Fedora
        • RHEL 6, CentOS 6
      • Install on SUSE based Linux Distributions
        • SUSE Linux Enterprise Server (SLES), openSUSE
      • Install on Debian based Linux Distributions
        • Debian / Ubuntu
      • Install on FreeBSD based Distributions
      • Install on Oracle Solaris
      • Install on Univention Corporate Server
    • Prepare Bareos database
      • Debian based Linux Distributions
      • Other Platforms
        • PostgreSQL
        • MySQL/MariaDB
    • Start the daemons
  • Installing Bareos Webui
    • Features
    • System Requirements
      • Version < 16.2
    • Installation
      • Adding the Bareos Repository
      • Install the bareos-webui package
      • Minimal Configuration
      • Configuration Details
        • Create a restricted consoles
        • Configuration of profile resources
        • SELinux
        • Configure your Apache Webserver
        • Configure your /etc/bareos-webui/directors.ini
        • Configure your /etc/bareos-webui/configuration.ini
        • Configure updating the Bvfs cache frequently
    • Upgrade from 18.2.6 to 18.2.7
      • Configuration changes
    • Upgrade from 15.2 to 16.2
      • Console/Profile changes
      • directors.ini
      • configuration.ini
    • Additional information
      • NGINX
  • Updating Bareos
    • Updating the configuration files
    • Updating the database scheme
      • Debian based Linux Distributions
      • Other Platforms
        • PostgreSQL
        • MySQL/MariaDB
  • Getting Started with Bareos
    • Understanding Jobs and Schedules
    • Understanding Pools, Volumes and Labels
    • Setting Up Bareos Configuration Files
    • Testing your Configuration Files
  • Tutorial
    • Starting the Database
    • Installing Bareos
    • Starting the Daemons
    • Using the Director to Query and Start Jobs
    • Running a Job
    • Restoring Your Files
    • Quitting the Console Program
    • Adding a Client
      • Client: install package
      • Director: configure client
        • Manual configuration of client
      • Client: configure
        • Manual configuration
      • Director: test client, add a job
    • Patience When Starting Daemons or Mounting Blank Tapes
    • Pools
    • Other Useful Console Commands
  • Bareos Webui
    • Command ACL Requirements
    • Access Control Configuration
      • Full Access
      • Limited Access
      • Read-Only Access
    • Restore
      • Available restore parameters
      • Restore multiple files
      • Restore a specific file version
  • Critical Items to Implement Before Production
    • Critical Items
    • Recommended Items
• 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
    • File Daemon Plugins
      • bpipe Plugin
      • PGSQL 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
      • 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
      • Percona XtraBackup Plugin
        • Prerequisites of percona XtraBackup Plugin
        • Installation of percona XtraBackup Plugin
        • Configuration of percona XtraBackup Plugin
        • Restore with percona XtraBackup Plugin
          • Troubleshooting
    • 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
        • MySQL
          • Modify database credentials
        • Sqlite
    • 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
    • MySQL/MariaDB
      • MySQL/MariaDB Support
      • Compacting Your MySQL Database
      • Repairing Your MySQL Database
      • MySQL Table is Full
      • MySQL Server Has Gone Away
      • MySQL Temporary Tables
      • MySQL: Lock Wait Timeout
    • 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
• Configuration
  • Customizing the Configuration
    • Configuration Path Layout
      • Naming
      • What configuration will be used?
        • Relation between Bareos components and configuration
      • Subdirectory Configuration Scheme
        • Reason for the Subdirectory Configuration Scheme
        • Resource file conventions
        • Using Subdirectories Configuration Scheme
          • New installation
          • Updates from Bareos < 16.2.4
    • Configuration File Format
      • Character Sets
      • Comments
      • Semicolons
      • Including other Configuration Files
    • Resource
      • Resource Directive
      • Resource Directive Keyword
        • Upper and Lower Case and Spaces
      • Resource Directive Value
        • Spaces
        • Quotes
        • Numbers
        • Data Types
        • Variable Expansion
          • Variable Expansion on Volume Labels
          • Variable Expansion in Autochanger Commands
          • Variable Expansion in Mount Commands
          • Variable Expansion on RunScripts
          • Variable Expansion in Mail and Operator Commands
    • Names, Passwords and Authorization
  • Director Configuration
    • Director Resource
    • Job Resource
    • JobDefs Resource
    • Schedule Resource
      • Technical Notes on Schedules
    • FileSet Resource
      • FileSet Include Ressource
      • FileSet Exclude Ressource
      • FileSet Options Ressource
      • FileSet Examples
      • Windows FileSets
        • Example Fileset for Windows
      • Testing Your FileSet
    • Client Resource
    • Storage Resource
    • Pool Resource
      • Scratch Pool
    • Catalog Resource
    • Messages Resource
    • Console Resource
    • User Resource
    • Profile Resource
    • Counter Resource
  • Storage Daemon Configuration
    • Storage Resource
    • Director Resource
    • NDMP Resource
    • Device Resource
      • Edit Codes for Mount and Unmount Directives
      • Devices that require a mount (USB)
    • Autochanger Resource
    • Multiplied Device
    • Messages Resource
  • Client/File Daemon Configuration
    • Client Resource
    • Director Resource
    • Messages Resource
    • Example Client Configuration File
  • Messages Configuration
    • Messages Resource
    • Message Types
  • Console Configuration
    • Director Resource
    • Console Resource
    • Example Console Configuration File
      • Using Named Consoles
  • Monitor Configuration
    • Monitor Resource
    • Director Resource
    • Client Resource
    • Storage Resource
    • Tray Monitor
      • Tray Monitor Security
      • Example Tray Monitor configuration
        • Example File daemon’s Director record
        • Example Storage daemon’s Director record
        • Example Director’s Console record
• Developer Guide
  • Bareos Developer Notes
    • History
    • Contributions
    • Patches
    • Bug Database
      • Reporting security issues
    • Memory Leaks
    • Guiding Principles
    • Automatic Sourcecode Formatting
    • Formatting exceptions
    • Sourcecode Comments
    • Do’s
    • Don’ts
  • Build And Test Bareos
    • Building the documentation
    • Building the test-environment
      • Configure (cmake) build settings
      • Using ccache (compiler cache)
    • Systemtests
      • Run all system tests
      • Run a single system test
  • Automatic Version Generation
    • What is this about?
    • How does it work?
      • CMake Variable
      • BareosVersion.cmake
        • Generating BareosVersion.cmake
      • Git Metadata
    • Troubleshooting
      • No git
      • Not a git repository
      • Git repository missing tags
      • Building in the wrong directory
      • Last resort
  • Releasing Bareos
    • Deciding for a version number
    • Preparing the release notes
    • Update version-dependent files
      • version.map.in
    • Prepare the git commits and tags
      • Special considerations for major versions
    • Publishing the release
    • Updating GitHub Release
  • Git Workflow
    • Getting new code or changes into Bareos
    • Releases and Backporting
    • Feature Branches
    • Commits
      • Commit message guideline
  • Message Classes
    • Memory Messages
    • Debug Messages
    • Job Messages
      • Special Cases
    • Queued Job Messages
    • Error Messages
  • Bareos FD Plugin API
    • Normal vs Command vs Options Plugins
    • Loading Plugins
    • loadPlugin
    • Plugin Entry Points
      • newPlugin(bpContext *ctx)
      • freePlugin(bpContext *ctx)
      • getPluginValue(bpContext *ctx, pVariable var, void *value)
      • setPluginValue(bpContext *ctx, pVariable var, void *value)
      • handlePluginEvent(bpContext *ctx, bEvent *event, void *value)
      • startBackupFile(bpContext *ctx, struct save_pkt *sp)
      • endBackupFile(bpContext *ctx)
      • startRestoreFile(bpContext *ctx, const char *cmd)
      • createFile(bpContext *ctx, struct restore_pkt *rp)
      • setFileAttributes(bpContext *ctx, struct restore_pkt *rp)
      • endRestoreFile(bpContext *ctx)
      • pluginIO(bpContext *ctx, struct io_pkt *io)
      • bool checkFile(bpContext *ctx, char *fname)
    • Bareos Plugin Entrypoints
      • bRC registerBareosEvents(bpContext *ctx, …)
      • bRC getBareosValue(bpContext *ctx, bVariable var, void *value)
      • bRC setBareosValue(bpContext *ctx, bVariable var, void *value)
      • bRC JobMessage(bpContext *ctx, const char *file, int line, int type, utime_t mtime, const char *fmt, …)
      • bRC DebugMessage(bpContext *ctx, const char *file, int line, int level, const char *fmt, …)
      • void bareosMalloc(bpContext *ctx, const char *file, int line, size_t size)
      • void bareosFree(bpContext *ctx, const char *file, int line, void *mem)
  • Platform Support
    • General
    • Requirements to become a Supported Platform
  • Daemon Protocol
    • General
    • Low Level Network Protocol
    • General Daemon Protocol
    • The Protocol Used Between the Director and the Storage Daemon
    • The Protocol Used Between the Director and the File Daemon
    • The Save Protocol Between the File Daemon and the Storage Daemon
      • Command and Control Information
      • Data Information
  • File Services Daemon
    • Commands Received from the Director for a Backup
    • Commands Received from the Director for a Restore
  • Storage Daemon Design
    • SD Design Introduction
    • SD Development Outline
    • SD Connections and Sessions
      • SD Append Requests
      • SD Read Requests
    • SD Data Structures
  • Catalog Services
    • General
      • Filenames and Maximum Filename Length
      • Database Table Design
    • Database Tables
      • Path
      • File
      • Job
      • FileSet
      • JobMedia
      • Device
        • Tape Volume
        • Other Volume
      • Media (Volume)
      • Pool
      • Client
      • Storage
      • Counters
      • Log
      • Location
      • LocationLog
      • Version
      • BaseFiles
    • UML Diagram of Database Schema
  • Configuration Parser
    • Introduction
    • Class Model of Storage Daemon Resources
  • Storage Media Output Format
    • General
    • Definitions
    • Overall Format
      • Storage Daemon File Output Format
    • Serialization
    • Block Header
    • Record Header
    • Volume Label Format
    • Session Label
    • Overall Storage Format
    • Examine Volumes
      • bls command
    • Unix File Attributes
    • Old Deprecated Tape Format
  • Bareos Porting Notes
    • Porting Requirements
  • API
    • General
      • Minimal Code in Console Program
      • GUI Interface is Difficult
    • dot commands
    • API Modes
      • API mode 0 (off)
      • API mode 1 (on)
      • API mode 2 (json)
        • Examples
          • Example of a JSON-RPC Error Response
    • Bvfs API
      • General notes
      • Get dependent jobs from a given JobId
      • Generating Bvfs cache
      • List directories
      • List files
        • API mode 0
        • API mode 1
        • API mode 2
      • Get all versions of a specific file
      • Restore set of files
      • Cleanup after Restore
      • Clearing the BVFS Cache
      • Example for directory browsing using bvfs
  • TLS
    • Introduction
    • TLS Handshake before Bareos 18.2
    • TLS Configuration Implementation
    • TLS API Implementation
  • PAM
  • Tests
    • Unit Tests
      • Adding a new Test
  • Bareos Regression Testing
    • Setting up Regession Testing
    • Running the Regression Script
      • Setting the Configuration Parameters
      • Building the Test Bareos
      • Setting up your SQL engine
      • Running the Disk Only Regression
      • Other Tests
      • If a Test Fails
    • Testing a Binary Installation
    • Running a Single Test
    • Writing a Regression Test
      • Running the Tests by Hand
      • Directory Structure
      • Adding a New Test
      • Running a Test Under The Debugger
  • Bareos Memory Management
    • General
      • Statically Allocated Memory
      • Dynamically Allocated Memory
      • Pooled and Non-pooled Memory
        • Types of Memory Pool:
        • Getting Memory:
        • Releasing Memory:
        • Determining the Memory Size:
        • Resizing Pool Memory:
        • Automatic Size Adjustment:
        • Releasing All Pooled Memory:
        • Pooled Memory Statistics:
  • TCP/IP Network Protocol
    • Introduction
    • Network Routines
      • bnet and Threads
      • bnet_open
      • bnet_send
      • bnet_fsend
      • is_bnet_error
      • is_bnet_stop
      • bnet_recv
      • bnet_sig
      • bnet_strerror
      • bnet_close
      • Becoming a Server
    • Higher Level Conventions
    • Network startup activity
    • Debugging
    • Network Sequence Diagrams
      • Backup of a Single File
        • Overview
        • Detailed Diagram
      • Restore of a Single File
        • Overview single file restore
        • Detailed Diagram single file restore
      • Migration of a Single Volume
        • Overview single volume migration
        • Detailed Diagram single volume migration
      • Verify of a Single File (Mode: Volume to Catalog)
        • Overview single file verify
        • Detailed Diagram single file verify
  • Director Console Output
    • object_key_value
    • decoration
    • messages
    • Objects and Arrays
      • named objects
      • nameless objects
      • arrays
    • Example
    • Example with 3 level structure
  • Reservation
    • Introduction
      • Diagram Conventions
      • UseDeviceCmd
      • ReserveDevice
  • Job Execution
    • Introduction
    • Job setup and start
    • Simple backup job
      • Overview simple backup job
      • Detailed View simple backup job
    • Simple restore job
      • Overview simple restore job
      • Detailed View simple restore job
    • Local copy or migrate job
      • Overview local copy job
      • Detailed View local copy job
    • Remote copy or migrate job
      • Overview remote copy job
      • Detailed View remote copy job
  • Python
    • Automatic Sourcecode Formatting
  • Webui
    • Command usage in modules and the according ACL requirements
• Documentation Style Guide
  • Introduction
  • reST Overview
    • Use of whitespace
    • Sphinx naming
      • Role
      • Directive
      • Domain
    • Paragraphs
    • Inline markup
    • Lists, Definition Lists and Quotes
    • Literal block
    • Source Code
    • Hyperlinks
      • External links
      • Internal links
    • Cross-linking markup
    • Sections
    • Explicit Markup
      • Directives
      • Comments
    • File/Directory/Path
    • Note
    • Warning
    • Quote
    • Index
      • .. index::
      • :index:
      • Converted (Latex2Sphinx) Indices
    • Image
    • Table
  • Common Names
    • Bareos Names
    • Bareos Paths and Filenames
    • NDMP
    • Products
  • Specific Formatting
    • Configuration
      • Configuration File
      • Configuration Directive
    • System Command
    • Unix Command Session
      • Unix Commmand Prompt
    • Windows
      • Windows Registry Key
    • Environment Variable
    • SQL
    • Logging
    • Name
    • Volume Parameter
    • Operating System
    • Email Address
    • Backus–Naur form
    • Diagrams
      • A block diagram
      • An activity diagram
      • A sequence diagram
      • A network diagram
      • Any PlantUML diagram
  • Bareos Specific Formatting
    • Document File Structure
    • Bareos Host Names
    • Bareos Configuration
      • Bareos Configuration Resource
      • Resource Type
      • Resource Name
      • Resource Directive
        • Resource Directive Definition
        • Reference to a Resource Directive
        • Resource Directive With Value
    • Bconsole
      • Bconsole Command
      • Bconsole session
    • Bareos Logging
    • Limitation
    • Issues tracked on Mantis
      • bugs.bareos.org
      • Github
        • Pull request
        • Commit
    • Releases
      • Functional Changes
        • Note
      • Release Notes
      • Reference to a Release
      • URLs
        • Release URL - Bareos.org
        • Release URL - Bareos.com
        • Contributions Download URL
  • Gotchas
    • sphinx-build
    • Not shown text
    • Undefined link targets
    • toctree vs include
      • include
      • toctree
    • :option:
• Appendix
  • System Requirements
  • Operating Systems
    • Linux
      • Packages for the different Linux platforms
      • Univention Corporate Server
        • Preamble
        • Quick Start
        • UCR variables
        • Setup
        • Administration
        • Backup Schedule
        • Backup data management
        • Backup Storage
        • Bareos Webui Configuration
        • Add a client to the backup
          • Overview
          • Bareos >= 16.2.4
          • Background
          • Bareos < 16.2.0
      • Debian.org / Ubuntu Universe
        • Limitations of the Debian.org/Ubuntu Universe version of Bareos
    • Mac OS X
      • Installing the Bareos Client as PKG
      • Configuration
        • Option 1: Copy the director resource from the Bareos Director to the Client
        • Option 2: Edit the director resource on the Client
      • Restart bareos-fd after changing the configuration
      • Verify that the Bareos File Daemon is working
  • Bareos Programs
    • Bareos Daemons
      • Daemon Command Line Options
      • bareos-dir
      • bareos-sd
      • bareos-fd
    • Interactive Programs
      • bconsole
      • bareos-webui
      • bat
    • Volume Utility Commands
      • Parameter
        • Specifying the Configuration
        • Specifying a Device
          • Specifying a Device Name For a Tape
          • Specifying a Device Name For a File
        • Specifying Volumes
        • Specifying Maximum Block Size
      • bls
        • Show Detailed File Information
        • Show Label Information
        • Listing Jobs
        • Listing Blocks
      • bextract
        • Extracting with Include or Exclude Lists
        • Extracting With a Bootstrap File
        • Extracting From Multiple Volumes
        • Extracting Under Windows
      • bscan
        • Using bscan to Compare a Volume to an existing Catalog
        • Using bscan to Recreate a Catalog from a Volume
        • Using bscan to Correct the Volume File Count
        • After bscan
      • bcopy
      • btape
        • Using btape to Verify your Tape Drive
        • btape Commands
          • Testing your Tape Drive
      • bscrypto
    • Other Programs
      • bsmtp
      • bareos-dbcheck
      • bregex
      • bwild
      • bpluginfo
  • bareos-dbcopy
    • Synopsis
    • Description
    • Internal workflow
    • Options
  • The Bootstrap File
    • Bootstrap File Format
    • Automatic Generation of Bootstrap Files
    • Bootstrap for bscan
    • Bootstrap Example
  • Verify File Integrity with Bareos
    • The Details
    • Running the Verify
    • What To Do When Differences Are Found
    • A Verify Configuration Example
  • Backward Compatibility
    • Tape Formats
    • Compatibility between Bareos and Bacula
      • Upgrade from Bacula 5.2 to Bareos
        • Rename user and group before upgrading
        • MySQL
        • PostgreSQL
  • Catalog Tables
    • Job
      • JobStatus
  • Howtos
    • Use a dummy device to test the backup
    • Backup Of Third Party Databases
      • Backup of MSSQL Databases with Bareos Plugin
        • Preparation
        • MSSQL Plugin Installation
          • Bareos Windows-Installer
          • Manual install
        • Plugin Test
        • Configure the FileSet
        • Run Backups
        • Restores
          • Restore a Backup Chain
      • Backup of a PostgreSQL Database
        • Backup of a PostgreSQL Database by using the RunScript directive
        • Backup of a PostgreSQL Databases by using the bpipe plugin
        • Backup of a PostgreSQL Databases by using the PGSQL-Plugin
      • Backup of a MySQL Database
        • Backup of MySQL Databases using the Python MySQL plugin
        • Backup of a MySQL Database by using the RunScript directive
        • Backup of a MySQL Database by using the bpipe plugin
    • Migrate MySQL/MariaDB to PostgreSQL
      • Make a backup of your old database
      • Prepare the new database
      • Run bareos-dbcopy
      • Complete the migration process
    • Statistics Collection
      • Director Configuration - Director Resource Directives
      • Director Configuration - Storage Resource Directives
      • Storage Configuration - Storage Resource Directives
      • Storage Configuration - Device Resource Directives
    • Removing a Client
      • Disable a client
      • Remove configuration for client
      • Remove catalog records related to the client
  • Disaster Recovery Using Bareos
    • General
      • Important Considerations
    • Steps to Take Before Disaster Strikes
    • Bare Metal Recovery of Bareos Clients
      • Linux
        • Installation
        • Configuration
        • Backup
        • Recovery
    • Restoring a Bareos Server
  • Troubleshooting
    • Debug Messages
    • Client Access Problems
      • Difficulties Connecting from the FD to the SD
      • Authorization Errors
    • Concurrent Jobs
    • Media VolWrites: integer out of range
    • Tape Labels: ANSI or IBM
      • Reading
      • Writing
    • Tape Drive
      • Get Your Tape Drive Working
    • Autochanger
      • Testing Autochanger and Adapting mtx-changer script
    • Restore
      • Restore a pruned job using a pattern
      • Problems Restoring Files
      • Restoring Files Can Be Slow
      • Restoring When Things Go Wrong
  • Debugging
    • Traceback
    • Testing The Traceback
      • Getting A Traceback On Other Systems
    • Manually Running Bareos Under The Debugger
  • Release Notes
    • Bareos-19.2
      • Bareos-19.2.13
        • General Information
        • Changed
        • Security
      • Bareos-19.2.12
        • General Information
        • Breaking Changes
        • Bugs Fixed
        • Security
        • Other Improvements
      • Bareos-19.2.11
        • General Information
        • Bugs Fixed
        • Other Improvements
      • Bareos-19.2.10
        • General Information
        • Bugs Fixed
        • Other Improvements
      • Bareos-19.2.9
        • General Information
        • VMware Plugin
        • Bugs Fixed
        • Other Improvements
      • Bareos-19.2.8
        • General Information
        • Security
        • Bugs Fixed
        • Other Improvements
        • Internal Project Changes
      • Bareos-19.2.7
        • General Information
        • GlusterFS Backend on CentOS 7/RHEL 7
        • bareos-dbcopy
        • Bugs Fixed
        • Other Improvements
        • Internal Project Changes
      • Bareos-19.2.6
        • General Information
        • MySQL/MariaDB
        • FreeBSD
        • Bugs Fixed
      • Bareos-19.2.5
        • General Information
        • Bugs Fixed
      • Bareos-19.2.4
        • General Information
        • New Features
        • Changed Features
        • Deprecated and Removed Features
        • Bugs Fixed
        • Updated Documentation
        • Internal Project Changes
    • Bareos-18.2
      • Bareos-18.2.9
        • General Information
        • Security
        • Bugfixes and Changes
      • Bareos-18.2.8
        • General Information
        • Bugfixes and Changes
      • Bareos-18.2.7
        • General Information
        • Bugfixes and Changes
      • Bareos-18.2.6
        • General Information
        • New Features
      • Bareos 18.2.5
        • General Information
        • New Features
        • Changed Features
        • Backward compatibility
        • Full connection overview
        • Deprecated and Removed Features
        • Bugs Fixed
        • Updated Documentation
        • Internal Project Changes
    • Bareos-17.2
      • bareos-17.2.10
        • Security
        • Bugfixes and Changes
      • bareos-17.2.9
      • bareos-17.2.8
      • bareos-17.2.7
      • bareos-17.2.6
      • bareos-17.2.5
      • bareos-17.2.4
    • Bareos-16.2
      • bareos-16.2.9
      • bareos-16.2.8
      • bareos-16.2.7
      • bareos-16.2.6
      • bareos-16.2.5
      • bareos-16.2.4
    • Bareos-15.2
      • bareos-15.2.4
      • bareos-15.2.3
      • bareos-15.2.2
      • bareos-15.2.1 (unstable)
    • Bareos-14.2
      • bareos-14.2.7
      • bareos-14.2.6
      • bareos-14.2.5
      • bareos-14.2.4
      • bareos-14.2.3
      • bareos-14.2.2
      • bareos-14.2.1 (unstable)
    • Bareos-13.2
      • bareos-13.2.5
      • bareos-13.2.4
      • bareos-13.2.3
      • bareos-13.2.2
    • Bareos-12.4
      • bareos-12.4.8
      • bareos-12.4.6
      • bareos-12.4.5
      • bareos-12.4.4
      • bareos-12.4.3
      • bareos-12.4.2
      • bareos-12.4.1
  • FAQ
    • General Questions
      • How do I report a security issue?
    • Bareos 18.2.5 FAQ
      • What is the important feature introduced in Bareos 18.2?
      • How to update from Bareos 17.2?
      • How can I see what encryption is being used?
      • What should I do when I get “TLS negotiation failed”?
      • How does the compatibility with old clients work?
      • Does Bareos support TLS 1.3?
      • Are old Bareos clients still working?
      • Can I use a new Bareos 18.2 client with my Bareos 17.2 system?
  • Bareos Copyright, Trademark, and Licenses
    • Licenses Overview
      • FDL
      • AGPL
      • LGPL
      • Public Domain
      • Trademark
      • Disclaimer
      • Other Copyrights and Trademarks
    • GNU Free Documentation License
    • GNU Affero Gerneral Public License
    • GNU Lesser Gerneral Public License
  • Copyright information
• Index