Update documentation

README.Redhat

@@ -2,41 +2,54 @@
 
 - Standard components: director, storage, client, docs, bconsole.
 - Graphical components: bat, bacula-tray-monitor (where supported).
+- Tab completion for bconsole.
 - Nagios plugin.
 - HTML/PDF docs.
+- Quick start guides.
 - File Daemon bpipe-fd plugin.
 - POSIX.1e capabilities for File Daemon.
-- Systemd for Fedora 15+.
+- Systemd for Fedora and RHEL 7+.
-- GZIP/LZO compression (where supported).
+- SysV init scripts for RHEL 5/6.
+- GZIP/LZO compression.
 - Static uid/gid of 133 (see "setup" package).
 - No usermode / fedora-usermgmt stuff in the console packages.
 - Docs no longer an arch specific subpackage.
 - SQL libraries needed only by Director and Storage daemons.
-- Tab completion for bconsole.
+- SQL backend management through the alternatives system.
 
-======== PostgreSQL, MySQL and SQLite databases
+======== Quick start
 
-Bacula director supports different databases backends, if you want to switch
+Please look at the following files for a quick start with the various database
-away from the default PostgreSQL one you need to change the "libbaccats" (the
+backends:
-catalogue library) symlink to the real library.
 
-To change to a different backend, issue the following command:
+- quickstart_mysql.txt
+- quickstart_postgresql.txt
+- quickstart_sqlite3.txt
 
-# alternatives --config libbaccats.so
+To deal with the switching process for the database backend, see the following
+file which explains how to make the necessary changes:
 
-There are 3 programs which provide 'libbaccats.so'.
+- database_backends.txt
 
-  Selection    Command
+======== Upgrading from old Redhat releases
------------------------------------------------
-   1           /usr/lib64/libbaccats-mysql.so
-   2           /usr/lib64/libbaccats-sqlite3.so
-*+ 3           /usr/lib64/libbaccats-postgresql.so
 
-Enter to keep the current selection[+], or type selection number: 1
+When upgrading from old Redhat releases, the "bacula-libs-sql" package takes
+care of making the appropriate selection for the database backend based on what
+was previously configured on the old system.
 
-There is NO need to edit any part in the Bacula Director configuration; for the
+The default permissions in the "/etc/bacula" folder have changed; please perform
-purposes of the database creation steps, the bacula-dir.conf configuration file
+the following commands for restoring the permissions for the correct operation
-can be left at their default values.
+of the daemons.
 
-Please look at the quickstart_<backend>.txt files for a quick start with the
+# chown -R root:root /etc/bacula
-various backends.
+# chmod 755 /etc/bacula
+# chmod 640 /etc/bacula/*
+# chgrp bacula /etc/bacula/bacula-dir.conf /etc/bacula/query.sql
+
+All the files that are part of the Director configuration (included with @) must
+of course have the same permissions as the main configuration file.
+
+======== Documentation
+
+To see all the available documentation in both HTML and PDF formats, please
+install the "bacula-docs" package.

bacula.spec

@@ -3,7 +3,7 @@
 
 Name:                   bacula
 Version:                5.2.13
-Release:                4%{?dist}
+Release:                5%{?dist}
 Summary:                Cross platform network backup for Linux, Unix, Mac and Windows
 # See LICENSE for details
 License:                AGPLv3 with exceptions
@@ -906,6 +906,9 @@ fi
 
 
 %changelog
+* Tue Feb 26 2013 Simone Caronni <negativo17@gmail.com> - 5.2.13-5
+- Improve documentation.
+
 * Mon Feb 25 2013 Simone Caronni <negativo17@gmail.com> - 5.2.13-4
 - Fix director reload command.
 - Adjust to 5.2.13 permission changes.

quickstart_mysql.txt

@@ -23,15 +23,15 @@ and all daemons and consoles in one server.
 # ./make_bacula_tables mysql
 # ./grant_bacula_privileges mysql
 
