Welcome to Bacularis’ documentation!

About Bacularis

Bacula is a powerful software solution for backup, recovery, and data verification.

Bacularis is a web interface designed to install, configure, manage, and monitor Bacula components. It offers a complete solution for managing Bacula backup environments on both local and remote hosts.

The main goal of Bacularis is to simplify working with Bacula by providing an intuitive and user-friendly web interface.

Table of content

Brief Tutorial

• Introduction
  • Main features
  • Component relationship
  • Characteristic
  • Live demo
  • Function overview
• Before you start
  • General information
  • Do you already have Bacula installed?
  • Which installation method should I use?
  • Is Bacularis compatible with my Bacula version?
• Installing Bacularis
  • Overview
  • Requirements
  • Install using RPM packages
  • Install using DEB packages
  • Install using Docker
  • Install using Composer
  • Install manually
  • Bacularis and Baculum
  • Enable SSL
  • PGP verification key
• Configuring Bacularis
  • Installation wizard
  • Bacula database access
  • SUDO settings
  • Autochanger management
  • Multiple API hosts
• Updating Bacularis
  • General notes
  • Updating binary packages
  • Updating Composer-based installations
  • Manual installation update
• Troubleshooting
  • Permission denied error when saving Bacula configuration
  • HTTP error 500 and no interface page is loading
  • Error 100 after switching connection from HTTP to HTTPS
  • File daemon crashes after running Bacularis plugins (MySQL, MariaDB, PostgreSQL…)
  • U2F security key authentication does not work
  • Not possible to enable TOTP 2FA function
  • Error 1000 when you go to Volumes page
  • Error during Bacula installation in initial wizard on Ubuntu 22.04 Jammy
  • Error about a problem with connection to bconsole when using Docker image
  • PHP warning from preg_match() about allocation of JIT memory
  • Time fields contain invalid date/time values
  • The job history list or the job files table is empty
  • Warning about legacy keyring on apt update command
  • Job file list does not show results
  • Job file list is empty if you sort by size or MTIME
  • Searching by filename does not work in restore wizard
  • I forgot my admin password. What should I do?
  • How to enable debug mode
  • How to use deployment SSH key to other purposes
  • Where to find help?
• Optimization
  • General
  • DNS
  • Database
  • Web server
  • Bacularis

Bacula basics

• Install Bacula
  • What is required?
  • How to do it?
    • Step 1 - General
    • Step 5 - Authentication
    • Step 6 - Summary
  • Important notes
  • Video guide
• Create Bacula file storage
  • What is required?
  • How to do it?
    • Preparation
    • Step 1 - General
    • Step 2 - Storage
    • Step 3 - Summary
  • Important notes
  • Video guide
• Create Bacula cloud storage
  • What is required?
  • How to do it?
    • Preparation
    • Step 1 - General
    • Step 2 - Storage
    • Step 3 - Cloud
    • Step 4 - Summary
  • Important notes
  • Video guide
• Create Bacula tape storage
  • What is required?
  • How to do it?
    • Preparation
    • Step 1 - General
    • Step 2 - Storage
    • Step 3 - Summary
  • Important notes
  • Video guide
• Create Bacula Linux client
  • What is required?
  • How to do it?
    • Preparation
    • Installing Bacularis API
    • Installing Bacula Client
  • Important notes
  • Video guide
• Create Bacula Windows client
  • What is required?
  • How to do it?
    • Install Bacula Client
      • Preparation
      • Step 1 - Welcome
      • Step 2 - License agreement
      • Step 3 - Installation type
      • Step 4 - Choose components
      • Step 5 - Choose install location
      • Step 6 - Configuration
      • Step 7 - Configuration (continued)
      • Step 8 - Installing
      • Step 9 - End
    • Add new Client to Director
    • Important notes
  • Video guide
• Create backup job
  • Backup job parts
  • What is required?
  • Definitions
    • What to back up?
    • Where to back up?
    • How to back up?
    • When to back up?
    • Job resource parts
  • How to do it?
    • Step 1 - General
    • Step 2 - What
    • Step 3 - Where
    • Step 4 - How
    • Step 5 - When
    • Step 6 - Summary
  • Video guide
• Define what to back up
  • What is required?
  • How to do it?
    • Add FileSet window
      • Add single file/directory
      • Add files by file browser
      • Add options block
      • Add plugin
    • Assign FileSet to job
  • Video guide
• Create volume pool
  • General information
    • Purpose of a pool
    • Pool inheritance
    • Assigning a pool in backup jobs
  • What is required?
  • How to do it?
    • Create Pool
    • Prepare pool volumes
    • Using Pool
  • Important notes
  • Video guide
• How to use backup schedule
  • What is required?
  • How to do it?
    • Time intervals
    • Configuration job directives
    • Add run block
  • Video guide
• Run restore
  • What is required?
  • How to do it?
    • Step 1 - Client
    • Step 2 - Backup
      • Selected backup method
      • Group most recent backups method
    • Step 3 - Files
    • Step 4 - Options
    • Step 5 - Run
  • Video guide
• How to diagnose problems
  • Jobs
    • Step 1: Job status
      • Jobs with warnings
    • Step 2: Job log
    • Step 3: Director status
    • Step 4: Client status and storage status
    • Step 5: Bacula configuration
  • Video guide
    • What to do if job gets stuck

Remote host management

• Basic information
  • API capabilities
    • Enabling API capabilities
  • Host connection
  • Bacula configuration
