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

   1 Baculum - Bacula web interface
   2
   3 Table of content:
   4
   5 1. Customized and restricted consoles
   6 2. Baculum users configuration file
   7 3. FAQ
   8
   9 ================================================================================
  10
  11 === 1. Customized and restricted consoles ===
  12
  13 Baculum supports customized and restricted consoles for each logged in user.
  14
  15 Before using customized and restricted consoles please check location for
  16 bconsole configuration files for each user. For do it, there is need to run
  17 on Baculum webGUI configuration wizard and there is need to go to "Console"
  18 wizard step (fourth step).
  19
  20 In "Console" wizard step there is field defined as:
  21
  22 Bconsole custom config file path: __________________
  23
  24 In this field there is required to define location for restricted consoles.
  25 In defined path exists one keyword {user}. It will be replaced into current
  26 logged in username.
  27
  28 For example, if logged is user named "john", keyword {user} will be replaced
  29 into "john".
  30
  31
  32 Example:
  33
  34 "Bconsole custom config file path" is defined as:
  35
  36 /usr/local/bacula/etc/bconsole-{user}.conf
  37
  38 After log in user "john" to Baculum webGUI, for each bconsole request will be
  39 used file:
  40
  41 /usr/local/bacula/etc/bconsole-john.conf
  42
  43 It makes available to define some specific console access (or restricted access)
  44 for each Baculum user.
  45
  46 For user named "willy" in above configured path according bconsole configuration
  47 file will be:
  48
  49 /usr/local/bacula/etc/bconsole-willy.conf
  50
  51 etc...
  52
  53
  54 NOTE!
  55
  56 In configuration wizard step "Console" there is also field:
  57
  58 "Bconsole admin config file path:": ___________________
  59
  60 Config file defined in this field will be used by administrator only. For this
  61 reason the best parctice is define here console configuration file that gives
  62 full access for administrator.
  63
  64 Administrator user and password will be defined in next configuration wizard
  65 step named "Authorization" (fifth step).
  66
  67
  68 Baculum users are defined on web server level as described in instriction
  69 in attached to Baculum INSTALL file.
  70
  71 Example:
  72
  73 For creating users "john" and "willy" as Baculum HTTP Basic authorization users
  74 there is need to create this users for example by:
  75
  76 # htpasswd /some/location/htpasswd/file john
  77
  78 # htpasswd /some/location/htpasswd/file willy
  79
  80 For case using other HTTP Basic authorization backends (for example LDAP) there
  81 is need to define these users in this specific service.
  82
  83
  84 Example of content custom consoles configuration file is below:
  85
  86 Console {
  87     Name = "BaculaRestrictedUser"
  88     Password = "XXXXXXXXX"
  89     CommandACL = show,.client,.jobs,.fileset,.pool,.storage,.jobs,.bvfs_update,
  90 .bvfs_lsdirs,.bvfs_lsfiles,.bvfs_versions,.bvfs_get_jobids,.bvfs_restore,restore
  91     CatalogACL = *all*
  92     ClientACL = user-fd
  93     JobACL = somejob1,userjob
  94     PoolACL = Full-Pool
  95     StorageACL = VTL
  96     FileSetACL = somejob1-fileset,userjobFileSet3
  97     WhereACL = *all*
  98 }
  99
 100 After defining these ACL there is also need to define the console access to
 101 Director service in Bacula Director configuration file as Console{} resource.
 102
 103
 104 NOTE!
 105
 106 Please note that in above example in CommandACL are shown the most
 107 essential commands necessary for proper working of Baculum webGUI and
 108 possibility do to restore action (all .bvfs_* command and "restore"
 109 command)
 110
 111 Below are the same necessary commands broke one per line:
 112
 113 show
 114 .client
 115 .jobs
 116 .fileset
 117 .pool
 118 .storage
 119 .jobs
 120 .bvfs_update
 121 .bvfs_lsdirs
 122 .bvfs_lsfiles
 123 .bvfs_versions
 124 .bvfs_get_jobids
 125 .bvfs_restore
 126 restore
 127
 128
 129 Catalog Database restriction
 130
 131 Because Baculum in few parts of interface uses data from Bacula Catalog Database,
 132 for each user who IS NOT administrator there has beed disabled EVERY write to
 133 Bacula Catalog database by Baculum webGUI. Modification Bacula Catalog Database
 134 tables is possible ONLY for Baculum administrator.
 135
 136 Additionally because of Console ACL functionality does not support restriction
 137 on media/volumes level, access to media/volumes has been disabled for all users
 138 except administrator.
 139
 140
 141 Configuration wizard restriction
 142
 143 For security reason there has been disabled access to Configuration Wizard
 144 function for all users except administrator.
 145
 146
 147 ================================================================================
 148
 149 === 2. Baculum users configuration file for Lighttpd ===
 150
 151 There is possible to manage Baculum administrator login and password directly
 152 in configuration wizard step titled "Step 5 - authorization params to Baculum".
 153
 154 It means that Baculum administrator may change administrator auth params by
 155 configuration wizard.
 156
 157 So far in Step 5 configuration wizard there were need to input admin auth params
 158 the same as in pre-defined file by "htpasswd" program.
 159
 160 For getting possibility to change admin login and password on wizard level
 161 there is need to run Baculum on Lighttpd web server and create admin password
 162 file locatied in:
 163
 164 protected/Data/baculum.users
 165
 166 where syntax is:
 167
 168 someuser:somepassword
 169 myser123:password3213
 170 ...etc.
 171
 172
 173 NOTE!
 174 Login and password are stored as plain text.
 175
 176 Next in Lighttpd web server configuration file is need to define above file
 177 as authfile for access to Baculum, for example:
 178
 179 auth.backend = "plain"
 180 auth.backend.plain.userfile = "/var/www/baculum/protected/Data/baculum.users"
 181 auth.require = ( "/" => (
 182         "method" => "basic",
 183         "realm" => "Baculum Auth",
 184         "require" => "valid-user"
 185 ))
 186
 187
 188 Sample with whole Lighttpd configuration file you can find in directory:
 189
 190 examples/baculum.lighttpd.conf
 191
 192 NOTE!
 193 Due to Apache web server can use plain text password only for Windows,
 194 BEOS and Netware systems, described admin auth modification is not supported
 195 for Apache.
 196
 197 NOTE!
 198 Functionality has been tested with Lighttpd. It has not been tested with other
 199 web servers that supports plain text stored password.
 200
 201
 202 ================================================================================
 203
 204 === 3. FAQ ===
 205
 206 a) Why Jobs list and/or Media list windows do not show any content?
 207
 208    In case when in Bacula Catalog database exist a lot of finished Jobs or Media
 209 records, for example more than 2000, and window with Jobs or Media list do not
 210 show any content, then please consider increase "memory_limit" option in php.ini
 211 PHP configuration file to higher value than 256M. There is also possible to set
 212 limit window list elements on webGUI in window tools option (on window bottom
 213 bar), without changing "memory_limit" value.