-4) Change passwords in /etc/bacula/*conf with something you like.
+4) Change passwords in /etc/bacula/*.conf with something you like.
 
-# sed -i -e 's/@@DIR_PASSWORD@@/dir-Fedora/g' \
+# sed -i -e 's/@@DIR_PASSWORD@@/dir-password/g' \
-        -e 's/@@FD_PASSWORD@@/fd-Fedora/g' \
+        -e 's/@@FD_PASSWORD@@/fd-password/g' \
-        -e 's/@@SD_PASSWORD@@/sd-Fedora/g' \
+        -e 's/@@SD_PASSWORD@@/sd-password/g' \
-        -e 's/@@MON_DIR_PASSWORD@@/mon-dir-Fedora/g' \
+        -e 's/@@MON_DIR_PASSWORD@@/mon-dir-password/g' \
-        -e 's/@@MON_FD_PASSWORD@@/mon-fd-Fedora/g' \
+        -e 's/@@MON_FD_PASSWORD@@/mon-fd-password/g' \
-        -e 's/@@MON_SD_PASSWORD@@/mon-sd-Fedora/g' \
+        -e 's/@@MON_SD_PASSWORD@@/mon-sd-password/g' \
-        /etc/bacula/*conf
+        /etc/bacula/*.conf
 
 5) Enable daemons and check they are working
 
@@ -48,17 +48,13 @@ and all daemons and consoles in one server.
 # systemctl start bacula-fd.service
 # echo status bacula-fd | bconsole
 
-6) Install the docs and read them
+6) If you don't backup to disk and have a tape library or autochanger, please
-
-# yum -y install bacula-docs
-
-7) If you don't backup to disk and have a tape library or autochanger, please
 also install the magnetic tapes commands:
 
 # yum -y install mt-st mtx
 
-8) To grant console access to regular users add the read permission
+7) To grant console access to regular users add the read permission to the
-to the console configuration files. Remember that there is no authentication
+console configuration files. Remember that there is no authentication check; so
-check; so a user that can launch the console can perform any command.
+a user that can launch the console can perform any command.
 
 # chmod +r /etc/bacula/bconsole.conf /etc/bacula/bat.conf

quickstart_postgresql.txt

@@ -25,15 +25,15 @@ $ ./create_bacula_database
 $ ./make_bacula_tables
 $ ./grant_bacula_privileges
 
-4) Change passwords in /etc/bacula/*conf with something you like.
+4) Change passwords in /etc/bacula/*.conf with something you like.
 
-# sed -i -e 's/@@DIR_PASSWORD@@/dir-Fedora/g' \
+# sed -i -e 's/@@DIR_PASSWORD@@/dir-password/g' \
-        -e 's/@@FD_PASSWORD@@/fd-Fedora/g' \
+        -e 's/@@FD_PASSWORD@@/fd-password/g' \
-        -e 's/@@SD_PASSWORD@@/sd-Fedora/g' \
+        -e 's/@@SD_PASSWORD@@/sd-password/g' \
-        -e 's/@@MON_DIR_PASSWORD@@/mon-dir-Fedora/g' \
+        -e 's/@@MON_DIR_PASSWORD@@/mon-dir-password/g' \
-        -e 's/@@MON_FD_PASSWORD@@/mon-fd-Fedora/g' \
+        -e 's/@@MON_FD_PASSWORD@@/mon-fd-password/g' \
-        -e 's/@@MON_SD_PASSWORD@@/mon-sd-Fedora/g' \
+        -e 's/@@MON_SD_PASSWORD@@/mon-sd-password/g' \
-        /etc/bacula/*conf
+        /etc/bacula/*.conf
 
 5) Enable daemons and check they are working
 
@@ -50,17 +50,13 @@ $ ./grant_bacula_privileges
 # systemctl start bacula-fd.service
 # echo status bacula-fd | bconsole
 
-6) Install the docs and read them
+6) If you don't backup to disk and have a tape library or autochanger, please
-
-# yum -y install bacula-docs
-
-7) If you don't backup to disk and have a tape library or autochanger, please
 also install the magnetic tapes commands:
 
 # yum -y install mt-st mtx
 
-8) To grant console access to regular users add the read permission
+7) To grant console access to regular users add the read permission to the
-to the console configuration files. Remember that there is no authentication
+console configuration files. Remember that there is no authentication check; so
-check; so a user that can launch the console can perform any command.
+a user that can launch the console can perform any command.
 
 # chmod +r /etc/bacula/bconsole.conf /etc/bacula/bat.conf

quickstart_sqlite3.txt

@@ -20,15 +20,15 @@ and all daemons and consoles in one server.
 # ./make_bacula_tables sqlite3
 # ./grant_bacula_privileges sqlite3
 
-4) Change passwords in /etc/bacula/*conf with something you like.
+4) Change passwords in /etc/bacula/*.conf with something you like.
 
-# sed -i -e 's/@@DIR_PASSWORD@@/dir-Fedora/g' \
+# sed -i -e 's/@@DIR_PASSWORD@@/dir-password/g' \
-        -e 's/@@FD_PASSWORD@@/fd-Fedora/g' \
+        -e 's/@@FD_PASSWORD@@/fd-password/g' \
-        -e 's/@@SD_PASSWORD@@/sd-Fedora/g' \
+        -e 's/@@SD_PASSWORD@@/sd-password/g' \
-        -e 's/@@MON_DIR_PASSWORD@@/mon-dir-Fedora/g' \
+        -e 's/@@MON_DIR_PASSWORD@@/mon-dir-password/g' \
-        -e 's/@@MON_FD_PASSWORD@@/mon-fd-Fedora/g' \
+        -e 's/@@MON_FD_PASSWORD@@/mon-fd-password/g' \
-        -e 's/@@MON_SD_PASSWORD@@/mon-sd-Fedora/g' \
+        -e 's/@@MON_SD_PASSWORD@@/mon-sd-password/g' \
-        /etc/bacula/*conf
+        /etc/bacula/*.conf
 
 5) Enable daemons and check they are working
 
@@ -45,17 +45,13 @@ and all daemons and consoles in one server.
 # systemctl start bacula-fd.service
 # echo status bacula-fd | bconsole
 
-6) Install the docs and read them
+6) If you don't backup to disk and have a tape library or autochanger, please
-
-# yum -y install bacula-docs
-
-7) If you don't backup to disk and have a tape library or autochanger, please
 also install the magnetic tapes commands:
 
 # yum -y install mt-st mtx
 
-8) To grant console access to regular users add the read permission
+7) To grant console access to regular users add the read permission to the
-to the console configuration files. Remember that there is no authentication
+console configuration files. Remember that there is no authentication check; so
-check; so a user that can launch the console can perform any command.
+a user that can launch the console can perform any command.
 
 # chmod +r /etc/bacula/bconsole.conf /etc/bacula/bat.conf