git.sur5r.net Git - bacula/bacula/blob - gui/brestore/README

   1 ################################################################
   2 #             brestore -- a bacula perl interface              #
   3 ################################################################
   4
   5 As we felt a need for a restoration GUI for bacula, we developed a simple
   6 Perl/GTK GUI.
   7 It has the following features :
   8
   9     * Direct SQL access to the database for good performance
  10
  11     * Fast Time Navigation (switch almost instantaneously between the different
  12       versions of a directory, by changing the date from a list)
  13
  14     * Possibility to choose a selected file, then browse all its available
  15       versions, and see directly if these versions are online in a library or
  16       not
  17
  18     * Simple restoration by the generation of a BSR file
  19
  20     * Works with either PostgreSQL or MySQL
  21
  22 We have a working (if a bit unpolished) version ready, and think it is time for
  23 us to publish it and have user and Kern feedback.
  24
  25 What's missing :
  26
  27     * We want to add some other features such as : the user has selected a FD
  28       and a date, we want to display the list of media requested and their
  29       availability.
  30
  31     * Plenty of features. As we don't have lots of imagination. Don't hesitate
  32       to suggest us your ideas ...
  33
  34     * We want use Bacula to generate bsr files, at this time, you can't restore
  35       files across different Storage (Full on tape, Incr on Disk for example)
  36
  37 For the moment, we want to concentrate on having a restoration interface. We
  38 don't care about seeing the restoration progress, or anything else.
  39
  40 brestore is also available within Bweb.
  41
  42 ################ INSTALL #######################################
  43
  44 # you can install the user interfact glade file on
  45 #   /usr/share/brestore or /usr/local/share/brestore
  46 mkdir -p /usr/share/brestore
  47 install -m 644 -o root -g root brestore.glade /usr/share/brestore
  48 install -m 755 -o root -g root brestore.pl    /usr/bin
  49
  50 # If you don't use bweb and bconsole.pl
  51 #   you must get Bconsole.pm from bweb modules (bweb/lib/Bconsole.pm)
  52 #   and install it.  If bweb is installed, Bconsole.pm is already
  53 #   installed.
  54
  55 install -m 644 -o root -g root Bconsole.pm /usr/share/perl5
  56
  57 # copy bsr file directly to your director, use must use scp (or nfs stuff)
  58 # if you doesn't want to use this, you can dump the bsr file with "Gen BSR" button.
  59 # so you must have an ssh-key exchange. (you can also hack brestore.pl to use
  60 # something like '$err = `xterm -e scp $src $1 2>&1`'
  61
  62 your_login@yourws:~$ ssh-copy-id -i .ssh/your_pub_key login@bacula-dir
  63
  64 # you have to configure brestore preferences.
  65
  66 ################ WINDOWS INSTALL ###############################
  67
  68 Brestore works on win32 with ActivePerl. To get all libraries, you
  69 can install GCSTAR. You have also to copy libglade-2.0.dll
  70
  71 ################ INSTALL MODULES ###############################
  72
  73 Perl Modules
  74 The Debian Way
  75
  76 apt-get install libgtk2-gladexml-perl
  77 apt-get install libdbd-mysql-perl
  78 apt-get install libdbd-pg-perl
  79 apt-get install libexpect-perl
  80 apt-get install libwww-perl
  81
  82 The Red Hat way
  83 Please contribute, neither of us have a Red Hat to test on :)
  84 Other distros/Unices
  85 Please contribute ...
  86 The generic Way, if those modules aren't packaged by your distro
  87
  88 perl -MCPAN -e shell
  89 install Gtk2
  90 install Expect
  91 install Gtk2::GladeXML
  92 install LWP
  93
  94 install DBD::mysql
  95 or
  96 install DBD::Pg
  97
  98 ################ BCONSOLE WITHOUT CONIO ########################
  99
 100 If you don't use Bweb, you must use bconsole without conio support. For that, use
 101 bconsole -n option.
 102
 103 WARNING : You must be able to execute bconsole and able to read bconsole.conf !
 104
 105 ################ CONFIGURATION #################################
 106
 107 You can modify the configuration from brestore itself (if brestore can't find
 108 his glade file).
 109
 110 Example :
 111
 112 $parameters = {
 113       'mozilla' => 'mozilla',
 114       'bconsole' => '/usr/local/bin/bconsole.noconio -c /etc/bacula/bconsole.conf',
 115       'bweb' => 'http://localhost/cgi-bin/bweb/bweb.pl',
 116       'connection_string' => 'DBI:mysql:database=bacula;host=127.0.0.1;port=3306',
 117       'username' => 'bacula',
 118       'password' => 'xxxx',
 119       'bsr_dest' => 'file://var/tmp',
 120       'debug' => 0,
 121       'use_ok_bkp_only' => 1,
 122       'default_restore_job' => 'restore'
 123     };