• Preparing hosts
  • Before start
  • Automated installation
  • Host binding
  • Assigning hosts
• Using hosts
  • Host selection
    • Configuration host selection
  • Actions
• API host groups
  • Definition
  • Configuration
  • When to use
• Web access
  • Definition
  • Purpose
  • How does it work?
  • Access limits
  • Response
  • Error codes
  • Web Access vs Bacularis API
  • Action types
  • Create web access
  • Video guide

Authentication

• General
  • Authentication types
  • Login options
    • Non-organization users
    • Organization users
  • Example login page
• Auth methods
  • Local user authentication
    • Security
    • Multi-factor authentication (MFA)
    • Organization support
    • User provisioning
    • Settings form
  • Basic user authentication
    • Security
    • Multi-factor authentication (MFA)
    • Organization support
    • User provisioning
    • Settings form
  • LDAP user authentication
    • Security
    • Multi-factor authentication (MFA)
    • Organization support
    • User provisioning
    • Settings form
    • Video guide
• Identity providers
  • SSO - OpenID Connect
    • Requirements
    • Organization support
    • User provisioning
    • User attributes
    • Security
    • Single Sign-On
      • Sessions
      • User information
      • Single logout
    • Settings form
    • Video guides
      • Keycloak
      • Okta
  • Social login - Google
    • Requirements
    • Organization support
    • User provisioning
    • How to use it
    • Important notes
    • Settings form
    • Video guide
  • Social login - Facebook
    • Requirements
    • Organization support
    • User provisioning
    • How to use it
    • Settings form
• Multi-factor auth
  • TOTP 2FA
    • What is it
    • Auth methods
    • How to use it
    • Video guide
  • FIDO U2F
    • What is it
    • Auth methods
    • How to use it
    • Video guide

Users

• Restricted access
  • Access levels
• Access to pages
  • Roles
  • Purpose
  • Page list
• Access to Bacula resources
  • Basics
  • Configuration
    • Set access button
    • New user wizard
    • Manual Console ACL configuration
  • Resource permissions
• Access to functions
  • Scopes
  • What scopes to set
• Organizations
  • What is organization
  • Purpose
  • When to use
  • How to create it
• User provisioning
  • What is it
  • How it works
  • Using organizations
  • How to use it
• Examples
  • Introduction
  • Tape operator example
  • Regular user example

Deployment

• Basic information
  • Purpose
  • General idea
  • Supported operating systems
  • Requirements
• OS profiles
  • What is OS profile
  • Configuration options
    • Repositories
    • Bacularis API access
    • Bacularis API settings
      • Package management
      • Configuration
      • Console
      • Catalog
      • Actions
• Repo auths
  • What is repo auth
  • Usage
  • Authentication methods
  • Bacularis package repositories
• SSH configuration
  • When to use
  • Authentication
  • Security

Plugins

• Basic information
• Database plugins
• Notification plugins
• Configuration plugins
• Action plugins
• Run action plugins
• Create plugin

Configs and patterns

• Basic information
  • Purpose
  • Configs and patterns
  • Who can use configs and patterns?
  • Is it safe?
• Configs
  • Definition
  • Usage
  • Simulation
  • Video guide
• Patterns
  • Definition
  • Usage
  • Simulation
  • Video guide
• Overwrite policies
  • Types of policies
  • Policy: Do not overwrite
    • Example for simple value
    • Example for complex value
  • Policy: Overwrite
    • Example for simple value
    • Example for complex value
  • API config format
  • Examples
• Save to pattern
  • Purpose
  • Use cases
  • How it works?
  • Video guide
• Variables
  • Definition
  • Examples
    • Using variables in configs
    • Using variables in patterns
  • How to use variables?
  • Video guides
• Constants
  • Definition
  • How to use constants?
  • Video guide

Tagging

• Basic information
  • Purpose
  • What can be tagged?
  • How to use tagging?
  • Tag properties
  • Tag management
  • Delete tag
• Accessibility
  • Access types
  • Local and global usage
  • Namespaces
  • Disabling global tags
• Severity
  • Levels
  • Usage
  • How to filter?

Bacularis API

• Versions
  • API version 3
• Example usage
• Authorization
  • OAuth2
    • General information
    • Enabling OAuth2

Contributions

• Translators guide
  • 1. Intro
  • 2. Join to the Bacularis project in Crowdin
  • 3. Let us know
  • 4. Translation
  • 5. Check translations on the web interface
    • For installation by binary packages
    • For installation by Composer
    • Example
  • 6. Prepare pull request
• Developers guide
  • 1. Intro
  • 2. General advices
    • End of lines
    • Indents
    • Comments
  • 3. PHP code
    • Static code analysis
    • Coding style
    • Documentation
    • License and copyright
  • Pull requests

Licenses

• Authors
  • Bacularis Authors
  • Tools
    • PRADO framework
    • Flotr2
    • DataTables
    • FontAwesome
    • Opentip
    • gauge.js
    • Noto Emoji icons
    • W3.CSS
    • jQuery
    • QRCode.js
    • jQuery UI
    • jsmin-php
• License
  • Bacularis license
  • Documentation license
• Attribution
  • Documentation
    • Text
    • Pages
    • Theme
    • Icons
• History
  • History of Bacularis
• Thanks
  • Bacula
  • The Bacula and Bacularis Community
  • The PRADO framework