Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bacula-web/bacula-web

Open source web based reporting and monitoring tool for Bacula
https://github.com/bacula-web/bacula-web

bacula monitoring opensource php reporting ui web web-application

Last synced: 10 days ago
JSON representation

Open source web based reporting and monitoring tool for Bacula

Awesome Lists containing this project

README

        

# Bacula-Web

[![Latest Stable Version](http://poser.pugx.org/bacula-web/bacula-web/v)](https://packagist.org/packages/bacula-web/bacula-web) [![Total Downloads](http://poser.pugx.org/bacula-web/bacula-web/downloads)](https://packagist.org/packages/bacula-web/bacula-web) [![Latest Unstable Version](http://poser.pugx.org/bacula-web/bacula-web/v/unstable)](https://packagist.org/packages/bacula-web/bacula-web) [![License](http://poser.pugx.org/bacula-web/bacula-web/license)](https://packagist.org/packages/bacula-web/bacula-web) [![PHP Version Require](http://poser.pugx.org/bacula-web/bacula-web/require/php)](https://packagist.org/packages/bacula-web/bacula-web) [![Documentation Status](https://readthedocs.org/projects/bacula-web/badge/?version=latest)](http://docs.bacula-web.org/en/master/?badge=latest) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=bacula-web_bacula-web&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=bacula-web_bacula-web) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=bacula-web_bacula-web&metric=bugs)](https://sonarcloud.io/summary/new_code?id=bacula-web_bacula-web)[![Build Status](https://app.travis-ci.com/bacula-web/bacula-web.svg?branch=master)](https://app.travis-ci.com/bacula-web/bacula-web)

![Bacula-Web dashboard](https://www.bacula-web.org/bacula-web-dashboard.png)

Bacula-Web is an open source reporting and monitoring tool for [Bacula](https://www.bacula.org).

It provides a lot of reports and informations about [Bacula](https://www.bacula.org) backup infrastructure.

All the metrics and information provided by Bacula-Web are taken from [Bacula](https://www.bacula.org) 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](https://getbootstrap.com/)
- 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 :heart: [project on Transifex](https://explore.transifex.com/bacula-web/bacula-web/).

Please see the full [the documentation](https://docs.bacula-web.org/en/latest/01_about/features.html) for the full list of features.

## Documentation

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

> Huge thanks to [Read The Docs](https://readthedocs.org/) for supporting open source projects documentation :heart:

## Getting started

Bacula-Web can be installed using Composer, [Docker](docker/README.md) or from source (require advanced skills)

### Using Composer

- Required [PHP](https://www.php.net/) version is >= 8.0
- Make sure PHP CLI installed and extensions [SQlite3](https://www.php.net/manual/en/book.sqlite3.php), [Gettext](https://www.php.net/manual/en/book.gettext.php), [Session](https://www.php.net/manual/en/refs.basic.session.php), [PDO](https://www.php.net/manual/en/book.pdo.php), [MariaDB and MySQL](https://www.php.net/manual/en/set.mysqlinfo.php), [postgreSQL](https://www.php.net/manual/en/book.pgsql.php), [Json](https://www.php.net/manual/en/book.json.php) and [Posix](https://www.php.net/manual/en/book.posix.php) are installed and enabled.
- Install [Composer](https://getcomposer.org/doc/00-intro.md)
- Install Bacula-Web from [Packagist](https://packagist.org/packages/bacula-web/bacula-web)
``` shell
composer create-project --no-dev bacula-web/bacula-web bacula-web
```
- Copy configuration file and adapt it to your setup
```shell
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](https://docs.bacula-web.org/en/latest/02_install/installcomposer.html#fix-files-folders-ownership-and-permissions))
- Setup either Apache, Nginx or Lighttpd (see [Web server setup and configuration](https://docs.bacula-web.org/en/latest/02_install/webserver-setup.html#web-server-setup-and-configuration))
- Create your first user
```shell
$ sudo -u www-data php bwc setupauth
```
- Test your setup
```shell
$ 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](https://github.com/bacula-web/bacula-web/issues).

> Please see the [bugs and feature request guide](https://docs.bacula-web.org/en/latest/03_get-help/support.html) before.

For questions or feedbacks, please use [GitHub discussions](https://github.com/bacula-web/bacula-web/discussions) or
contact me at [[email protected]](mailto:[email protected]).

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.

### Contributors



## License

The GPLv2. Please see [license file](LICENSE) for more information.

## Security

If you discover a security issue, see [SECURITY.md](SECURITY.md)

## Credits

- Original author: Juan Luis Francés Jimenez
- Current maintainer: [Davide Franco](https://github.com/dfranco)
and [community contributors](https://github.com/bacula-web/bacula-web/graphs/contributors)

## Sponsors

JetBrains Logo (Main) logo
Travis CI logo
Private NPM repository and Maven, RPM, DEB, PyPi and RubyGems Repository · packagecloud
Lokalise logo

## 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 :heart: