Skip to content

Latest commit

 

History

History
279 lines (215 loc) · 7.33 KB

INSTALL.md

File metadata and controls

279 lines (215 loc) · 7.33 KB
Raw

INSTALLATION

SYSTEM REQUIREMENTS

PACKAGE BASED INSTALLATION

Packages are available for a number of Linux distributions, please see:

Note: The experimental nightly webui build only works with and from Bareos 15.2 (experimental/nightly) onwards, as it makes use of the new JSON API.

Step 1 - Adding the Repository

Add the Bareos contrib repository that is matching your Linux distribution and install the bareos-webui package via your package manager.

  • RHEL, CentOS and Fedora
#
# define parameter
#

DIST=CentOS_7
# or
# DIST=RHEL_6
# DIST=RHEL_7
# DIST=Fedora_20
# DIST=Fedora_21
# DIST=CentOS_6

# add the Bareos contrib repository
URL=http://download.bareos.org/bareos/contrib/$DIST
wget -O /etc/yum.repos.d/bareos:contrib.repo $URL/bareos:contrib.repo

# install bareos-webui package
yum install bareos-webui
  • SUSE Linux Enterprise Server (SLES), openSUSE
#
# define parameter
#

DIST=SLE_12
# or
# DIST=SLE_11_SP3
# DIST=openSUSE_13.1
# DIST=openSUSE_13.2

# add the Bareos contrib repository
URL=http://download.bareos.org/bareos/contrib/$DIST
zypper addrepo --refresh $URL/bareos:contrib.repo

# install bareos-webui package
zypper install bareos-webui
  • Debian, Ubuntu
#
# define parameter
#

DIST=Debian_7.0
# or
# DIST=Debian_6.0
# DIST=xUbuntu_12.04
# DIST=xUbuntu_14.04

# add the Bareos contrib repository
URL=http://download.bareos.org/bareos/contrib/$DIST
printf "deb $URL /\n" >> /etc/apt/sources.list.d/bareos_contrib.list

# add package key
wget -q $URL/Release.key -O- | apt-key add -

# install bareos-webui package
apt-get update
apt-get install bareos-webui

Step 2 - Configuration of restricted consoles and profile resources

You can have multiple Consoles with different names and passwords, sort of like multiple users, each with different privileges. As a default, these consoles can do absolutely nothing – no commands whatsoever. You give them privileges or rather access to commands and resources by specifying access control lists in the Director’s Console resource. The ACLs are specified by a directive followed by a list of access names.

It is required to add at least one restricted named console in your director configuration (bareos-dir.conf) for the webui. The restricted named consoles, configured in your bareos-dir.conf, are used for authentication and access control. The name and password directives of the restricted consoles are the credentials you have to provide during authentication to the webui as username and password. For full access and functionality relating the director connection the following commands are currently needed by the webui and have to be made available via the CommandACL in your profile the restricted consoles uses.

  • status
  • messages
  • show
  • version
  • run
  • rerun
  • cancel
  • use
  • restore
  • list, llist
  • .api
  • .bvfs_update
  • .bvfs_lsdirs
  • .bvfs_lsfiles
  • .bvfs_versions
  • .bvfs_restore
  • .jobs
  • .clients
  • .filesets

The package install provides a default console and profile configuration under /etc/bareos/bareos-dir.d/, which have to be included at the bottum of your /etc/bareos/bareos-dir.conf and edited to your needs.

echo "@/etc/bareos/bareos-dir.d/webui-consoles.conf" >> /etc/bareos/bareos-dir.conf
echo "@/etc/bareos/bareos-dir.d/webui-profiles.conf" >> /etc/bareos/bareos-dir.conf

#
# Preparations:
#
# include this configuration file in bareos-dir.conf by
# @/etc/bareos/bareos-dir.d/webui-consoles.conf
#

#
# Restricted console used by bareos-webui
#
Console {
  Name = user1
  Password = "CHANGEME"
  Profile = webui
}

For more details about console resource configuration in bareos, please have a look at the online Bareos documentation.

#
# Preparations:
#
# include this configuration file in bareos-dir.conf by
# @/etc/bareos/bareos-dir.d/webui-profiles.conf
#

#
# bareos-webui default profile resource
#
Profile {
  Name = webui
  CommandACL = status, messages, show, version, run, rerun, cancel, .api, .bvfs_*, list, llist, use, restore, .jobs, .filesets, .clients
  Job ACL = *all*
  Schedule ACL = *all*
  Catalog ACL = *all*
  Pool ACL = *all*
  Storage ACL = *all*
  Client ACL = *all*
  FileSet ACL = *all*
  Where ACL = *all*
}

For more details about profile resource configuration in bareos, please have a look at the online Bareos documentation.

Note: Do not forget to reload your new director configuration.

Step 3 - Configure your Apache Webserver

If you have installed from package, a default configuration is provided, please see /etc/apache2/conf.d/bareos-webui.conf, /etc/httpd/conf.d/bareos-webui.conf or /etc/apache2/available-conf/bareos-webui.conf.

Required apache modules, setenv, rewrite and php are enabled via package postinstall script. You simply need to restart your apache webserver manually.

Step 4 - Configure your /etc/bareos-webui/directors.ini

Configure your directors in /etc/bareos-webui/directors.ini to match your settings, which you have choosen in the previous steps.

The configuration file /etc/bareos-webui/directors.ini should look similar to this:

;
; Bareos WebUI Configuration
; File: /etc/bareos-webui/directors.ini
;

;
; Section localhost-dir
;
[localhost-dir]

; Enable or disable section. Possible values are "yes" or "no", the default is "yes".
enabled = "yes"

; Fill in the IP-Address or FQDN of you director.
diraddress = "localhost"

; Default value is 9101
dirport = 9101

; Note: TLS has not been tested and documented, yet.
;tls_verify_peer = false
;server_can_do_tls = false
;server_requires_tls = false
;client_can_do_tls = false
;client_requires_tls = false
;ca_file = ""
;cert_file = ""
;cert_file_passphrase = ""
;allowed_cns = ""

;
; Section remote-dir
;
[remote-dir]
enabled = "no"
diraddress = "hostname"
dirport = 9101
; Note: TLS has not been tested and documented, yet.
;tls_verify_peer = false
;server_can_do_tls = false
;server_requires_tls = false
;client_can_do_tls = false
;client_requires_tls = false
;ca_file = ""
;cert_file = ""
;cert_file_passphrase = ""
;allowed_cns = ""

Note: You can add as many directors as you want.

Step 6 - SELinux

If you do not use SELinux on your system, you can skip this step and go over to the next one.

To install bareos-webui on a system with SELinux enabled, the following additional steps must be performed.

  • Allow HTTPD scripts and modules to connect to the network
setsebool -P httpd_can_network_connect on