bacula-web/bacula-web

The open source web based reporting and monitoring tool for Bacula

v9.5.0 2024-03-19 06:19 UTC

Requires

• php: ^8.0|^8.1|^8.2
• ext-gettext: *
• ext-mbstring: *
• ext-openssl: *
• ext-pdo: *
• ext-posix: *
• ext-sqlite3: *
• components/font-awesome: 6.*
• guzzlehttp/psr7: ^2
• novus/nvd3: @stable
• odan/session: ^6.1
• pear/date_humandiff: ^0.5.0
• php-di/php-di: ^7.0
• slim/csrf: ^1.3
• slim/slim: 4.*
• slim/twig-view: ^3.3
• symfony/console: 6.0.19
• symfony/translation: ^5.4
• symfony/twig-bridge: ^5.4
• twbs/bootstrap: 5.2.3
• vlucas/phpdotenv: ^5.5
• vlucas/valitron: ^1.4

Requires (Dev)

• phpmd/phpmd: @stable
• phpstan/phpstan: ^1.10
• phpunit/phpunit: 9.5.26
• squizlabs/php_codesniffer: @stable

GPL-2.0-only

• Davide Franco

• php
• monitoring
• reporting
• bacula

README

Bacula-Web is an open source reporting and monitoring tool for Bacula.

It provides a lot of reports and informations about Bacula backup infrastructure.

All the metrics and information provided by Bacula-Web are taken from Bacula catalog database and only require read-only access to the Bacula director catalog database.

Main features

• Main dashboard (gives you an overall status of your backups jobs, used volumes, weekly backup statistics, etc.)
• Jobs report, Jobs logs, Pools and Volumes reports
• Several Bacula directors statistics from a single web UI
• Responsive design using Bootstrap
• Bacula Directors report which gives you an overview of each Bacula director(s) statistics
• Browse backup jobs files and folders
• Users authentication
• Translated in more than 15 languages with the help from community users ❤️ project on Transifex.

Please see the full the documentation for the full list of features.

Documentation

You can find the complete documentation of Bacula-Web at https://docs.bacula-web.org

Huge thanks to Read The Docs for supporting open source projects documentation ❤️

Getting started

Bacula-Web can be installed using Composer, Docker or from source (require advanced skills)

Using Composer

• Required PHP version is >= 8.0
• Make sure PHP CLI installed and extensions SQlite3, Gettext, Session, PDO, MySQL, postgreSQL, Json and Posix are installed and enabled.
• Install Composer
• Install Bacula-Web from Packagist

  composer create-project --no-dev bacula-web/bacula-web bacula-web

• Copy configuration file and adapt it to your setup

  cd bacula-web
  cp -pv application/config/config.php.sample application/config/config.php 

• Make sure application/views/cache and application/assets/protected are writable by the web server process user (see section in documentation)
• Setup either Apache, Nginx or Lighttpd (see Web server setup and configuration)
• Create your first user

  $ sudo -u www-data php bwc setupauth

• Test your setup

  $ sudo -u www-data php bwc check

  or use the test page https://bacula-web-url/test

Note related to installation using Composer archive

The main purpose of this pre-installed archive was to provide an easy way for users who weren't able to install Composer on their servers Composer archive installation option will not be supported anymore from next major version (v9.0.0)

Getting help

To report an issue or request a new feature, use GitHub project issues.

Please see the bugs and feature request guide before.

For questions or feedbacks, please use GitHub discussions or contact me at [e-mail].

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Contributors

License

The GPLv2. Please see license file for more information.

Security

If you discover a security issue, see SECURITY.md

Credits

• Original author: Juan Luis Francés Jimenez
• Current maintainer: Davide Franco and community contributors

Sponsors

Support the project

Bacula-Web is an open source project and will always be free of charge.

It is maintained on my spare time, with the great help from the community users.

If you enjoy using Bacula-Web and would like to encourage the project efforts, please consider suporting the project by making a small donation using the buttons below.

Thanks for using and supporting Bacula-Web project ❤️