Welcome to Bacularis’ documentation!

Brief Tutorial

• Introduction
  • Main features
  • Component relationship
  • Characteristic
  • Live demo
• Installing Bacularis
  • Overview
  • Requirements
  • Install using RPM packages
  • Install using DEB packages
  • Install using Docker
  • Install using Composer
  • Bacularis and Baculum
  • PGP verification key
• Configuring Bacularis
  • Access from web browser
  • Installation wizards
  • Authentication
  • Authorization
  • Users
  • Autochanger management
  • Multiple API hosts
• Updating Bacularis
  • General notes
  • Binary packages update
  • Composer project update
• Troubleshooting
  • Permission denied error when saving Bacula configuration
  • HTTP error 500 and no interface page is loading
  • Error 1000 when you go to Volumes page
  • Time fields contain invalid date/time values
  • The job history list or the job files table is empty
  • The Bacularis job tables are loading slowly
  • Warning about legacy keyring on apt update command
  • Job file list does not show results
  • Searching by filename does not work in restore wizard
  • Where to find help?

Remote host management

• Basic information
  • API capabilities
  • Host connection
  • Bacula configuration
• Preparing hosts
  • Before start
  • Installation automation
  • Host binding
  • Assigning hosts
• Using hosts
  • Host selection
  • Actions

Users

• Restricted access
  • Access levels
• Access to pages
  • Roles
  • Purpose
• Access to Bacula resources
  • Basics
  • Configuration
• Access to functions
  • Scopes
  • What scopes to set

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
• SSH configuration
  • When to use
  • Authentication
  • Security

Bacularis API

• Versions
  • API version 2
• Example usage

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. Join to Bacularis project in GitHub
  • 7. 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
  • Icons
• History
  • History of Bacularis
• Thanks
  • Bacula
  • The Bacula Community
  • The PRADO framework

About Bacularis

Bacularis provides two web applications:

• Bacularis API - the Bacula software programming interface

• Bacularis Web - a web interface to manage Bacula programs

Bacula is an open-source software to backup, recovery and data verification. Bacularis Web is a web interface to configure, manage and monitor Bacula backups. To work the Bacularis Web uses a Bacularis API instances installed on hosts with Bacula programs.

The general Bacularis idea is serving the web interface to easier work with Bacula programs and backups. The interface also includes restore data capability, volumes management, users settings and other functions.