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

   1 1. Baculum overview
   2 2. Baculum operating system environment
   3   2.1 General requirements
   4   2.2 Linux Fedora
   5   2.3 Linux Debian
   6 3. Preparing Baculum files
   7 4. Preparing Apache Web Server
   8 5. Example configuration VirtualHost
   9
  10 =========================================
  11
  12 1. Baculum overview
  13
  14 Baculum is Bacula web based interface. It enables Bacula administration
  15 functions such as:
  16
  17 - Running backup and restore tasks
  18 - Monitoring Bacula services by getting status these services
  19 - Bacula console available via web interface
  20 - Support for customized and restricted consoles (Console ACL functionality)
  21 - Multiple Directors support
  22 - Volumes managenment including labeling new volumes
  23 - Basic storage daemon operations on volumes (mount, umount, release actions)
  24 - Easy in use configuration and restore wizards
  25 - other features...
  26
  27 Note!
  28 This Baculum release does not support Verify kind of jobs. Support for Verify
  29 jobs will be implemented in next Baculum release.
  30
  31
  32 2. Baculum operating system environment
  33
  34
  35 2.1 General requirements
  36
  37
  38 Environmnent for Baculum installation should have next components:
  39
  40 - Web Server - with mod_rewrite module loaded. Baculum has been
  41 tested on Apache HTTP Server.
  42
  43 - PHP 5.3 or higher - as web server module. PHP CLI interpreter is not needed.
  44 PHP should have installed next modules:
  45     * PDO PHP support - depending on your catalog database: PDO PostgreSQL,
  46 PDO MySQL or PDO SQLite.
  47     * BCMath PHP module.
  48     * cURL PHP module.
  49     * MB String PHP module.
  50     * JSON PHP module.
  51 - Bconsole - configured Bacula text based console
  52 - Access to Bacula catalog database - computer with Baculum installation should be
  53 able to connection to Bacula catalog database. There is not need to install Baculum
  54 on server with Bacula DB because Baculum can communicate with Bacula database
  55 located on remote server.
  56
  57 Above requirements are validated during Baculum start. So if in installation
  58 environment there lacks some from these components then you will be informed
  59 about it.
  60
  61
  62 2.2 Linux Fedora
  63
  64
  65 Packages required for run Baculum in Fedora environemnt can be installed by command:
  66
  67 # yum install httpd \
  68 php \
  69 php-common \
  70 php-pdo \
  71 php-pgsql \
  72 php-mysqlnd \
  73 php-mbstring \
  74 php-bcmath
  75
  76 In Fedora 20 PHP module for cURL support and for JSON support are compiled in PHP.
  77
  78 In case of using SELinux functionality in Baculum environment, recommended way
  79 is switching "httpd_t" SELinux security doman to permissive domain like below:
  80
  81 # semanage permissive -a httpd_t
  82
  83 Please be sure that in PHP configuration file (usually located in /etc/php.ini)
  84 there is option error_reporting set as below:
  85
  86 error_reporting = E_ALL & ~E_STRICT
  87
  88 Suggested method for Baculum webGUI access to Bacula Console (bconsole) is using
  89 "sudo" functionality for that. In this case there is need to add to /etc/sudoers file two
  90 lines according next template:
  91
  92 Defaults:apache_user    !requiretty
  93 apache_user ALL= NOPASSWD:      bconsole_path
  94
  95 For example for user called "apache" from that HTTP service working with Baculum
  96 there is need to add line like below:
  97
  98 Defaults:apache !requiretty
  99 apache  ALL= NOPASSWD:  /usr/sbin/bconsole
 100
 101
 102 2.3 Linux Debian
 103
 104
 105 Packages required for run Baculum in Debian environemnt can be installed by command:
 106
 107 apt-get install apache2 \
 108 libapache2-mod-php5 \
 109 php5 \
 110 php5-pgsql \
 111 php5-mysql \
 112 php5-curl \
 113 php5-json
 114
 115 In Debian 7.4.0, PHP modules for BCMath and MultiByte String support are compiled in PHP.
 116
 117 There is need to create symbolic link as below, for enable mod_rewrite module in Apache.
 118
 119 # ln -s /etc/apache2/mods-available/rewrite.load /etc/apache2/mods-enabled/rewrite.load
 120
 121 Please be sure that in PHP configuration file (usually located in /etc/php5/apache2/php.ini)
 122 there is option error_reporting set as below:
 123
 124 error_reporting = E_ALL & ~E_STRICT
 125
 126 Suggested method for Baculum webGUI access to Bacula Console (bconsole) is using
 127 "sudo" functionality for that. In this case there is need to add to /etc/sudoers below
 128 line according next template:
 129
 130 apache_user ALL= NOPASSWD:      bconsole_path
 131
 132 For example for user called "www-data" from that HTTP service working with Baculum
 133 there is need to add line like below:
 134
 135 www-data        ALL= NOPASSWD:  /usr/sbin/bconsole
 136
 137
 138 3. Preparing Baculum files
 139
 140
 141 After downloading and unpacking Baculum sources archive there is need to set write
 142 permissions for web server for three below directories:
 143
 144 /[files base location]/assets
 145 /[files base location]/protected/Data
 146 /[files base location]/protected/runtime
 147
 148 These directories permissions are validated during Baculum start. If web server
 149 will not be able to write data in some from above directries then you will be
 150 informed about this fact.
 151
 152
 153 4. Preparing Apache Web Server
 154
 155
 156 First there is need to configure authentication to Baculum from web server side.
 157 Baculum supports HTTP Basic authentication from web server.
 158
 159 In Apache web server this authentication method may be realizing by next directives
 160 declaration in Apache configuration file:
 161
 162 AuthType Basic
 163 AuthUserFile /etc/apache2/passwords
 164 Require valid-user
 165
 166 File located in /etc/apache2/passwords is an example file which contains users and
 167 passwords. For generating passwords file you may use htpasswd binary file in next
 168 way:
 169
 170 # htpasswd -c /etc/apache2/passwords someuser
 171
 172 You will be asked about inputing password and retype password for user.
 173
 174 NOTE!
 175 "-c" switcher you should use only for new created passwords file. For existing
 176 passwords file "-c" switcher should not be inputed.
 177
 178
 179 5. Example configuration VirtualHost
 180
 181
 182 <VirtualHost *:80>
 183         DocumentRoot /var/www/baculum
 184         ServerName somehost.example.com
 185         <Directory /var/www/baculum>
 186                 AllowOverride All
 187                 AuthType Basic
 188                 AuthName MyPrivateFile
 189                 AuthUserFile /etc/apache2/passwords
 190                 Require valid-user
 191         </Directory>
 192 </VirtualHost>
 193
 194
 195 Above configuration should be writen in a new Apache configuration file.
 196 for example, location for that can be put to /etc/apache2/sites-enabled/baculum.conf.
 197
 198 In this way, configuration file baculum.conf will be loaded automaticly during
 199 Apache server start.