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

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