Logo

Brief Tutorial

  • Introduction
    • Main features
    • Component relationship
    • Characteristic
    • Live demo
    • Function overview
  • Before you start
    • General
    • Do you have Bacula installed?
      • Yes, I have Bacula installed
      • No, I don’t have Bacula installed
    • What installation method should I use?
      • Installing with DEB and RPM binary packages
      • Installing with Composer
      • Installing with Docker
      • Installing manually
    • Will Bacularis work with my Bacula version?
  • Installing Bacularis
    • Overview
    • Requirements
    • Install using RPM packages
      • Package repositories
      • Installation
        • Apache web server
        • Nginx web server
        • Lighttpd web server
      • Access in web browser
    • Install using DEB packages
      • Package repositories
      • Installation
        • Apache web server
        • Nginx web server
        • Lighttpd web server
      • Access in web browser
    • Install using Docker
      • Installation
      • Access in web browser
    • Install using Composer
      • Access in web browser
    • Install manually
      • Prepare files
      • RPM-based Linux distributions
      • DEB-based Linux distributions
      • SELinux settings
      • Optional commands
      • Prepare to run
      • Access in web browser
    • Bacularis and Baculum
      • Bacularis installation on host with Baculum
    • Enable SSL
      • Create self-signed certificate
      • Apache web server
      • Nginx web server
      • Lighttpd web server
    • PGP verification key
  • Configuring Bacularis
    • Access from web browser
    • Installation wizards
      • Bacula Catalog database access
      • SUDO setting
    • Authentication
      • Bacularis API
      • Bacularis Web
    • Authorization
      • OAuth2
        • General information
        • Enabling OAuth2
    • Users
    • Autochanger management
      • Automatic autochanger configuration
      • Manual autochanger configuration
    • Multiple API hosts
  • Updating Bacularis
    • General notes
    • Binary packages update
    • Composer project update
      • [RECOMMENDED] run upgrade as root user
      • [EXPERTS ONLY] run upgrade as regular user
    • 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
    • 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
    • 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
    • Searching by filename does not work in restore wizard
    • I forgot my admin password. What should I do?
    • How to use deployment SSH key to other purposes
      • 1. Use sudo for executing SSH
      • 2. Change SSH key permissions
    • Where to find help?
      • Mailing list
      • Bug tracker
  • Optimization
    • General
    • Database
      • PostgreSQL
      • MySQL/MariaDB
    • Web server
      • Apache
      • Nginx
      • Lighttpd
    • Bacularis
      • Job options
      • Debug mode

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
  • API host groups
    • Definition
    • Configuration
    • When to use

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
  • 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

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

Plugins

  • Basic information
    • Purpose
    • Plugin types
      • Notification plugins
      • Bacula configuration plugins
    • Configuration
    • Localization
      • Bacularis Web
      • Bacularis API
  • Create plugin
    • How to create new plugin
      • Notification plugin example
      • Bacula configuration plugin example
    • Parameters
  • Plugin list
    • System e-mail notification
    • Mattermost notification
    • Bacula configuration

Bacularis API

  • Versions
    • API version 3
  • 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
Bacularis
  • Search

© Copyright 2024, Marcin Haba.

Built with Sphinx using a theme provided by Read the Docs.
Top