README.md
1## Bacula-Web
2
3[](http://docs.bacula-web.org/en/master/?badge=latest)
4[](https://codeclimate.com/github/bacula-web/bacula-web/maintainability)
5[](https://scrutinizer-ci.com/g/bacula-web/bacula-web/?branch=develop)
6
7Bacula-Web is a web based tool written in [PHP](https://php.net) which provides a summarized view of your [Bacula](https://www.bacula.org) backup infrastructure.
8
9Metrics and informations displayed in Bacula-Web are taken from [Bacula](https://www.bacula.org) catalog database, no need to setup bconsole, bvfs, etc.
10
11In addition, the access to the database is made read-only, so your Bacula catalog database remains safe :)
12
13---
14
15### Why this project ?
16
17Bacula-Web project has been revived since 2010.
18
19I tought that having an easy and useful web UI to monitor Bacula backup jobs, volumes, pools, etc. would be nice.
20So I decided to take care of this project which was almost abandonned since more than 4 years.
21
22You can find more information about the project timeline in the official documentation [here](https://docs.bacula-web.org/en/latest/01_about/about.html#the-project-history)
23
24*This is my little contribution to [Bacula](http://www.bacula.org) community project. Hope you enjoy it !*
25
26<p align="center">
27<img src="https://www.bacula-web.org/bacula-web-dashboard.png" width="500px" alt="Bacula-Web dashboard"/>
28</p>
29
30---
31
32### Features
33
34* **Easy to setup**
35 > It takes only few minutes to setup Bacula-Web, read the [documentation](https://docs.bacula-web.org/en/latest/02_install/index.html)
36* **Install once**
37 > Install Bacula-Web once, then monitor as many Bacula directors you have in your infrastructure
38* **Secure**
39 > Users authentication is enabled by default, no Bacula's information are disclosed
40* **Dashboard**
41 > Bacula-Web dashboard gives you a general overview of your [Bacula](https://www.bacula.org) backup jobs, pools, volumes, etc.
42* **Use it in your native language**
43 > Bacula-Web has been translated in [more than 15 languages](https://www.transifex.com/bacula-web/public/) by the community users ❤️
44* **Jobs report**
45 > Monitor backup jobs from a single one page (filter and options are also available)
46* **Job Files report**
47 > List files and folders from backup job(s)
48* **Directors report**
49 > High-level report pages for all configured [Bacula](https://www.bacula.org) directors
50* **Pools and volumes**
51 > Display all your [Bacula](https://www.bacula.org) pools and volumes
52
53---
54
55### Documentation
56
57Visit [Bacula-Web documentation](http://docs.bacula-web.org) for more informations about installation, configuration, upgrade, etc.
58
59---
60
61### Installation
62
63Bacula-Web could be installed [from the source archive](https://docs.bacula-web.org/en/latest/02_install/installarchive.html), but the easiest and recommanded way to install it is by using [Composer](https://getcomposer.org/).
64
65To proceeed, make sure you have Composer installed using [these instructions](https://getcomposer.org/download/)
66
67Then run the command below to install Bacula-Web
68
69```
70$ composer create-project --prefer-dist bacula-web/bacula-web bacula-web
71```
72
73Bacula-Web can be installed using the provided compressed archive or using Composer, check [Installation page](http://docs.bacula-web.org/en/latest/02_install/index.html) for more details
74
75You'll find latest stable release [here](https://www.bacula-web.org/download/)
76
77---
78
79### How to get help ?
80
81Best way to get help or ask a question is to submit a bug report using [GitHub project issues](https://github.com/bacula-web/bacula-web/issues)
82
83### How to contribute ?
84
85#### Translations
86
87If you want to help translating Bacula-Web in your language, please check the [Contribute to translation](http://docs.bacula-web.org/en/latest/04_contribute/translations.html) page
88
89#### Developpment
90
91You can contribute by submitting a GitHub pull request, please have a look the [contribution guide](http://docs.bacula-web.org/en/latest/04_contribute/development.html) first.
92
93---
94
95### License
96
97Bacula-Web source code, web site and documentation are licensed under **GNU GPLv2**
98
99For more details, see [LICENSE](https://github.com/bacula-web/bacula-web/blob/master/LICENSE)
100
101---
102
103### Credits
104
105- Original author: Juan Luis Francés Jimenez
106- Current maintainer: Davide Franco ([@dfranco](https://github.com/dfranco))
107- Contributors: [](https://GitHub.com/bacula-web/bacula-web/badges/graphs/contributors/)
108
109---
110
111### Support the project
112
113As you probably already know, developpers does needs a lot of coffee :coffee: to be more efficient :wink:, so if you think Bacula-Web project desearve a little help, please consider buying me a coffee using the link below.
114
115<a href="https://www.buymeacoffee.com/baculaweb"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=baculaweb&button_colour=FFDD00&font_colour=000000&font_family=Lato&outline_colour=000000&coffee_colour=ffffff"></a>
116
117Thanks for using and supporting Bacula-Web project :heart:
118
){kind=link}
){kind=link}