1 ################################################################
3 ################################################################
5 Bweb works well with 1.39 release or later.
9 3) initialize your configuration file
10 4) do some sql stuff (for postgresql or mysql 5 users)
11 5) use the -n option on bconsole so that it works with Expect
12 6) get bacula log more useful
14 8) using sudo with autochanger
17 11) setting mysql read-only account
18 12) get more statistics
19 13) use groups with bweb
21 ################ FILE COPY #####################################
22 # you must get bweb svn files
23 svn checkout https://bacula.svn.sourceforge.net/svnroot/bacula/trunk/gui/bweb bweb
25 # or get them from the released tar files or from the apt or rpms.
28 # Once you have the gui directory loaded, follow the instructions below
29 # or edit the environment variables in the file install_bweb
30 # then execute it. install_web does everything to the next
34 # first, copy the bweb Perl library into your PERL5 INC path
38 install -m 644 -o root -g root bweb/lib/*.pm /usr/share/perl5
40 # copy the bweb perl program to your cgi location
41 mkdir -m 755 /usr/lib/cgi-bin/bweb
42 install -m 755 -o root -g root bweb/cgi/*.pl /usr/lib/cgi-bin/bweb
45 mkdir -m 755 /etc/bacula
46 chown root:bacula /etc/bacula
47 echo '$VAR1 = { template_dir => "/usr/share/bweb/tpl" };' > /etc/bacula/bweb.conf
48 chown www-data /etc/bacula/bweb.conf
50 # copy the bweb template file
51 mkdir -p /usr/share/bweb/tpl
52 install -m 644 -o root -g root bweb/tpl/*.tpl /usr/share/bweb/tpl
54 # copy the bweb graphics elements (bweb elements must reside in /bweb)
56 install -m 644 -o root -g root bweb/html/*.{js,png,css,gif,ico,html} /var/www/bweb
60 WARNING : Your www-data (or wwwrun on SuSE) user must be able to execute bconsole and able
61 to read the bconsole.conf file!
62 You can create an bconsole group for that.
64 ################ USE FRENCH VERSION ############################
66 Simply use lang/fr/tpl/*.tpl files instead of tpl/*.tpl
68 ################ INSTALL PERL LIBRARY ##########################
71 - DBI (with mysql or postgresql support DBD::Pg and DBD::mysql)
72 (SQLite is not supported)
80 You can install perl modules with CPAN
84 Or use your distribution
85 apt-get install libgd-graph-perl libhtml-template-perl libexpect-perl
86 apt-get install libdbd-mysql-perl libdbd-pg-perl libdbi-perl libtime-modules-perl
88 Note: the best way to test if you have all the dependencies
89 fullfilled for Perl is to:
91 cd /var/www/cgi-bin/bweb
94 you might also want to try:
98 To make sure the graphing modules are loaded. However, running it
99 will spray binary graphics data on your terminal. Otherwise, you will
102 That should show you if any of the pre-requisites are missing.
103 On SuSE 10.2, I was able to load all the appropriate modules via rpms,
104 with the exception of Expect and Time::ParseDate, which I loaded manually
107 If you experience problems, always consult the Apache error_log
110 ################ APACHE CONFIGURATION ##########################
112 It could be a good idea to protect your bweb installation (optional).
114 Put this in your httpd.conf, and add user with htpasswd
116 <Directory /usr/lib/cgi-bin/bweb>
117 Options ExecCGI -MultiViews +SymLinksIfOwnerMatch
119 AuthName MyPrivateFile
120 AuthUserFile /etc/apache/htpasswd
125 On SuSE 10.2, the following in /etc/apache2/default-server.conf works.
126 However, it is not secure:
128 Directory "/srv/www/cgi-bin/bweb">
130 Options +ExecCGI -Includes
136 ################ CONFIGURATION #################################
138 Note, this is automatically installed by the install_bweb script.
140 /etc/bacula/bweb.conf looks like : (you can edit it inside bweb)
142 'graph_font' => '/usr/share/fonts/truetype/ttf-bitstream-vera/Vera.ttf',
144 'config_file' => '/etc/bacula/bweb.conf',
145 'bconsole' => '/usr/sbin/bconsole -n -c /etc/bacula/bconsole.conf',
155 'device' => '/dev/changer',
161 'mtxcmd' => '/usr/sbin/mtx',
167 }, 'Bweb::Autochanger' )
170 'template_dir' => '/usr/share/bweb/tpl',
171 'dbi' => 'DBI:mysql:database=bacula',
175 'email_media' => 'eric@localhost'
179 ################ BRESTORE ######################################
181 If you want to use brestore with bweb, you must associate a mime type
182 text/brestore with your brestore.pl, and you must install brestore.
183 See gui/brestore/README for instructions on installing brestore.pl.
185 ################ POSTGRESQL AND MYSQL5 NOTES ####################
187 If you want to use PostgreSQL instead of MySQL, you must add
188 a function to the PostgreSQL Bacula database to get Bweb to work.
190 psql -U bacula bacula < script/bweb-postgresql.sql
192 Tips: PL must be enabled in your cluster, you can do this with postgres user
193 postgres:~$ echo 'CREATE PROCEDURAL LANGUAGE plpgsql;' | psql bacula
196 To get database size with mysql5, edit Bweb.pm and change the DB_SIZE macro
198 # with mysql < 5, you have to play with the ugly SHOW command
199 DB_SIZE => " SELECT 0 ",
200 # works only with mysql 5
201 # DB_SIZE => " SELECT sum(DATA_LENGTH) FROM INFORMATION_SCHEMA.TABLES ",
203 ################ BCONSOLE NOTES ################################
205 You must use bconsole without conio/readline support. For that, use
206 the bconsole -n option. This is done automatically with the standard
207 configuration file. In addition, please ensure that the binary
208 bconsole file can be executed by your web server. It is normally
209 located in /usr/bin/bconsole (or some such file), and must have
210 modes 755 or it will not be executable by your web server. The
211 normal Bacula installation usually sets mode 750.
213 ################ BACULA LOG ####################################
215 If you want Bweb to be able to show listings of the Job output,
216 you must add a "catalog = all, !skipped, !saved" to your
217 messages resource in bacula-dir.conf and restart your Bacula
218 server. This is shown below:
223 operator = root@localhost = mount
224 console = all, !skipped, !saved
225 append = "/tmp/bacula/var/bacula/working/log" = all, !skipped
227 catalog = all, !skipped, !saved
231 ################ BWEB LIMITATION ###############################
233 To get bweb working, you must follow these rules
234 - Media, Storage and Pool must have [A-Za-z_0-9\.-]+ (no space)
235 - AutoChanger name must be same as Device and Location name in bacula
237 ################ SUDO CONFIGURATION ############################
239 If you use sudo, put this on you /etc/sudoers
241 www-data ALL = (root) NOPASSWD: /usr/sbin/mtx -f /dev/changer transfer *
242 www-data ALL = (root) NOPASSWD: /usr/sbin/mtx -f /dev/changer status
243 www-data ALL = (root) NOPASSWD: /usr/sbin/mtx -f /dev/changer load *
244 www-data ALL = (root) NOPASSWD: /usr/sbin/mtx -f /dev/changer unload *
246 ################ BFILEVIEW SETUP ###############################
248 At this time, bfileview works only with PostgreSQL.
250 Alias /bweb/fv /var/spool/bweb
251 <Directory "/var/spool/bweb">
253 AllowOverride AuthConfig
258 mkdir /var/spool/bweb
259 chmod 700 /var/spool/bweb
260 chown www-data /var/spool/bweb
262 You have to remove "<!-- Remove this to activate bfileview" and "-->" from
263 tpl/display_job_zoom.tpl.
265 You MUST use brestore.pl -b to initialize the database, and
266 you CAN use bfileview.pl mode=batch jobid=xxx where=/ to compute tree size.
268 At this time, it's a good idea to schedule brestore.pl -b after your
272 Name = "BackupCatalog"
274 # This creates an ASCII copy of the catalog
275 RunBeforeJob = "/opt/bacula/etc/make_catalog_backup bacula bacula Pei0ahm9"
276 # This deletes the copy of the catalog
277 RunAfterJob = "/opt/bacula/etc/delete_catalog_backup"
278 RunAfterJob = "/usr/local/bin/brestore.pl -b"
281 To upgrade from an old installation, you can use :
282 ALTER TABLE brestore_pathvisibility ADD Size int8;
283 ALTER TABLE brestore_pathvisibility ADD Files int4;
285 ################ ACCESSING TO BWEB ############################
287 Now, you are able to launch firefox/mozilla and go on
288 http://your-server/bweb
290 ################ SETTING MYSQL ACCOUNT ########################
292 At this time, Bweb needs a write access to :
297 - Media::RecyclePoolId (it will change soon)
299 If your doesn't use Location feature, you can use ReadOnly access
300 for all tables, or setup something like :
302 GRANT SELECT ON bacula.* TO 'bweb'@'%' IDENTIFIED BY 'password';
303 GRANT INSERT,UPDATE,DELETE ON bacula.Location
304 TO 'bweb'@'%' IDENTIFIED BY 'password';
305 GRANT INSERT,UPDATE,DELETE ON bacula.LocationLog
306 TO 'bweb'@'%' IDENTIFIED BY 'password';
307 GRANT UPDATE (LocationId,Comment,RecyclePoolId) ON bacula.Media
308 TO 'bweb'@'%' IDENTIFIED BY 'password';
310 ################ GET MORE STATISTICS ###########################
312 You keep Jobs informations across retention into a job_old table.
313 You have to setup stat_job_table = job_old in bweb configuration.
315 CREATE TABLE job_old (LIKE Job);
317 And run this on crontab when you want :
319 (SELECT * FROM Job WHERE JobId NOT IN (SELECT JobId FROM job_old) );
321 ################ USE GROUPS WITH BWEB ##########################
323 It works with postgresql and mysql5 (4 not tested).
324 To enable group, load bweb/script/bweb_group.sql into your catalog
326 ################################################################