adapted for bareos-16.2

manuals/en/main/bareos.sty

@@ -166,6 +166,9 @@
 \elink{Bareos Whitepaper Tape Speed Tuning}{http://www.bareos.org/en/Whitepapers/articles/Speed_Tuning_of_Tape_Drives.html}\xspace%
 }
 
+\newcommand{\bareosMigrateConfigSh}{%
+\elink{bareos-migrate-config.sh}{https://github.com/bareos/bareos-contrib/blob/master/misc/bareos-migrate-config/bareos-migrate-config.sh}\xspace%
+}
 
 
 %
@@ -197,8 +200,10 @@
 \newcommand{\directory}[1]{\path|#1|}
 \newcommand{\email}[1]{\url{#1}}
 \newcommand{\file}[1]{\path|#1|}
+\newcommand{\fileset}[1]{\resourcename{Dir}{FileSet}{#1}}
 \newcommand{\group}[1]{\path|#1|}
 \newcommand{\host}[1]{\path|#1|}
+\newcommand{\job}[1]{\resourcename{Dir}{Job}{#1}}
 \newcommand{\name}[1]{\textbf{#1}}
 \newcommand{\user}[1]{\path|#1|}
 \newcommand{\package}[1]{%
@@ -226,6 +231,9 @@
     \path|#1 #2|\index[general]{Platform!#1!#2}%
 }}
 
+\newcommand{\mysql}{MySQL/MariaDB\xspace}
+\newcommand{\postgresql}{PostgreSQL\xspace}
+\newcommand{\sqlite}{Sqlite\xspace}
 \newcommand{\vmware}{VMware\registered}
 \newcommand{\vSphere}{VMware vSphere\registered}
 

manuals/en/main/bconsole.tex

@@ -345,20 +345,20 @@ \section{Console Commands}
    The full form of this command is:
 
 \begin{bconsole}{add}
-add [pool=<pool-name> storage=<storage> jobid=<JobId>
+add [pool=<pool-name>] [storage=<storage>] [jobid=<JobId>]
 \end{bconsole}
 
 
-   Normally, the {\bf label} command is used rather than this command
-   because the {\bf label} command labels the physical media (tape, disk,
-   DVD, ...) and does the equivalent of the {\bf add} command.  The {\bf
-   add} command affects only the Catalog and not the physical media (data
+   Normally, the \bcommand{label}{} command is used rather than this command
+   because the \bcommand{label}{} command labels the physical media (tape, disk,
+   DVD, ...) and does the equivalent of the {\bf add} command.
+   The \bcommand{add}{} command affects only the Catalog and not the physical media (data
    on Volumes).  The physical media must exist and be labeled before use
-   (usually with the {\bf label} command).  This command can, however, be
+   (usually with the \bcommand{label}{} command).  This command can, however, be
    useful if you wish to add a number of Volumes to the Pool that will be
    physically labeled at a later time.  It can also be useful if you are
-   importing a tape from another site.  Please see the {\bf label} command
-   below for the list of legal characters in a Volume name.
+   importing a tape from another site.  Please see the \bcommand{label}{} command
+   for the list of legal characters in a Volume name.
 
 \item [autodisplay]
    \index[general]{Console!Command!autodisplay on/off}

manuals/en/main/configure.tex

@@ -161,6 +161,7 @@ \subsection{What configuration will be used?}
 
 
 \subsection{Subdirectory Configuration Scheme}
+\label{sec:SubdirectoryConfigurationScheme}
 \label{sec:ConfigurationSubdirectories}
 % ConfigurationIncludeDirectory is referenced from the Bareos code.
 \label{ConfigurationIncludeDirectory}
@@ -260,11 +261,38 @@ \subsubsection{Using Subdirectories Configuration Scheme}
             to split the configuration file into resources,
             store them in the resource directories and then remove the original configuration file.
     \begin{itemize}
-    \item This requires effort. \TODO{It is planned to create a program that helps to migrate the settings,
-                however, until now, it is not available.}
-    \item The easy way is:
+    \item For migrating the \bareosDir configuration, the script \bareosMigrateConfigSh exists.
+        Being called, it connects via \command{bconsole} to a running \bareosDir and creates subdirectories with the resource configuration files.
+        \begin{commands}{\bareosMigrateConfigSh}
+# prepare temporary directory
+mkdir /tmp/baroes-dir.d
+cd /tmp/baroes-dir.d
+
+# download migration script
+wget https://raw.githubusercontent.com/bareos/bareos-contrib/master/misc/bareos-migrate-config/bareos-migrate-config.sh
+
+# execute the script
+bash bareos-migrate-config.sh
+
+# backup old configuration
+mv /etc/bareos/bareos-dir.conf /etc/bareos/bareos-dir.conf.bak
+mv /etc/bareos/bareos-dir.d /etc/bareos/bareos-dir.d.bak
+
+# make sure, that all packaged configuration resources exists,
+# otherwise they will be added when updating Bareos.
+for i in `find  /etc/bareos/bareos-dir.d.bak/ -name *.conf -type f -printf "%P\n"`; do touch "$i"; done
+
+# install newly generated configuration
+cp -a /tmp/bareos-dir.d /etc/bareos/
+        \end{commands}
+        Restart the \bareosDir and verify your configuration.
+        Also make sure, that all resource configuration files coming from Bareos packages exists, in doubt as empty files, see \hyperlink{sec:deleteConfigurationResourceFiles}{remove configuration resource files}.
+
+    \item Another way, without splitting the configuration into resource files is:
         \begin{itemize}
-        \item \path|mkdir $CONFIGDIR/$COMPONENT.d/migrate && mv $CONFIGDIR/$COMPONENT.conf $CONFIGDIR/$COMPONENT.d/migrate|
+        \item \begin{commands}{move configuration to subdirectory}
+mkdir $CONFIGDIR/$COMPONENT.d/migrate && mv $CONFIGDIR/$COMPONENT.conf $CONFIGDIR/$COMPONENT.d/migrate
+        \end{commands}
         \item Resources defined in both, the new configuration directory scheme
                     and the old configuration file, must be removed from one of the places,
                     best from the old configuration file,
@@ -400,6 +428,16 @@ \section{Resource}
 
 defines the Director resource with the name \parameter{bareos-dir} and a query file \file{/usr/lib/bareos/scripts/query.sql}.
 
+\index[general]{Configuration!Naming Convention}
+
+When naming resources, for some resource types naming conventions should be applied:
+\begin{description}
+    \item[Client] names should be postfixed with \name{-fd}
+    \item[Storage] names should be postfixed with \name{-sd}
+    \item[Director] names should be postfixed with \name{-dir}
+\end{description}
+These conventions helps a lot when reading log messages.
+
 
 \subsection{Resource Directive}
 \label{sec:ConfigurationResourceDirective}

manuals/en/main/dataencryption.tex

@@ -10,7 +10,7 @@ \chapter{Data Encryption}
 does the Director or the Storage Daemon have access to unencrypted file
 contents.
 
-\warning{These feature is only available, if Bareos is builed against OpenSSL.}
+\warning{These feature is only available, if Bareos is build against OpenSSL.}
 
 
 It is very important to specify what this implementation does NOT

manuals/en/main/dirdconf.tex

@@ -5,35 +5,29 @@ \chapter{Director Configuration}
 \index[general]{Director!Configuring the}
 \index[general]{Configuring the Director}
 
-Of all the configuration files needed to run {\bf Bareos}, the Director's is
-the most complicated, and the one that you will need to modify the most often
+Of all the configuration files needed to run {Bareos}, the Director's is
+the most complicated and the one that you will need to modify the most often
 as you add clients or modify the FileSets.
 
 For a general discussion of configuration files and resources including the
-data types recognized by {\bf Bareos}. Please see the
-\ilink{Configuration}{ConfigureChapter} chapter of this manual.
+recognized data types see \nameref{ConfigureChapter}.
 
 %\section{Director Resource Types}
 \index[general]{Types!Director Resource}
 \index[general]{Director!Resource Types}
 \index[dir]{Resource Types}
 
-Director resource type may be one of the following:
-
-Job, JobDefs, Client, Storage, Catalog, Schedule, FileSet, Pool, Director,  or
-Messages. We present them here in the most logical order for defining them:
-
-Note, everything revolves around a job and is tied to a job in one
+Everything revolves around a job and is tied to a job in one
 way or another.
 
+The \bareosDir knows about following resource types:
+
 \begin{itemize}
 \item
    \nameref{DirectorResourceDirector} -- to  define the Director's
    name and its access password used for authenticating the Console program.
    Only a single  Director resource definition may appear in the Director's
-   configuration file.  If you have either {\bf /dev/random} or  {\bf bc} on your
-   machine, Bareos will generate a random password during the configuration
-   process, otherwise it will  be left blank.
+   configuration file.
 \item
    \nameref{DirectorResourceJob} -- to define the backup/restore Jobs
    and to tie together the Client, FileSet and Schedule resources to  be used
@@ -93,7 +87,7 @@ \section{Director Resource}
 
 The following is an example of a valid Director resource definition:
 
-\begin{bconfig}{Director Ressource example}
+\begin{bconfig}{Director Resource example}
 Director {
   Name = bareos-dir
   Password = secretpassword

manuals/en/main/general.tex

@@ -66,45 +66,47 @@ \section{Bareos Components or Services}
 
 \subsection*{Bareos Director}
    \label{DirDef}
-   The Bareos Director service is the program that supervises
+   The Director is the central control program for all the other daemons.
+   It schedules and supervises
    all the backup, restore, verify and archive operations.  The system
    administrator uses the Bareos Director to schedule backups and to
    recover files. The Director runs as a daemon
    (or service) in the background.
    \label{UADef}
 
 \subsection*{Bareos Console}
-   The Bareos Console service is the program that allows the
-   administrator or user to communicate with the Bareos Director.
-   Currently, the Bareos Console is available in two versions:
-   a text-based console and a QT-based GUI interface.
-   The first and simplest is to run the Console program in a shell window
-   (i.e.  TTY interface).  Most system administrators will find this
-   completely adequate.  The second version is a GUI interface that
-   is far from complete, but quite functional as it has most the
-   capabilities of the shell Console. For more
-   details see the \nameref{sec:bconsole}.
+   The Bareos Console (\command{bconsole}) is the program that allows the
+   administrator or user to communicate with the \bareosDir.
+   It runs in a shell window (i.e.  TTY interface).
+   Most system administrators will find this completely adequate.
+   For more details see the \nameref{sec:bconsole}.
 
 \subsection*{Bareos File Daemon}
    \label{FDDef}
-   The Bareos File service (also known as the Client program) is the software
-   program that is installed on the machine to be backed up.
-   It is specific to the
-   operating system on which it runs and is responsible for providing the
-   file attributes and data when requested by the Director.  The File
-   services are also responsible for the file system dependent part of
+   The \bareosFd is a program that must be installed on each (Client) machine that should be backed up.
+   At the request of the \bareosDir, it finds the files to be backed up and sends them (their
+   data) to the \bareosSd.
+
+   It is specific to the operating system on which it runs and is responsible for providing the
+   file attributes and data when requested by the \bareosDir.
+
+   The \bareosFd is also responsible for the file system dependent part of
    restoring the file attributes and data during a recovery operation.
    This program runs as a daemon on the machine to be backed up.
 
 \subsection*{Bareos Storage Daemon}
-   \label{SDDef}
-   The Bareos Storage services consist of the software programs that
-   perform the storage and recovery of the file attributes and data to the
-   physical backup media or volumes.  In other words, the Storage daemon is
-   responsible for reading and writing your tapes (or other storage media,
-   e.g.  files). The Storage services runs as
-   a daemon on the machine that has the backup device (such as a tape
-   drive).
+    \label{SDDef}
+    The \bareosSd is responsible, at the \bareosDir request, for accepting
+    data from a \bareosFd and storing the
+    file attributes and data to the physical backup media or volumes.
+    In the case of a restore request,
+    it is responsible to find the data and send it to the \bareosFd.
+
+    There can be multiple \bareosSd in your environment, all controlled by the same \bareosDir.
+
+    The Storage services runs as
+    a daemon on the machine that has the backup device (such as a tape
+    drive).
 
 \subsection*{Catalog}
    \label{DBDefinition}

manuals/en/main/install.tex

@@ -93,7 +93,7 @@ \subsubsection{RHEL$\ge$7, CentOS$\ge$7, Fedora}
 
 DIST=RHEL_7
 # or
-# DIST=Fedora_22
+# DIST=Fedora_24
 # DIST=CentOS_7
 
 DATABASE=postgresql
@@ -178,13 +178,11 @@ \subsubsection{SUSE Linux Enterprise Server (SLES), openSUSE}
 # define parameter
 #
 
-DIST=SLE_12
+DIST=SLE_12_SP1
 # or
 # DIST=SLE_11_SP4
-# DIST=SLE_11_SP3
 # DIST=openSUSE_Leap_42.1
 # DIST=openSUSE_13.2
-# DIST=openSUSE_13.1
 
 DATABASE=postgresql
 # or
@@ -220,6 +218,7 @@ \subsubsection{Debian / Ubuntu}
 DIST=Debian_8.0
 # or
 # DIST=Debian_7.0
+# DIST=xUbuntu_16.04
 # DIST=xUbuntu_14.04
 # DIST=xUbuntu_12.04