git.sur5r.net Git - bacula/bacula/blob - gui/baculum/INSTALL

   1 1. Baculum overview
   2 2. Operating system environment
   3   2.1 General requirements
   4 3. Makefile
   5
   6 =========================================
   7
   8 1. Baculum overview
   9
  10
  11 Baculum is Bacula web based interface. It enables Bacula administration
  12 functions such as:
  13
  14 - Running Bacula jobs (backup, restore, verify...).
  15 - Two services: Baculum API and Baculum Web
  16 - Configuring Bacula on local and remote hosts
  17 - Monitoring Bacula service status.
  18 - Bacula console available via a Web window.
  19 - Multi-user interface.
  20 - Support for customized and restricted consoles (Console ACL function).
  21 - Volume management.
  22 - User friendly graphs and metrics.
  23 - Basic storage daemon operations (mount, umount, release, ...).
  24 - Easy to use configuration and restore wizards.
  25 - Multiple Director support.
  26 - Live AJAX based statuses.
  27
  28
  29 2. Operating system environment
  30
  31
  32 2.1 General requirements
  33
  34
  35 Environment for Baculum API installation should have following components:
  36
  37 - Web Server - with mod_rewrite module loaded. Baculum has been
  38 tested with Apache HTTP Server and Lighttpd.
  39
  40 - PHP 5.3 or higher - PHP CLI interpreter is unneeded.
  41 PHP should have installed following modules:
  42     * PDO PHP support - depending on your catalog database: PDO PostgreSQL,
  43 PDO MySQL or PDO SQLite.
  44       Note, in case using MySQL database there is required to use MySQL native driver.
  45       It is php-mysqlnd for PHP, not php-mysql.
  46     * BCMath PHP module.
  47     * JSON PHP module.
  48     * XML PHP module.
  49 - Bconsole - configured Bacula text based console
  50 - Access to Bacula catalog database - computer with Baculum API installation should be
  51 able to connect to Bacula catalog database. There is not need to install Baculum
  52 on server with Bacula Catalog DB because Baculum API can communicate with Bacula database
  53 located on remote server.
  54
  55 Environment for Baculum Web installation should have following components:
  56
  57 - Web Server - with mod_rewrite module loaded. Baculum has been
  58 tested with Apache HTTP Server and Lighttpd.
  59
  60 - PHP 5.3 or higher - PHP CLI interpreter is unneeded.
  61 PHP should have installed following modules:
  62     * cURL PHP module.
  63     * MB String PHP module.
  64     * JSON PHP module.
  65     * XML PHP module.
  66
  67 3. Makefile
  68
  69
  70 Together with Baculum source code is provided Makefile file. The Makefile is dedicated
  71 mainly for separating and generating runtime files (including web servers configuration,
  72 systemd unit and others).
  73
  74 Generating runtime files can be useful to prepare Baculum binary packages by execute
  75 the Makefile in deb metafiles or in rpm SPEC file.
  76
  77 Example usage:
  78
  79 $ cd baculum/
  80
  81 # For RPM distributions:
  82 $ make DESTDIR=/home/abc/baculum_runtime
  83
  84 # For deb distributions:
  85 $ make DESTDIR=/home/abc/baculum_runtime SAMPLETYPE=deb-template HTTPDNAME=apache2 HTTPDSITECONF=sites-available