Skip to content

Latest commit

 

History

History
291 lines (187 loc) · 7.97 KB

configure.rst

File metadata and controls

291 lines (187 loc) · 7.97 KB

Configure Bacula-Web

This section explain how to create the configuration file which contain your custom settings.

Note

Please note that since version 5.1.0, the config file is a PHP script (it was a .conf file before this version).

Create configuration file

Bacula-Web settings are stored in the file below

application/config/config.php

From Bacula-Web root folder, copy the sample config file and give it the name config.php

# cd application/config
# cp -v config.php.sample config.php

Now you need to make sure config.php has the correct permissions.

The configuration file needs to be at least readable by the user owning the web server process.

On Red Hat / Centos / Fedora, the user running Apache is apache

On Debian / Ubuntu, the user running Apache is www-data

So depending on which system you have installed Bacula-Web, run the command below

# chown -v <apache_user>: config.php

For example, on Debian Jessie, use this command

# chown -v www-data: config.php 

on Centos 7

# chown -v apache: config.php

Note

Do not forget the column <:> after apache_user

Settings

General settings

Setting Description Default value
$config['language'] Set displayed language en_US
$config['show_inactive_clients'] Show inactive clients or not true
$config['datetime_format'] Change default date and time format Y-m-d H:i:s
$config['hide_empty_pools'] Hide empty pools true

language

Description

As Bacula-Web is translated into not less than 15 languages, the language setting allow you to change the displayed language of Bacula-Web.

You can simply change from english to your language by modifying the $config['language'] value.

Example

$config['language'] = 'pt_BR'; // For portuguese brazilian 

hide_empty_pools

Description

Do not display empty pools in Dashboard (Pools and volumes widget)

Example

$config['hide_empty_pools'] = false;

Note

this setting is availabe since Bacula-Web 5.2.11

show_inactive_clients

Description

If disabled (set to false), don't list or show inactive clients

EXample

$config['show_inactive_clients'] = true;

Note

this setting is availabe since Bacula-Web 5.2.11

datetime_format

Description

Define your customer date & time format (by default Y-m-d H:i:s)

For more information on date format, have a look on date() function in PHP manual

Example

$config['datetime_format'] = 'd/m/Y H:i:s';
or
$config['datetime_format'] = 'm-d-Y H:i:s';

Note

this setting is availabe only since version 7.4.0

enable_users_auth

Description

Enable or disable users authentication.

This settings is useful if you already authenticate users on Web server side, using .htpasswd or LDAP authentication (mod_auth_ldap or any other).

Example

// By default, users authentication is enabled
$config['enable_users_auth'] = true;

// Disable it using config below
$config['enable_users_auth'] = false;

Important

Use this settings with caution, don't disable users authentication unless you already authenticated users.

debug

Description

Enable or disable debug mode

Debug mode could be helpful to troubleshoot Bacula-Web setup problem. Debug mode is disabled by default

Example

// Enable debug mode
$config['debug'] = true;

Important

Use debug mode with caution, sensitive informations can be disclosed if your Bacula-Web setup is exposed to unsecure network.

Database connection settings

Each Bacula catalog (database) needs to be defined using the settings below

Setting Description Example
label label displayed in the catalog drop-down selector Backup server
host hostname of the db server hosting Bacula catalog localhost, fqdn host or ip address
db_name name of the catalog database name usualy bacula, unless you changed it
login database user bacula, admin, etc.
password database password mK3DQLolUV
db_type database type mysql, pgsql or sqlite

db_port

database port number

  • mysql, use 3306
  • pgsql, use 5432
  • sqlite, leave blank

Examples

Single MySQL Bacula catalog

// Bacula catalog label (used for catalog selector)
$config[0]['label'] = 'Backup Server';

// Server
$config[0]['host'] = 'localhost';

// Database name
$config[0]['db_name'] = 'bacula';

// Database user
$config[0]['login'] = 'bacula';

// Database user's password
$config[0]['password'] = 'verystrongpassword';

// Database type (mysql | pgsql | sqlite)
$config[0]['db_type'] = 'mysql';

// Database port
$config[0]['db_port'] = '3306';

Multiple catalogs (example)

<?php
//MySQL bacula catalog
$config[0]['label'] = 'Backup Server';
$config[0]['host'] = 'localhost';
$config[0]['login'] = 'bacula';
$config[0]['password'] = 'verystrongpassword';
$config[0]['db_name'] = 'bacula';
$config[0]['db_type'] = 'mysql';
$config[0]['db_port'] = '3306';

//PostgreSQL Lab serveur
$config[1]['label'] = 'Lab backup server';
$config[1]['host'] = '192.168.0.120';
$config[1]['login'] = 'bacula';
$config[1]['password'] = 'verystrongpassword';
$config[1]['db_name'] = 'bacula';
$config[1]['db_type'] = 'pgsql';
$config[1]['db_port'] = '5432';
?>

Full configuration example

Full config.php example

<?php
// Language
$config[0]['language'] = 'en_EN';

// Show inactive clients
$config['show_inactive_clients'] = false;

// Hide empty pools
$config['hide_empty_pools'] = true;

//MySQL bacula catalog
$config[0]['label'] = 'Backup Server';
$config[0]['host'] = 'localhost';
$config[0]['login'] = 'baculaweb';
$config[0]['password'] = 'password';
$config[0]['db_name'] = 'bacula';
$config[0]['db_type'] = 'mysql';
$config[0]['db_port'] = '3306';

// PostgreSQL bacula catalog
$config[1]['label'] = 'Prod Server';
$config[1]['host'] = 'db-server.domain.com';
$config[1]['login'] = 'bacula';
$config[1]['password'] = 'otherstrongpassword';
$config[1]['db_name'] = 'bacula';
$config[1]['db_type'] = 'pgsql';
$config[1]['db_port'] = '5432';

// SQLite bacula catalog
$config[2]['db_type'] = 'sqlite';
$config[2]['label'] = 'bacula';
$config[2]['db_name'] = '/path/to/database';
?>

Warning

If you define several Bacula catalog, make sure each catalog connection settings have a different id example: $config[0], $config[1], etc.