diff --git a/docs/manuals/en/new_main_reference/source/Appendix/BackwardCompatibility.rst b/docs/manuals/en/new_main_reference/source/Appendix/BackwardCompatibility.rst index a3abd54cb14..1a721832623 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/BackwardCompatibility.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/BackwardCompatibility.rst @@ -1,7 +1,7 @@ Backward Compatibility ====================== -:index:`[TAG=Compatibility->Backward] ` +:index:`[TAG=Compatibility->Backward] ` .. _backward-compatibility: @@ -10,7 +10,7 @@ Backward Compatibility Tape Formats ------------ -:index:`[TAG=Tape->Format] ` +:index:`[TAG=Tape->Format] ` .. _backward-compatibility-tape-format: @@ -26,7 +26,7 @@ Though the tape format is basically fixed, the kinds of data that we can put on Compatibility between Bareos and Bacula --------------------------------------- -:index:`[TAG=Compatibility->Bacula] ` :index:`[TAG=Bacula] ` +:index:`[TAG=Compatibility->Bacula] ` :index:`[TAG=Bacula] ` .. _compat-bacula: @@ -35,13 +35,13 @@ Compatibility between Bareos and Bacula A Director and a Storage Daemon should (must) always run at the same version. This is true for Bareos as well as for Bacula. It is not possible to mix these components. This is because the protocol between Director and Storage Daemon itself is not versioned (also true for Bareos and Bacula). If you want to be able to switch back from Bareos to Bacula after using a Bareos director and storage daemon you have to enable the compatible mode in the Bareos storage daemon to have it write the data in the same format as the Bacula storage daemon. -The |bareosFd| is compatible with all version of the Bacula director (tested with version 5.2.13 and lower) when you enable the compatible mode in the configuration of the |bareosFd|. The compatible option was set by default in Bareos < 15.2.0, and is disabled by default since :sinceVersion:`15.2.0: Compatible = no`. +The |fd| is compatible with all version of the Bacula director (tested with version 5.2.13 and lower) when you enable the compatible mode in the configuration of the |fd|. The compatible option was set by default in Bareos < 15.2.0, and is disabled by default since :sinceVersion:`15.2.0: Compatible = no`. To be sure this is enabled you can explicitly set the compatible option: -\resourceDirectiveValue{Fd}{Client}{Compatible}{True} +:config:option:`fd/client/Compatible = True`\ -A |bareosDir| can only talk to Bacula file daemons of version 2.0 or higher. Through a change in the Bacula network protocols, it is currently not possible to use a Bacula file daemon > 6.0 with a |bareosDir|. +A |dir| can only talk to Bacula file daemons of version 2.0 or higher. Through a change in the Bacula network protocols, it is currently not possible to use a Bacula file daemon > 6.0 with a |dir|. These combinations of Bareos and Bacula are know to work together: @@ -75,12 +75,12 @@ Bacula  Bacula  Bacula  Bacula  Bacula  Bareos (compatibility mode) ============ ================== =========================== =========== -Other combinations like Bacula Director with |bareosSd| will not work. However this wasn’t even possible with different versions of bacula-dir and bacula-sd. +Other combinations like Bacula Director with |sd| will not work. However this wasn’t even possible with different versions of bacula-dir and bacula-sd. Upgrade from Bacula 5.2 to Bareos ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Upgrade from Bacula to Bareos] ` :index:`[TAG=Bareos->Upgrading] ` +:index:`[TAG=Upgrade from Bacula to Bareos] ` :index:`[TAG=Bareos->Upgrading] ` .. _upgrade-from-bacula-to-bareos: @@ -90,13 +90,15 @@ Upgrade is supported from Bacula version 5.2.x. If you are running any older ver -.. warning:: - Updating from Bacula >= 7.0 to Bareos has not been tested. + .. warning:: + Updating from Bacula >= 7.0 to Bareos has not been tested. -.. warning:: - As Bareos and Bacula packages bring binaries with identical paths and names, + + .. warning:: + + As Bareos and Bacula packages bring binaries with identical paths and names, it is on most platforms not possible to install components from both in parallel. Your package management tool will warn you about this. @@ -107,7 +109,7 @@ To have bareos running without any permission hassle, it is recommended to renam The required commands should look something like this: -.. code-block:: sh +.. code-block:: shell-session usermod -l bareos bacula groupmod -n bareos bacula @@ -121,7 +123,7 @@ Proceed with the following steps: - Backup your catalog database: - .. code-block:: sh + .. code-block:: shell-session mysqldump bacula > /tmp/bacula_5.2.sql @@ -131,7 +133,7 @@ Proceed with the following steps: - Run the update script on the old bacula database: - .. code-block:: sh + .. code-block:: shell-session export db_name=bacula /usr/lib/bareos/update_bareos_tables @@ -139,25 +141,25 @@ Proceed with the following steps: - Backup upgraded DB: - .. code-block:: sh + .. code-block:: shell-session mysqldump bacula > /tmp/bacula.sql - Create bareos database: - .. code-block:: sh + .. code-block:: shell-session /usr/lib/bareos/create_bareos_database - Insert backuped db into new database: - .. code-block:: sh + .. code-block:: shell-session cat /tmp/bacula.sql | mysql bareos - Grant permissions: - .. code-block:: sh + .. code-block:: shell-session /usr/lib/bareos/grant_mysql_privileges @@ -176,7 +178,7 @@ Renaming a postgresql database: - psql template1 - .. code-block:: sh + .. code-block:: shell-session ALTER DATABASE bacula RENAME TO bareos; ALTER USER bacula RENAME TO bareos; diff --git a/docs/manuals/en/new_main_reference/source/Appendix/BareosCopyrightTrademarkAndLicenses.rst b/docs/manuals/en/new_main_reference/source/Appendix/BareosCopyrightTrademarkAndLicenses.rst index bd2326c5ade..433acb9cc40 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/BareosCopyrightTrademarkAndLicenses.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/BareosCopyrightTrademarkAndLicenses.rst @@ -3,7 +3,7 @@ Bareos Copyright, Trademark, and Licenses ========================================= -:index:`[TAG=License->Bareos Copyright Trademark Licenses] ` :index:`[TAG=Bareos Copyright, Trademark, and Licenses] ` +:index:`[TAG=License->Bareos Copyright Trademark Licenses] ` :index:`[TAG=Bareos Copyright, Trademark, and Licenses] ` Licenses Overview ----------------- @@ -13,14 +13,14 @@ There are a number of different licenses that are used in Bareos. FDL ~~~ -:index:`[TAG=License->FDL] ` +:index:`[TAG=License->FDL] ` The :ref:`GNU Free Documentation License (FDL) ` is used for this manual, which is a free and open license. This means that you may freely reproduce it and even make changes to it. AGPL ~~~~ -:index:`[TAG=License->AGPL] ` +:index:`[TAG=License->AGPL] ` The vast bulk of the source code is released under the :ref:`GNU Affero General Public License (AGPL) version 3 `. @@ -33,14 +33,14 @@ Portions may be copyrighted by other people. These files are released under diff LGPL ~~~~ -:index:`[TAG=License->LGPL] ` +:index:`[TAG=License->LGPL] ` Some of the Bareos library source code is released under the :ref:`GNU Lesser General Public License (LGPL) `. This permits third parties to use these parts of our code in their proprietary programs to interface to Bareos. Public Domain ~~~~~~~~~~~~~ -:index:`[TAG=License->Public Domain] ` +:index:`[TAG=License->Public Domain] ` Some of the Bareos code, or code that Bareos references, has been released to the public domain. E.g. md5.c, SQLite. diff --git a/docs/manuals/en/new_main_reference/source/Appendix/BareosPrograms.rst b/docs/manuals/en/new_main_reference/source/Appendix/BareosPrograms.rst index 86e78ff4eb8..66f15765ebf 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/BareosPrograms.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/BareosPrograms.rst @@ -9,7 +9,7 @@ Bareos Daemons Daemon Command Line Options ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Daemon->Command Line Options] ` :index:`[TAG=Command Line Options->Daemon] ` +:index:`[TAG=Daemon->Command Line Options] ` :index:`[TAG=Command Line Options->Daemon] ` Each of the three daemons (Director, File, Storage) accepts a small set of options on the command line. In general, each of the daemons as well as the Console program accepts the following options: @@ -51,27 +51,27 @@ Each of the three daemons (Director, File, Storage) accepts a small set of optio bareos-dir ~~~~~~~~~~ -:index:`[TAG=Command->bareos-dir] ` :index:`[TAG=Command Line Options] ` +:index:`[TAG=Command->bareos-dir] ` :index:`[TAG=Command Line Options] ` -|bareosDir|. +|dir|. .. _command-bareos-sd: bareos-sd ~~~~~~~~~ -:index:`[TAG=Command->bareos-sd] ` :index:`[TAG=Command Line Options] ` +:index:`[TAG=Command->bareos-sd] ` :index:`[TAG=Command Line Options] ` -|bareosSd|. +|sd|. .. _command-bareos-fd: bareos-fd ~~~~~~~~~ -:index:`[TAG=Command->bareos-fd] ` :index:`[TAG=Command Line Options] ` +:index:`[TAG=Command->bareos-fd] ` :index:`[TAG=Command Line Options] ` -|bareosFd|. +|fd|. Interactive Programs -------------------- @@ -89,18 +89,18 @@ For further information regarding the Bareos Webui, please refer to :ref:`sectio bat ~~~ -:index:`[TAG=Command->bat] ` +:index:`[TAG=Command->bat] ` .. _bat: -The Bacula/Bareos Administration Tool (:command:`bat`) has been a native GUI for Bareos. It has been marked deprecated since :sinceVersion:`15.2.0: bat vs. bareos-webui`. Since Bareos :sinceVersion:`17.2.0: bat: removed from core distribution` it is no longer part of Bareos. We encourage the use of |bareosWebui| instead. +The Bacula/Bareos Administration Tool (:command:`bat`) has been a native GUI for Bareos. It has been marked deprecated since :sinceVersion:`15.2.0: bat vs. bareos-webui`. Since Bareos :sinceVersion:`17.2.0: bat: removed from core distribution` it is no longer part of Bareos. We encourage the use of |webui| instead. Volume Utility Commands ----------------------- -:index:`[TAG=Volume Utility Tools] ` :index:`[TAG=Tools->Volume Utility] ` +:index:`[TAG=Volume Utility Tools] ` :index:`[TAG=Tools->Volume Utility] ` .. _section-VolumeUtilityCommands: @@ -114,13 +114,13 @@ Parameter Specifying the Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Each of the utilities that deal with Volumes require a valid |bareosSd| configuration (actually, the only part of the configuration file that these programs need is the :config:option:`Sd/Device`\ resource definitions). This permits the programs to find the configuration parameters for your :config:option:`sd/device/ArchiveDevice`\ . Using the ``-c`` option a custom |bareosSd| configuration file or directory can be +Each of the utilities that deal with Volumes require a valid |sd| configuration (actually, the only part of the configuration file that these programs need is the :config:option:`Sd/Device`\ resource definitions). This permits the programs to find the configuration parameters for your :config:option:`sd/device/ArchiveDevice`\ . Using the :strong:`-c` option a custom |sd| configuration file or directory can be selected. Specifying a Device ^^^^^^^^^^^^^^^^^^^ -Each of these programs require a ``device-name`` where the Volume can be found. The device-name is either the name of the |bareosSd| device (:config:option:`sd/device/Name`\ ) or its :config:option:`sd/device/ArchiveDevice`\ . +Each of these programs require a :strong:`device-name` where the Volume can be found. The device-name is either the name of the |sd| device (:config:option:`sd/device/Name`\ ) or its :config:option:`sd/device/ArchiveDevice`\ . Specifying a Device Name For a Tape ''''''''''''''''''''''''''''''''''' @@ -129,9 +129,10 @@ In the case of a tape, this is the physical device name such as /dev/nst0 or /de -.. warning:: - If you have Bareos running and you want to use - one of these programs, you will either need to stop the |bareosSd| + .. warning:: + + If you have Bareos running and you want to use + one of these programs, you will either need to stop the |sd| or :bcommand:`unmount` any tape drive you want to use, otherwise the drive may get busy because Bareos is using it. After this, you can use the command :command:`mtx` or :ref:`mtx-changer script ` @@ -141,15 +142,15 @@ In the case of a tape, this is the physical device name such as /dev/nst0 or /de Specifying a Device Name For a File ''''''''''''''''''''''''''''''''''' -If you are attempting to read or write an archive file rather than a tape, the ``device-name`` can be the full path to the archive location specified at :config:option:`sd/device/ArchiveDevice`\ or this including the filename of the volume. The filename (last part of the specification) will be stripped and used as the Volume name So, the path is equivalent to the :config:option:`sd/device/ArchiveDevice`\ and the filename is +If you are attempting to read or write an archive file rather than a tape, the :strong:`device-name` can be the full path to the archive location specified at :config:option:`sd/device/ArchiveDevice`\ or this including the filename of the volume. The filename (last part of the specification) will be stripped and used as the Volume name So, the path is equivalent to the :config:option:`sd/device/ArchiveDevice`\ and the filename is equivalent to the volume name. Specifying Volumes ^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Volumes->Specifying] ` :index:`[TAG=Bootstrap] ` +:index:`[TAG=Volumes->Specifying] ` :index:`[TAG=Bootstrap] ` -Often you must specify the Volume name to the programs below. The best method to do so is to specify a bootstrap file on the command line with the ``-b`` option. As part of the bootstrap file, you will then specify the Volume name or Volume names if more than one volume is needed. For example, suppose you want to read tapes \volume{tapevolume1} and \volume{tapevolume2}. First construct a bootstrap file named say, :file:`list.bsr` which +Often you must specify the Volume name to the programs below. The best method to do so is to specify a bootstrap file on the command line with the :strong:`-b` option. As part of the bootstrap file, you will then specify the Volume name or Volume names if more than one volume is needed. For example, suppose you want to read tapes **tapevolume1** and **tapevolume2**. First construct a bootstrap file named say, :file:`list.bsr` which contains: @@ -162,31 +163,31 @@ contains: where each Volume is separated by a vertical bar. Then simply use: -.. code-block:: sh +.. code-block:: shell-session bls -b list.bsr /dev/nst0 In the case of Bareos Volumes that are on files, you may simply append volumes as follows: -.. code-block:: sh +.. code-block:: shell-session bls /var/lib/bareos/storage/volume1\|volume2 where the backslash (\) was necessary as a shell escape to permit entering the vertical bar (|). -And finally, if you feel that specifying a Volume name is a bit complicated with a bootstrap file, you can use the ``-V`` option (on all programs except :command:`bcopy`) to specify one or more Volume names separated by the vertical bar (|). For example: +And finally, if you feel that specifying a Volume name is a bit complicated with a bootstrap file, you can use the :strong:`-V` option (on all programs except :command:`bcopy`) to specify one or more Volume names separated by the vertical bar (|). For example: -.. code-block:: sh +.. code-block:: shell-session bls /dev/nst0 -V tapevolume1 You may also specify an asterisk (*) to indicate that the program should accept any volume. For example: -.. code-block:: sh +.. code-block:: shell-session bls /dev/nst0 -V* -If your |bareosSd| has following resource, +If your |sd| has following resource, .. code-block:: bareosconfig :caption: bareos-sd.d/device/FileStorage.conf @@ -199,21 +200,21 @@ If your |bareosSd| has following resource, following calls of :command:`bls` should behave identical: -.. code-block:: sh +.. code-block:: shell-session :caption: bls using Storage Device Name bls FileStorage -V Full1 or -.. code-block:: sh +.. code-block:: shell-session :caption: bls using the Archive Device of a Storage Device bls /var/lib/bareos/storage -V Full1 or -.. code-block:: sh +.. code-block:: shell-session :caption: bls using the Archive Device of a Storage Device and volume name bls /var/lib/bareos/storage/Full1 @@ -226,11 +227,11 @@ If you use Bareos with non-default block sizes defined in the pools (:config:opt bls ~~~ -:index:`[TAG=bls] ` :index:`[TAG=Command->bls] ` +:index:`[TAG=bls] ` :index:`[TAG=Command->bls] ` :command:`bls` can be used to do an :command:`ls` type listing of a Bareos tape or file. It is called: -.. code-block:: sh +.. code-block:: shell-session Usage: bls [options] -b specify a bootstrap file @@ -254,31 +255,31 @@ Normally if no options are specified, :command:`bls` will produce the equivalent For example, to list the contents of a tape: -.. code-block:: sh +.. code-block:: shell-session bls -V Volume-name /dev/nst0 Or to list the contents of a volume file: -.. code-block:: sh +.. code-block:: shell-session bls FileStorage -V Full1 or -.. code-block:: sh +.. code-block:: shell-session bls /var/lib/bareos/storage -V Full1 or -.. code-block:: sh +.. code-block:: shell-session bls /var/lib/bareos/storage/Full1 For example: -.. code-block:: sh +.. code-block:: shell-session bls FileStorage -V Full1 bls: butil.c:282-0 Using device: "/var/lib/bareos/storage" for reading. @@ -301,7 +302,7 @@ Show Detailed File Information To retrieve information, about how a file is stored on the volume, you can use :command:`bls` in verbose mode: -.. code-block:: sh +.. code-block:: shell-session bls FileStorage -V TestVolume001 -v bls: butil.c:273-0 Using device: "FileStorage" for reading. @@ -327,11 +328,11 @@ For details about the Volume format, see \bareosDeveloperGuideStorageMediaOutput Show Label Information ^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=bls->Label] ` +:index:`[TAG=bls->Label] ` -Using the ``-L`` the label information of a Volume is shown: +Using the :strong:`-L` the label information of a Volume is shown: -.. code-block:: sh +.. code-block:: shell-session :caption: bls: show volume label bls -L /var/lib/bareos/storage/testvol @@ -355,11 +356,11 @@ Using the ``-L`` the label information of a Volume is shown: Listing Jobs ^^^^^^^^^^^^ -:index:`[TAG=Listing Jobs with bls] ` :index:`[TAG=bls->Listing Jobs] ` +:index:`[TAG=Listing Jobs with bls] ` :index:`[TAG=bls->Listing Jobs] ` -If you are listing a Volume to determine what Jobs to restore, normally the ``-j`` option provides you with most of what you will need as long as you don’t have multiple clients. For example: +If you are listing a Volume to determine what Jobs to restore, normally the :strong:`-j` option provides you with most of what you will need as long as you don’t have multiple clients. For example: -.. code-block:: sh +.. code-block:: shell-session :caption: bls: list jobs bls /var/lib/bareos/storage/testvol -j @@ -386,16 +387,16 @@ If you are listing a Volume to determine what Jobs to restore, normally the ``-j 12-Sep 18:32 bls JobId 0: End of Volume at file 0 on device "FileStorage" (/var/lib/bareos/storage), Volume "testvol" 12-Sep 18:32 bls JobId 0: End of all volumes. -Adding the ``-v`` option will display virtually all information that is available for each record. +Adding the :strong:`-v` option will display virtually all information that is available for each record. Listing Blocks ^^^^^^^^^^^^^^ -:index:`[TAG=Listing Blocks with bls] ` :index:`[TAG=bls->Listing Blocks] ` +:index:`[TAG=Listing Blocks with bls] ` :index:`[TAG=bls->Listing Blocks] ` Normally, except for debugging purposes, you will not need to list Bareos blocks (the "primitive" unit of Bareos data on the Volume). However, you can do so with: -.. code-block:: sh +.. code-block:: shell-session bls -k /tmp/File002 bls: butil.c:148 Using device: /tmp @@ -407,9 +408,9 @@ Normally, except for debugging purposes, you will not need to list Bareos blocks bls: Got EOF on device /tmp End of File on device -By adding the ``-v`` option, you can get more information, which can be useful in knowing what sessions were written to the volume: +By adding the :strong:`-v` option, you can get more information, which can be useful in knowing what sessions were written to the volume: -.. code-block:: sh +.. code-block:: shell-session bls -k -v /tmp/File002 Date label written: 2002-10-19 at 21:16 @@ -425,9 +426,9 @@ By adding the ``-v`` option, you can get more information, which can be useful i Armed with the SessionId and the SessionTime, you can extract just about anything. -If you want to know even more, add a second ``-v`` to the command line to get a dump of every record in every block. +If you want to know even more, add a second :strong:`-v` to the command line to get a dump of every record in every block. -.. code-block:: sh +.. code-block:: shell-session bls -k -vv /tmp/File002 bls: block.c:79 Dump block 80f8ad0: size=64512 BlkNum=1 @@ -458,7 +459,7 @@ If you want to know even more, add a second ``-v`` to the command line to get a bextract ~~~~~~~~ -:index:`[TAG=bextract] ` :index:`[TAG=Command->bextract] ` :index:`[TAG=Disaster->Recovery->bextract] ` +:index:`[TAG=bextract] ` :index:`[TAG=Command->bextract] ` :index:`[TAG=Disaster->Recovery->bextract] ` If you find yourself using :command:`bextract`, you probably have done something wrong. For example, if you are trying to recover a file but are having problems, please see the :ref:`section-RestoreCatalog` chapter. @@ -476,7 +477,7 @@ Please note that some of the current limitations of :command:`bextract` are: It is called: -.. code-block:: sh +.. code-block:: shell-session Usage: bextract -b specify a bootstrap file @@ -496,8 +497,9 @@ where device-name is the Archive Device (raw device name or full filename) of th -.. warning:: - On Windows systems, if you specify a prefix of say d:/tmp, any file that + .. warning:: + + On Windows systems, if you specify a prefix of say d:/tmp, any file that would have been restored to :file:`C:/My Documents` will be restored to :file:`D:/tmp/My Documents`. That is, the original drive specification will be stripped. If no prefix is specified, the file will be restored to the original @@ -523,7 +525,7 @@ For example, if the file include-list contains: Then the command: -.. code-block:: sh +.. code-block:: shell-session bextract -i include-list -V Volume /dev/nst0 /tmp @@ -534,7 +536,7 @@ Extracting With a Bootstrap File The -b option is used to specify a bootstrap file containing the information needed to restore precisely the files you want. Specifying a bootstrap file is optional but recommended because it gives you the most control over which files will be restored. For more details on the bootstrap file, please see :ref:`Restoring Files with the Bootstrap File ` chapter of this document. Note, you may also use a bootstrap file produced by the restore command. For example: -.. code-block:: sh +.. code-block:: shell-session bextract -b bootstrap-file /dev/nst0 /tmp @@ -548,18 +550,19 @@ If you wish to extract files that span several Volumes, you can specify the Volu Extracting Under Windows ^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Windows->bextract] ` +:index:`[TAG=Windows->bextract] ` + + .. warning:: -.. warning:: - If you use :command:`bextract` under Windows, the ordering of the parameters is essential. + If you use :command:`bextract` under Windows, the ordering of the parameters is essential. To use :command:`bextract`, the Bareos Storage Daemon must be installed. As bextract works on tapes or disk volumes, these must be configured in the Storage Daemon configuration file, normally found at :file:`C:\\ProgrammData\\Bareos\\bareos-sd.conf`. However, it is not required to start the Bareos Storage Daemon. Normally, if the Storage Daemon would be able to run, :command:`bextract` would not be required. After installing, :command:`bextract` can be called via command line: -.. code-block:: sh +.. code-block:: shell-session :caption: Call of bextract C:\Program Files\Bareos .\bextract.exe -c "C:\ProgrammData\Bareos\bareos-sd.conf" -V @@ -572,7 +575,7 @@ If you want to use exclude or include files you need to write them like you do o /Program Files/Bareos/bareos-dir.exe /ProgramData/ -.. code-block:: sh +.. code-block:: shell-session :caption: Call bextract with exclude list C:\Program Files\Bareos .\bextract.exe -e exclude.list -c "C:\ProgrammData\Bareos\bareos-sd.conf" -V @@ -580,7 +583,7 @@ If you want to use exclude or include files you need to write them like you do o bscan ~~~~~ -:index:`[TAG=bscan] ` :index:`[TAG=Command->bscan] ` +:index:`[TAG=bscan] ` :index:`[TAG=Command->bscan] ` If you find yourself using this program, you have probably done something wrong. For example, the best way to recover a lost or damaged Bareos database is to reload the database by using the bootstrap file that was written when you saved it (default Bareos-dir.conf file). @@ -593,7 +596,7 @@ With some care, :command:`bscan` can also be used to synchronize your existing c It is called: -.. code-block:: sh +.. code-block:: shell-session Usage: bscan [options] -B specify the database driver name (default NULL) @@ -627,7 +630,7 @@ chapter of the manual. Finally, before scanning into an empty database, you must Forgetting for the moment the extra complications of a full rebuild of your catalog, let’s suppose that you did a backup to Volumes "Vol001" and "Vol002", then sometime later all records of one or both those Volumes were pruned or purged from the database. By using bscan you can recreate the catalog entries for those Volumes and then use the restore command in the Console to restore whatever you want. A command something like: -.. code-block:: sh +.. code-block:: shell-session bscan -v -V Vol001|Vol002 /dev/nst0 @@ -636,7 +639,7 @@ This must correspond to the Archive Device in the conf file. Then to actually write or store the records in the catalog, add the -s option as follows: -.. code-block:: sh +.. code-block:: shell-session bscan -s -m -v -V Vol001|Vol002 /dev/nst0 @@ -644,7 +647,7 @@ When writing to the database, if :command:`bscan` finds existing records, it wil If you have multiple tapes, you should scan them with: -.. code-block:: sh +.. code-block:: shell-session bscan -s -m -v -V Vol001|Vol002|Vol003 /dev/nst0 @@ -672,20 +675,20 @@ database, they will not have their autochanger status and slots properly set. As Using bscan to Compare a Volume to an existing Catalog ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Catalog->Using bscan to Compare a Volume to an existing] ` +:index:`[TAG=Catalog->Using bscan to Compare a Volume to an existing] ` If you wish to compare the contents of a Volume to an existing catalog without changing the catalog, you can safely do so if and only if you do not specify either the -m or the -s options. However, the comparison routines are not as good or as thorough as they should be, so we don’t particularly recommend this mode other than for testing. Using bscan to Recreate a Catalog from a Volume ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Catalog->Recreate Using bscan] ` :index:`[TAG=bscan->Recreate Catalog] ` +:index:`[TAG=Catalog->Recreate Using bscan] ` :index:`[TAG=bscan->Recreate Catalog] ` This is the mode for which bscan is most useful. You can either bscan into a freshly created catalog, or directly into your existing catalog (after having made an ASCII copy as described above). Normally, you should start with a freshly created catalog that contains no data. Starting with a single Volume named TestVolume1, you run a command such as: -.. code-block:: sh +.. code-block:: shell-session bscan -V TestVolume1 -v -s -m /dev/nst0 @@ -693,13 +696,13 @@ If there is more than one volume, simply append it to the first one separating i For example, after having done a full backup of a directory, then two incrementals, I reinitialized the SQLite database as described above, and using the bootstrap.bsr file noted above, I entered the following command: -.. code-block:: sh +.. code-block:: shell-session bscan -b bootstrap.bsr -v -s /dev/nst0 which produced the following output: -.. code-block:: sh +.. code-block:: shell-session bscan: bscan.c:182 Using Database: Bareos, User: bacula bscan: bscan.c:673 Created Pool record for Pool: Default @@ -763,7 +766,7 @@ There are two solutions to this problem. The first is possibly the simplest and Using bscan to Correct the Volume File Count ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=bscan->Correct Volume File Count] ` :index:`[TAG=Volume->File Count] ` +:index:`[TAG=bscan->Correct Volume File Count] ` :index:`[TAG=Volume->File Count] ` If the Storage daemon crashes during a backup Job, the catalog will not be properly updated for the Volume being used at the time of the crash. This means that the Storage daemon will have written say 20 files on the tape, but the catalog record for the Volume indicates only 19 files. @@ -772,7 +775,7 @@ Bareos refuses to write on a tape that contains a different number of files from After bscan ^^^^^^^^^^^ -:index:`[TAG=bscan->after] ` +:index:`[TAG=bscan->after] ` If you use bscan to enter the contents of the Volume into an existing catalog, you should be aware that the records you entered may be immediately pruned during the next job, particularly if the Volume is very old or had been previously purged. To avoid this, after running bscan, you can manually set the volume status (VolStatus) to Read-Only by using the update command in the catalog. This will allow you to restore from the volume without having it immediately purged. When you have restored and backed up the data, you can reset the VolStatus to Used and the Volume will be purged from the catalog. @@ -780,12 +783,12 @@ backed up the data, you can reset the VolStatus to Used and the Volume will be p bcopy ~~~~~ -:index:`[TAG=bcopy] ` :index:`[TAG=Command->bcopy] ` +:index:`[TAG=bcopy] ` :index:`[TAG=Command->bcopy] ` The :command:`bcopy` program can be used to copy one Bareos archive file to another. For example, you may copy a tape to a file, a file to a tape, a file to a file, or a tape to a tape. For tape to tape, you will need two tape drives. In the process of making the copy, no record of the information written to the new Volume is stored in the catalog. This means that the new Volume, though it contains valid backup data, cannot be accessed directly from existing catalog entries. If you wish to be able to use the Volume with the Console restore command, for example, you must first bscan the new Volume into the catalog. -.. code-block:: sh +.. code-block:: shell-session Usage: bcopy [-d debug_level] -b bootstrap specify a bootstrap file @@ -810,7 +813,7 @@ As this is a new program, any feedback on its use would be appreciated. In addit btape ~~~~~ -:index:`[TAG=btape] ` :index:`[TAG=Command->btape] ` +:index:`[TAG=btape] ` :index:`[TAG=Command->btape] ` This program permits a number of elementary tape operations via a tty command interface. It works only with tapes and not with other kinds of Bareos storage media (DVD, File, ...). The test command, described below, can be very useful for testing older tape drive compatibility problems. Aside from initial testing of tape drive compatibility with Bareos, btape will be mostly used by developers writing new tape drivers. @@ -820,7 +823,7 @@ To work properly, :command:`btape` needs to read the Storage daemon’s configur The physical device name must be specified on the command line, and this same device name must be present in the Storage daemon’s configuration file read by :command:`btape`. -.. code-block:: sh +.. code-block:: shell-session Usage: btape -b specify bootstrap file @@ -837,7 +840,7 @@ The physical device name must be specified on the command line, and this same de Using btape to Verify your Tape Drive ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Drive->Verify using btape] ` +:index:`[TAG=Drive->Verify using btape] ` An important reason for this program is to ensure that a Storage daemon configuration file is defined so that Bareos will correctly read and write tapes. @@ -945,9 +948,9 @@ You can change the block size in the Storage Daemon configuration file. bscrypto ~~~~~~~~ -:index:`[TAG=bscrypto] ` :index:`[TAG=Command->bscrypto] ` +:index:`[TAG=bscrypto] ` :index:`[TAG=Command->bscrypto] ` -:command:`bscrypto` is used in the process of encrypting tapes (see also :ref:`LTOHardwareEncryptionGeneral`). The |bareosSd| and the btools (:command:`bls`, :command:`bextract`, :command:`bscan`, :command:`btape`, :command:`bextract`) will use a so called |bareosSd| plugin to perform the setting and clearing of the encryption keys. To bootstrap the encryption support and for +:command:`bscrypto` is used in the process of encrypting tapes (see also :ref:`LTOHardwareEncryptionGeneral`). The |sd| and the btools (:command:`bls`, :command:`bextract`, :command:`bscan`, :command:`btape`, :command:`bextract`) will use a so called |sd| plugin to perform the setting and clearing of the encryption keys. To bootstrap the encryption support and for populating things like the crypto cache with encryption keys of volumes that you want to scan, you need to use the bscrypto tool. The bscrypto tool has the following capabilities: - Generate a new passphrase @@ -990,13 +993,13 @@ The following programs are general utility programs and in general do not need a bsmtp ~~~~~ -:index:`[TAG=bsmtp] ` :index:`[TAG=Command->bsmtp] ` +:index:`[TAG=bsmtp] ` :index:`[TAG=Command->bsmtp] ` :command:`bsmtp` is a simple mail transport program that permits more flexibility than the standard mail programs typically found on Unix systems. It can even be used on Windows machines. It is called: -.. code-block:: sh +.. code-block:: shell-session :caption: bsmtp Usage: bsmtp [-f from] [-h mailhost] [-s subject] [-c copy] [recipient ...] @@ -1023,7 +1026,7 @@ recipients is a space separated list of email recipients. The body of the email message is read from standard input. -An example of the use of :command:`bsmtp` would be to put the following statement in the :ref:`Messages resource ` of your |bareosDir| configuration. +An example of the use of :command:`bsmtp` would be to put the following statement in the :ref:`Messages resource ` of your |dir| configuration. .. code-block:: bareosconfig :caption: bsmtp in Message resource @@ -1050,14 +1053,14 @@ bareos-dbcheck .. _dbcheck: - :index:`[TAG=bareos-dbcheck] ` :index:`[TAG=Command->bareos-dbcheck] ` :index:`[TAG=Catalog->database check] ` + :index:`[TAG=bareos-dbcheck] ` :index:`[TAG=Command->bareos-dbcheck] ` :index:`[TAG=Catalog->database check] ` :command:`bareos-dbcheck` is a simple program that will search for logical inconsistencies in the Bareos tables in your database, and optionally fix them. It is a database maintenance routine, in the sense that it can detect and remove unused rows, but it is not a database repair routine. To repair a database, see the tools furnished by the database vendor. Normally :command:`bareos-dbcheck` should never need to be run, but if Bareos has crashed or you have a lot of Clients, Pools, or Jobs that you have removed, it could be useful. -:command:`bareos-dbcheck` is best started as the same user, as the |bareosDir| is running, normally **bareos**. If you are **root** on Linux, use the following command to switch to user **bareos**: +:command:`bareos-dbcheck` is best started as the same user, as the |dir| is running, normally **bareos**. If you are **root** on Linux, use the following command to switch to user **bareos**: -.. code-block:: sh +.. code-block:: shell-session :caption: Substitute user to bareos su -s /bin/bash - bareos @@ -1066,7 +1069,7 @@ If not, problems of reading the Bareos configuration or accessing the database c :command:`bareos-dbcheck` supports following command line options: -.. code-block:: sh +.. code-block:: shell-session Usage: bareos-dbcheck [-c config ] [-B] [-C catalog name] [-d debug level] [-D driver name] [] [] -b batch mode @@ -1080,11 +1083,11 @@ If not, problems of reading the Bareos configuration or accessing the database c -v verbose -? print this message -When using the default configuration paths, it is not necessary to specify any options. Optionally, as Bareos supports loading its database backend dynamically you may specify the right database driver to use using the ``-D`` option. +When using the default configuration paths, it is not necessary to specify any options. Optionally, as Bareos supports loading its database backend dynamically you may specify the right database driver to use using the :strong:`-D` option. -If the ``-B`` option is specified, :command:`bareos-dbcheck` will print out catalog information in a simple text based format: +If the :strong:`-B` option is specified, :command:`bareos-dbcheck` will print out catalog information in a simple text based format: -.. code-block:: sh +.. code-block:: shell-session # bareos-dbcheck -B catalog=MyCatalog @@ -1097,13 +1100,13 @@ If the ``-B`` option is specified, :command:`bareos-dbcheck` will print out cata db_port=0 db_socket= -If the ``-c`` option is given with the |bareosDir| configuration, there is no need to enter any of the command line arguments, in particular the working directory as :command:`bareos-dbcheck` will read them from the file. +If the :strong:`-c` option is given with the |dir| configuration, there is no need to enter any of the command line arguments, in particular the working directory as :command:`bareos-dbcheck` will read them from the file. -If the ``-f`` option is specified, :command:`bareos-dbcheck` will repair (fix) the inconsistencies it finds. Otherwise, it will report only. +If the :strong:`-f` option is specified, :command:`bareos-dbcheck` will repair (fix) the inconsistencies it finds. Otherwise, it will report only. -If the ``-b`` option is specified, :command:`bareos-dbcheck` will run in batch mode, and it will proceed to examine and fix (if ``-f`` is set) all programmed inconsistency checks. If the ``-b`` option is not specified, :command:`bareos-dbcheck` will enter interactive mode and prompt with the following: +If the :strong:`-b` option is specified, :command:`bareos-dbcheck` will run in batch mode, and it will proceed to examine and fix (if :strong:`-f` is set) all programmed inconsistency checks. If the :strong:`-b` option is not specified, :command:`bareos-dbcheck` will enter interactive mode and prompt with the following: -.. code-block:: sh +.. code-block:: shell-session Hello, this is the database check/correct program. Modify database is off. Verbose is off. @@ -1127,9 +1130,9 @@ If the ``-b`` option is specified, :command:`bareos-dbcheck` will run in batch m 17) Quit Select function number: -By entering 1 or 2, you can toggle the modify database flag (``-f`` option) and the verbose flag (``-v``). It can be helpful and reassuring to turn off the modify database flag, then select one or more of the consistency checks (items 3 through 13) to see what will be done, then toggle the modify flag on and re-run the check. +By entering 1 or 2, you can toggle the modify database flag (:strong:`-f` option) and the verbose flag (:strong:`-v`). It can be helpful and reassuring to turn off the modify database flag, then select one or more of the consistency checks (items 3 through 13) to see what will be done, then toggle the modify flag on and re-run the check. -Since Bareos :sinceVersion:`16.2.5: bareos-dbcheck -b -v`, when running :command:`bareos-dbcheck` with ``-b`` and ``-v``, it will not interactively ask if results should be printed or not. Instead, it does not print any detail results. +Since Bareos :sinceVersion:`16.2.5: bareos-dbcheck -b -v`, when running :command:`bareos-dbcheck` with :strong:`-b` and :strong:`-v`, it will not interactively ask if results should be printed or not. Instead, it does not print any detail results. The inconsistencies examined are the following: @@ -1160,16 +1163,16 @@ The inconsistencies examined are the following: - All Restore records. This command will remove all Restore records, regardless of their age. -If you are using MySQL, :command:`bareos-dbcheck` in interactive mode will ask you if you want to create temporary indexes to speed up orphaned Path and Filename elimination. In batch mode (``-b``) the temporary indexes will be created without asking. +If you are using MySQL, :command:`bareos-dbcheck` in interactive mode will ask you if you want to create temporary indexes to speed up orphaned Path and Filename elimination. In batch mode (:strong:`-b`) the temporary indexes will be created without asking. -If you are using bvfs (e.g. used by :ref:`bareos-webui `), don’t eliminate orphaned path, else you will have to rebuild \variable{brestore_pathvisibility} and \variable{brestore_pathhierarchy} indexes. +If you are using bvfs (e.g. used by :ref:`bareos-webui `), don’t eliminate orphaned path, else you will have to rebuild ``brestore_pathvisibility``\ and ``brestore_pathhierarchy``\ indexes. Normally you should never need to run :command:`bareos-dbcheck` in spite of the recommendations given above, which are given so that users don’t waste their time running :command:`bareos-dbcheck` too often. bregex ~~~~~~ -:index:`[TAG=bregex] ` :index:`[TAG=Command->bregex] ` +:index:`[TAG=bregex] ` :index:`[TAG=Command->bregex] ` :command:`bregex` is a simple program that will allow you to test regular expressions against a file of data. This can be useful because the regex libraries on most systems differ, and in addition, regex expressions can be complicated. @@ -1192,7 +1195,7 @@ This program can be useful for testing regex expressions to be applied against a bwild ~~~~~ -:index:`[TAG=bwild] ` :index:`[TAG=Command->bwild] ` +:index:`[TAG=bwild] ` :index:`[TAG=Command->bwild] ` :command:`bwild` is a simple program that will allow you to test wild-card expressions against a file of data. @@ -1215,7 +1218,7 @@ This program can be useful for testing wild expressions to be applied against a bpluginfo ~~~~~~~~~ -:index:`[TAG=bpluginfo] ` :index:`[TAG=Command->bpluginfo] ` +:index:`[TAG=bpluginfo] ` :index:`[TAG=Command->bpluginfo] ` The main purpose of bpluginfo is to display different information about Bareos plugin. You can use it to check a plugin name, author, license and short description. You can use -f option to display API implemented by the plugin. Some plugins may require additional ’-a’ option for val- idating a Bareos Daemons API. In most cases it is not required. diff --git a/docs/manuals/en/new_main_reference/source/Appendix/CatalogTables.rst b/docs/manuals/en/new_main_reference/source/Appendix/CatalogTables.rst index e8c944d479c..dbe76b78752 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/CatalogTables.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/CatalogTables.rst @@ -8,12 +8,12 @@ Bareos stores its information in a database, named Catalog. It is configured by Job --- -:index:`[TAG=Catalog->Job] ` :index:`[TAG=Job->Catalog] ` +:index:`[TAG=Catalog->Job] ` :index:`[TAG=Job->Catalog] ` JobStatus ~~~~~~~~~ -:index:`[TAG=Job->JobStatus] ` :index:`[TAG=Catalog->Job->JobStatus] ` +:index:`[TAG=Job->JobStatus] ` :index:`[TAG=Catalog->Job->JobStatus] ` The status of a Bareos job is stored as abbreviation in the Catalog database table Job. It is also displayed by some bconsole commands, eg. :bcommand:`list jobs`. diff --git a/docs/manuals/en/new_main_reference/source/Appendix/Debugging.rst b/docs/manuals/en/new_main_reference/source/Appendix/Debugging.rst index fcd13173ff3..b4b6ffc9f5d 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/Debugging.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/Debugging.rst @@ -1,7 +1,7 @@ Debugging ========= -:index:`[TAG=Crash] ` :index:`[TAG=Debug->crash] ` +:index:`[TAG=Crash] ` :index:`[TAG=Debug->crash] ` This chapter describes, how to debug Bareos, when the program crashes. If you are just interested about how to get more information about a running Bareos daemon, please read :ref:`section-debug-messages`. @@ -25,9 +25,9 @@ For this to work, you need to ensure that a few things are setup correctly on yo #. By default, btraceback uses :command:`bsmtp` to send the traceback via email. Therefore it expects a local mail transfer daemon running. It send the traceback to root@localhost via :strong:`localhost`. -#. Some Linux distributions, e.g. Ubuntu:index:`[TAG=Platform->Ubuntu->Debug] `, disable the possibility to examine the memory of other processes. While this is a good idea for hardening a system, our debug mechanismen will fail. To disable this feature, run (as root): +#. Some Linux distributions, e.g. Ubuntu:index:`[TAG=Platform->Ubuntu->Debug] `, disable the possibility to examine the memory of other processes. While this is a good idea for hardening a system, our debug mechanismen will fail. To disable this feature, run (as root): - .. code-block:: sh + .. code-block:: shell-session :caption: disable ptrace protection to enable debugging (required on Ubuntu Linux) test -e /proc/sys/kernel/yama/ptrace_scope && echo 0 > /proc/sys/kernel/yama/ptrace_scope @@ -37,11 +37,11 @@ If all the above conditions are met, the daemon that crashes will produce a trac Testing The Traceback --------------------- -:index:`[TAG=Traceback->Test] ` +:index:`[TAG=Traceback->Test] ` To "manually" test the traceback feature, you simply start Bareos then obtain the PID of the main daemon thread (there are multiple threads). The output produced here will look different depending on what OS and what version of the kernel you are running. -.. code-block:: sh +.. code-block:: shell-session :caption: get the process ID of a running Bareos daemon ps fax | grep bareos-dir @@ -49,7 +49,7 @@ To "manually" test the traceback feature, you simply start Bareos then obtain th which in this case is 2103. Then while Bareos is running, you call the program giving it the path to the Bareos executable and the PID. In this case, it is: -.. code-block:: sh +.. code-block:: shell-session :caption: get traceback of running Bareos director daemon btraceback /usr/sbin/bareos-dir 2103 @@ -59,7 +59,7 @@ It should produce an email showing you the current state of the daemon (in this Getting A Traceback On Other Systems ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -It should be possible to produce a similar traceback on systems other than Linux, either using :command:`gdb` or some other debugger. Solaris:index:`[TAG=Platform->Solaris->Debug] ` with :command:`dbx` loaded works quite fine. On other systems, you will need to modify the :command:`btraceback` program to invoke the correct debugger, and possibly correct the :file:`btraceback.gdb` script to have appropriate commands for your debugger. +It should be possible to produce a similar traceback on systems other than Linux, either using :command:`gdb` or some other debugger. Solaris:index:`[TAG=Platform->Solaris->Debug] ` with :command:`dbx` loaded works quite fine. On other systems, you will need to modify the :command:`btraceback` program to invoke the correct debugger, and possibly correct the :file:`btraceback.gdb` script to have appropriate commands for your debugger. Please keep in mind that for any debugger to work, it will most likely need to run as root. Manually Running Bareos Under The Debugger @@ -71,7 +71,7 @@ If for some reason you cannot get the automatic traceback, or if you want to int #. Start the Storage daemon under the debugger: - .. code-block:: sh + .. code-block:: shell-session :caption: run the Bareos Storage daemon in the debugger gdb --args /usr/sbin/bareos-sd -f -s -d 200 @@ -98,7 +98,7 @@ If for some reason you cannot get the automatic traceback, or if you want to int #. To get a general traceback of all threads, issue the following command: - .. code-block:: sh + .. code-block:: shell-session :caption: run the Bareos Storage daemon in the debugger (gdb) thread apply all bt diff --git a/docs/manuals/en/new_main_reference/source/Appendix/DisasterRecoveryUsingBareos.rst b/docs/manuals/en/new_main_reference/source/Appendix/DisasterRecoveryUsingBareos.rst index 46d6020abe8..98959e68173 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/DisasterRecoveryUsingBareos.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/DisasterRecoveryUsingBareos.rst @@ -3,7 +3,7 @@ Disaster Recovery Using Bareos ============================== -:index:`[TAG=Disaster->Recovery] ` :index:`[TAG=Recovery->Disaster Recovery] ` +:index:`[TAG=Disaster->Recovery] ` :index:`[TAG=Recovery->Disaster Recovery] ` General ------- @@ -28,7 +28,7 @@ Here are a few important considerations concerning disaster recovery that you sh Steps to Take Before Disaster Strikes ------------------------------------- -:index:`[TAG=Disaster->Before] ` +:index:`[TAG=Disaster->Before] ` - Create a rescue or CDROM for your systems. Generally, they are offered by each distribution, and there are many good rescue disks on the Web @@ -64,7 +64,7 @@ Generally, following components are required for a Bare Metal Recovery: Linux ~~~~~ -:index:`[TAG=Disaster->Recovery->Linux] ` +:index:`[TAG=Disaster->Recovery->Linux] ` From the Relax-and-Recover web site (`http://relax-and-recover.org `_): @@ -75,13 +75,13 @@ Relax-and-Recover (ReaR) is quite easy to use with Bareos. Installation ^^^^^^^^^^^^ -Bareos is a supported backend for ReaR >= 1.15. To use the ``BAREOS_CLIENT`` option, ReaR >= 1.17 is required. If ReaR >= 1.17 is not part of your distribution, check the `download section on the +Bareos is a supported backend for ReaR >= 1.15. To use the :strong:`BAREOS_CLIENT` option, ReaR >= 1.17 is required. If ReaR >= 1.17 is not part of your distribution, check the `download section on the ReaR website `_. Configuration ^^^^^^^^^^^^^ -Assuming you have a working Bareos configuration on the system you want to protect with ReaR and Bareos references this system by the name ``bareosclient-fd``, the only configuration for ReaR is: +Assuming you have a working Bareos configuration on the system you want to protect with ReaR and Bareos references this system by the name :strong:`bareosclient-fd`, the only configuration for ReaR is: .. code-block:: cfg @@ -110,7 +110,7 @@ Backup If you have installed and configured ReaR on your system, type -.. code-block:: sh +.. code-block:: shell-session :caption: Create Rescue Image rear -v mkrescue @@ -119,8 +119,9 @@ to create the rescue image. If you used the configuration example above, you wil -.. warning:: - This will not create a Bareos backup on your system! You will have to do that by + .. warning:: + + This will not create a Bareos backup on your system! You will have to do that by other means, e.g. by a regular Bareos backup schedule. Also :command:`rear mkbackup` will not create a backup. In this configuration it will only create the rescue ISO @@ -131,7 +132,7 @@ Recovery In case, you want to recover your system, boot it using the generated ReaR recovery ISO. After booting log in as user **root** and type -.. code-block:: sh +.. code-block:: shell-session :caption: Restore your system using Rear and Bareos rear recover @@ -148,7 +149,7 @@ ReaR will restore your bootloader. Recovery is complete. Restoring a Bareos Server ------------------------- -:index:`[TAG=Restore->Bareos Server] ` +:index:`[TAG=Restore->Bareos Server] ` .. _section-RestoreServer: diff --git a/docs/manuals/en/new_main_reference/source/Appendix/Howtos.rst b/docs/manuals/en/new_main_reference/source/Appendix/Howtos.rst index 09d61f24982..bd846c50519 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/Howtos.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/Howtos.rst @@ -33,7 +33,7 @@ Obviously, it can not be used to do a restore. Backup Of Third Party Databases ------------------------------- -:index:`[TAG=Backup->of Third Party Databases] ` :index:`[TAG=Database->Backup Of Third Party] ` +:index:`[TAG=Backup->of Third Party Databases] ` :index:`[TAG=Database->Backup Of Third Party] ` .. _BackupOtherDBs: @@ -46,7 +46,7 @@ The best solution is to shutdown your database before backing it up, or use some Backup of MSSQL Databases with Bareos Plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=MSSQL Backup] ` :index:`[TAG=Database->MSSQL] ` :index:`[TAG=Plugin->MSSQL backup] ` +:index:`[TAG=MSSQL Backup] ` :index:`[TAG=Database->MSSQL] ` :index:`[TAG=Plugin->MSSQL backup] ` .. _MSSQL: @@ -64,6 +64,7 @@ If you like to use the MSSQL-Plugin to backing up your Databases you need to con | .. warning:: + If you set the databases into the mentionend mode you have to consider some maintance facts. The database doesn't shrink or delete the logs unanttended, so you have to shrink them manual once a week and you have to truncate the logs once in a month. - | Security and Access @@ -90,7 +91,7 @@ There is no difference for the rights and roles between using a systemaccount (t MSSQL Plugin Installation ^^^^^^^^^^^^^^^^^^^^^^^^^ -For Bareos < 14.2, install the Bareos MSSQL plugin onto the MSSQL server you want to backup. Bareos >= 14.2 also allows to backup remote MSSQL servers (option ``serveraddress``). +For Bareos < 14.2, install the Bareos MSSQL plugin onto the MSSQL server you want to backup. Bareos >= 14.2 also allows to backup remote MSSQL servers (option :strong:`serveraddress`). Bareos Windows-Installer '''''''''''''''''''''''' @@ -632,7 +633,7 @@ Followed is a example for a restore of full, differential and incremental backup Backup of a PostgreSQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=PostgreSQL->Backup] ` :index:`[TAG=Database->PostgreSQL->Backup] ` +:index:`[TAG=PostgreSQL->Backup] ` :index:`[TAG=Database->PostgreSQL->Backup] ` .. _backup-postgresql: @@ -643,7 +644,7 @@ In this section, we describe different methods how to do backups of the PostgreS Backup of a PostgreSQL Database by using the RunScript directive ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=RunScript->Example] ` +:index:`[TAG=RunScript->Example] ` One method to backup a PostgreSQL database is to use the :command:`pg_dumpall` tool to dump the database into a file and then backup it as a normal file. After the backup, the file can be removed. It may also be an option not to remove it, so that the latest version is always available immediately. On the next job run it will be overwritten anyway. @@ -693,7 +694,7 @@ Note that redirecting the :command:`pg_dumpall` output to a file requires to run Backup of a PostgreSQL Databases by using the bpipe plugin ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=bpipe->PostgreSQL backup] ` +:index:`[TAG=bpipe->PostgreSQL backup] ` Instead of creating a temporary database dump file, the bpipe plugin can be used. For general information about bpipe, see the :ref:`bpipe` section. The bpipe plugin is configured inside the :config:option:`dir/fileset/Include`\ section of a File Set, e.g.: @@ -733,7 +734,7 @@ This can also be used, to backup a database that is running on a remote host: Backup of a PostgreSQL Databases by using the PGSQL-Plugin ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Plugin->PostgreSQL Backup] ` +:index:`[TAG=Plugin->PostgreSQL Backup] ` .. _backup-postgresql-plugin: @@ -748,7 +749,7 @@ For a full description, see https://github.com/bareos/contrib-pgsql-plugin/wiki. Backup of a MySQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=MySQL->Backup] ` :index:`[TAG=Database->MySQL->Backup] ` +:index:`[TAG=MySQL->Backup] ` :index:`[TAG=Database->MySQL->Backup] ` .. _backup-mysql: @@ -759,7 +760,7 @@ In this section, we describe different methods to do a full backup of a MySQL da Backup of MySQL Databases using the Bareos MySQL Percona xtrabackup Plugin ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Plugin->MySQL Backup] ` :index:`[TAG=Percona xtrabackup] ` :index:`[TAG=xtrabackup] ` +:index:`[TAG=Plugin->MySQL Backup] ` :index:`[TAG=Percona xtrabackup] ` :index:`[TAG=xtrabackup] ` .. _backup-mysql-xtrabackup: @@ -773,9 +774,9 @@ Prerequisites Install the xtrabackup tool from Percona. Documentation and packages are available here: https://www.percona.com/software/mysql-database/percona-xtrabackup. The plugin was successfully tested with xtrabackup versions 2.3.5 and 2.4.4. -As it is a Python plugin, it will also require to have the package **bareos-filedaemon-python-plugin** installed on the |bareosFd|, where you run it. +As it is a Python plugin, it will also require to have the package **bareos-filedaemon-python-plugin** installed on the |fd|, where you run it. -For authentication the :file:`.mycnf` file of the user running the |bareosFd|. Before proceeding, make sure that xtrabackup can connect to the database and create backups. +For authentication the :file:`.mycnf` file of the user running the |fd|. Before proceeding, make sure that xtrabackup can connect to the database and create backups. Installation '''''''''''' @@ -785,7 +786,7 @@ Make sure you have met the prerequisites. Install the files :file:`BareosFdPerco Configuration ''''''''''''' -Activate your plugin directory in the |bareosFd| configuration. See :ref:`fdPlugins` for more about plugins in general. +Activate your plugin directory in the |fd| configuration. See :ref:`fdPlugins` for more about plugins in general. .. code-block:: bareosconfig :caption: bareos-fd.d/client/myself.conf @@ -818,15 +819,15 @@ If used this way, the plugin will call xtrabackup to create a backup of all data You can append options to the plugin call as key=value pairs, separated by ’:’. The following options are available: -- With ``mycnf`` you can make xtrabackup use a special mycnf-file with login credentials. +- With :strong:`mycnf` you can make xtrabackup use a special mycnf-file with login credentials. -- ``dumpbinary`` lets you modify the default command xtrabackup. +- :strong:`dumpbinary` lets you modify the default command xtrabackup. -- ``dumpoptions`` to modify the options for xtrabackup. Default setting is: :command:`--backup --datadir=/var/lib/mysql/ --stream=xbstream --extra-lsndir=/tmp/individual_tempdir` +- :strong:`dumpoptions` to modify the options for xtrabackup. Default setting is: :command:`--backup --datadir=/var/lib/mysql/ --stream=xbstream --extra-lsndir=/tmp/individual_tempdir` -- ``restorecommand`` to modify the command for restore. Default setting is: :command:`xbstream -x -C` +- :strong:`restorecommand` to modify the command for restore. Default setting is: :command:`xbstream -x -C` -- ``strictIncremental``: By default (false), an incremental backup will create data, even if the Log Sequence Number (LSN) wasn’t increased since last backup. This is to ensure, that eventual changes to MYISAM tables get into the backup. MYISAM does not support incremental backups, you will always get a full bakcup of these tables. If set to true, no data will be written into backup, if the LSN wasn’t changed. +- :strong:`strictIncremental`: By default (false), an incremental backup will create data, even if the Log Sequence Number (LSN) wasn’t increased since last backup. This is to ensure, that eventual changes to MYISAM tables get into the backup. MYISAM does not support incremental backups, you will always get a full bakcup of these tables. If set to true, no data will be written into backup, if the LSN wasn’t changed. Restore ''''''' @@ -857,20 +858,20 @@ To further prepare the restored files, use the :command:`xtrabackup --prepare` c Backup of MySQL Databases using the Python MySQL plugin ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Plugin->MySQL Backup] ` +:index:`[TAG=Plugin->MySQL Backup] ` .. _backup-mysql-python: -The Python plugin from https://github.com/bareos/bareos-contrib/tree/master/fd-plugins/mysql-python makes a backup of all or selected MySQL databases from the |bareosFd| or any other MySQL server. It makes use of the mysqldump command and basically grabs data from mysqldump via pipe. This plugin is suitable to backup database dumps. If you prefer to use mechanisms like incremental hot-backups of InnoDB tables, please use the Bareos MySQL / MariaDB Percona xtrabackup Plugin (see +The Python plugin from https://github.com/bareos/bareos-contrib/tree/master/fd-plugins/mysql-python makes a backup of all or selected MySQL databases from the |fd| or any other MySQL server. It makes use of the mysqldump command and basically grabs data from mysqldump via pipe. This plugin is suitable to backup database dumps. If you prefer to use mechanisms like incremental hot-backups of InnoDB tables, please use the Bareos MySQL / MariaDB Percona xtrabackup Plugin (see :ref:`backup-mysql-xtrabackup`). -Following settings must be done on the Bareos client (|bareosFd|): +Following settings must be done on the Bareos client (|fd|): -- install and enable the |bareosFd| Python plugin +- install and enable the |fd| Python plugin -- install the Python MySQL plugin (for some platforms it is available prepackaged from ``_, on the other platforms: copy the plugin files to the Bareos Plugin Directory) +- install the Python MySQL plugin (for some platforms it is available prepackaged from http://download.bareos.org/bareos/contrib/\ , on the other platforms: copy the plugin files to the Bareos Plugin Directory) - disable bacula compatibility (default for Bareos >= 15.2) @@ -884,7 +885,7 @@ Following settings must be done on the Bareos client (|bareosFd|): compatible = no } -Configure the plugin in the |bareosDir|: +Configure the plugin in the |dir|: .. code-block:: bareosconfig :caption: bareos-dir.d/fileset/mysql.conf @@ -901,7 +902,7 @@ Configure the plugin in the |bareosDir|: } } -In the above example the plugin creates and saves a dump from the databases called :strong:`test` and :strong:`wikidb`, running on the file-daemon. The commented example below specifies an explicit MySQL server called ``dbhost``, and connects with user :strong:`bareos`, password :strong:`bareos`, to create and save a backup of all databases. +In the above example the plugin creates and saves a dump from the databases called :strong:`test` and :strong:`wikidb`, running on the file-daemon. The commented example below specifies an explicit MySQL server called :strong:`dbhost`, and connects with user :strong:`bareos`, password :strong:`bareos`, to create and save a backup of all databases. The plugin creates a pipe internally, thus no extra space on disk is needed. You will find one file per database in the backups in the virtual directory :file:`/_mysqlbackups_`. @@ -914,7 +915,7 @@ dumpbinary command (with or without full path) to create the dumps. Default: :strong:`mysqldump` dumpoptions - options for dumpbinary, default: '':strong:`--events --single-transaction`'' + options for dumpbinary, default: ":strong:`--events --single-transaction`" drop_and_recreate if not set to :strong:`false`, adds :strong:`--add-drop-database --databases` to dumpoptions @@ -933,7 +934,7 @@ On restore, the database dumps are restored to the subdirectory :file:`_mysqlbac Backup of a MySQL Database by using the RunScript directive ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=RunScript->Example] ` +:index:`[TAG=RunScript->Example] ` One method to backup a MySQL database is to use the :command:`mysqldump` tool to dump the database into a file and then backup it as a normal file. After the backup, the file can be removed. It may also be an option not to remove it, so that the latest version is always available immediately. On the next job run it will be overwritten anyway. @@ -983,7 +984,7 @@ Note that redirecting the :command:`mysqldump` output to a file requires to run Backup of a MySQL Database by using the bpipe plugin ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=bpipe->MySQL backup] ` +:index:`[TAG=bpipe->MySQL backup] ` Instead of creating a temporary database dump file, the bpipe plugin can be used. For general information about bpipe, see the :ref:`bpipe` section. The bpipe plugin is configured inside the Include section of a File Set, e.g.: @@ -1047,9 +1048,9 @@ A very simple corresponding shell script (:command:`bpipe-restore.sh`) to the me Statistics Collection --------------------- -Statistics Collection can be controlled by a number of configuration directives. If Statistics Collection is enabled, statistics are collected by the |bareosDir| and stored into the Catalog database. So enabling this feature will increase your database size. +Statistics Collection can be controlled by a number of configuration directives. If Statistics Collection is enabled, statistics are collected by the |dir| and stored into the Catalog database. So enabling this feature will increase your database size. -The Statistics are used by the |bareosWebui| to show the status of a running job. :index:`[TAG=Webui->Configure Statistics Collection] ` +The Statistics are used by the |webui| to show the status of a running job. :index:`[TAG=Webui->Configure Statistics Collection] ` Director Configuration - Director Resource Directives ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1121,8 +1122,9 @@ Removing the client from the configuration will leave you with catalog records c - .. warning:: - + .. warning:: + + After removing the job and file records you will be unable to restore the client's data. The :bcommand:`purge` command ignores retention policies, so please take careful. diff --git a/docs/manuals/en/new_main_reference/source/Appendix/OperatingSystems.rst b/docs/manuals/en/new_main_reference/source/Appendix/OperatingSystems.rst index 5b6bdd102da..5b245ea8877 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/OperatingSystems.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/OperatingSystems.rst @@ -3,7 +3,7 @@ Operating Systems ================= -:index:`[TAG=Systems->Supported Operating Systems] ` :index:`[TAG=Support->Operating Systems] ` +:index:`[TAG=Systems->Supported Operating Systems] ` :index:`[TAG=Support->Operating Systems] ` The Bareos project provides and supports packages that have been released at http://download.bareos.org/bareos/release/ @@ -18,10 +18,10 @@ However, the following tabular gives an overview, what components are expected o :strong:`Operating Systems` & :strong:`Version` & :strong:`Client Daemon` & :strong:`Director Daemon` & :strong:`Storage Daemon` \\ \hline \hline - :strong:`:strong:`Linux`` :index:`[TAG=Platform->Linux] ` \\ + :strong:`:strong:`Linux`` :index:`[TAG=Platform->Linux] ` \\ \hline Arch Linux - :index:`[TAG=Platform->Arch Linux] ` + :index:`[TAG=Platform->Arch Linux] ` & ~ & `X `_ & `X `_ & `X `_ \\ \hline CentOS & current & v12.4 & v12.4 & v12.4 \\ @@ -31,7 +31,7 @@ However, the following tabular gives an overview, what components are expected o Fedora & current & v12.4 & v12.4 & v12.4 \\ \hline Gentoo - :index:`[TAG=Platform->Gentoo] ` + :index:`[TAG=Platform->Gentoo] ` & ~ & `X `_ & `X `_ & `X `_ \\ \hline openSUSE & current & v12.4 & v12.4 & v12.4 \\ @@ -60,7 +60,7 @@ However, the following tabular gives an overview, what components are expected o :strong:`:strong:`BSD`` \\ \hline FreeBSD - :index:`[TAG=Platform->FreeBSD] ` + :index:`[TAG=Platform->FreeBSD] ` & >= 5.0 & `X `_ & `X `_ & `X `_ \\ \hline OpenBSD & ~ & X & & ~ \\ @@ -72,11 +72,11 @@ However, the following tabular gives an overview, what components are expected o %BSDI & ~ & * & ~ & ~ \\ \hline AIX - :index:`[TAG=Platform->AIX] ` + :index:`[TAG=Platform->AIX] ` & >= 4.3 & com-13.2 & * & * \\ \hline HP-UX - :index:`[TAG=Platform->HP-UX] ` + :index:`[TAG=Platform->HP-UX] ` & ~ & com-13.2 & ~ & ~ \\ \hline Irix & ~ & * & ~ & ~ \\ @@ -84,7 +84,7 @@ However, the following tabular gives an overview, what components are expected o %OpenSolaris & ~ & X & X & X \\ \hline Solaris - :index:`[TAG=Platform->Solaris] ` + :index:`[TAG=Platform->Solaris] ` & >= 8 & com-12.4 & com-12.4 & com-12.4 \\ \hline True64 & ~ & * & ~ & ~ \\ @@ -96,12 +96,12 @@ However, the following tabular gives an overview, what components are expected o ============================================================================================ =========== ============================================================================= ============================================================================= ============================================================================= **Operating Systems** **Version** **Client Daemon** **Director Daemon** **Storage Daemon** ============================================================================================ =========== ============================================================================= ============================================================================= ============================================================================= -:strong:`:strong:`Linux`` :index:`[TAG=Platform->Linux] ` -Arch Linux :index:`[TAG=Platform->Arch Linux] `   `X `_ `X `_ `X `_ +:strong:`:strong:`Linux`` :index:`[TAG=Platform->Linux] ` +Arch Linux :index:`[TAG=Platform->Arch Linux] `   `X `_ `X `_ `X `_ CentOS current v12.4 v12.4 v12.4 Debian current v12.4 v12.4 v12.4 Fedora current v12.4 v12.4 v12.4 -Gentoo :index:`[TAG=Platform->Gentoo] `   `X `_ `X `_ `X `_ +Gentoo :index:`[TAG=Platform->Gentoo] `   `X `_ `X `_ `X `_ openSUSE current v12.4 v12.4 v12.4 RHEL current v12.4 v12.4 v12.4 SLES current v12.4 v12.4 v12.4 @@ -116,14 +116,14 @@ Ubuntu :strong:`:strong:`Mac OS`` :ref:`Mac OS X/Darwin `   v14.2 :strong:`:strong:`BSD`` -FreeBSD :index:`[TAG=Platform->FreeBSD] ` >= 5.0 `X `_ `X `_ `X `_ +FreeBSD :index:`[TAG=Platform->FreeBSD] ` >= 5.0 `X `_ `X `_ `X `_ OpenBSD   X   NetBSD   X   :strong:`:strong:`Unix`` -AIX :index:`[TAG=Platform->AIX] ` >= 4.3 com-13.2 \* \* -HP-UX :index:`[TAG=Platform->HP-UX] `   com-13.2     +AIX :index:`[TAG=Platform->AIX] ` >= 4.3 com-13.2 \* \* +HP-UX :index:`[TAG=Platform->HP-UX] `   com-13.2     Irix   \*     -Solaris :index:`[TAG=Platform->Solaris] ` >= 8 com-12.4 com-12.4 com-12.4 +Solaris :index:`[TAG=Platform->Solaris] ` >= 8 com-12.4 com-12.4 com-12.4 True64   \*     ============================================================================================ =========== ============================================================================= ============================================================================= ============================================================================= @@ -171,7 +171,7 @@ Packages names not containing the word **bareos** are required packages where we -:index:`[TAG=Platform->CentOS->5] `:index:`[TAG=Platform->CentOS->6] `:index:`[TAG=Platform->CentOS->7] `:index:`[TAG=Platform->RHEL->4] `:index:`[TAG=Platform->RHEL->5] `:index:`[TAG=Platform->RHEL->6] `:index:`[TAG=Platform->RHEL->7] ` +:index:`[TAG=Platform->CentOS->5] `:index:`[TAG=Platform->CentOS->6] `:index:`[TAG=Platform->CentOS->7] `:index:`[TAG=Platform->RHEL->4] `:index:`[TAG=Platform->RHEL->5] `:index:`[TAG=Platform->RHEL->6] `:index:`[TAG=Platform->RHEL->7] ` # Tabular in LaTex format (original) @@ -268,7 +268,7 @@ Packages names not containing the word **bareos** are required packages where we **python-bareos** 17.2 17.2 17.2 17.2 17.2 =========================================================== ========================================= ============================= ========= ========= ========= ========= ========= -:index:`[TAG=Platform->Fedora->20] `:index:`[TAG=Platform->Fedora->21] `:index:`[TAG=Platform->Fedora->22] `:index:`[TAG=Platform->Fedora->23] `:index:`[TAG=Platform->Fedora->24] `:index:`[TAG=Platform->Fedora->25] `:index:`[TAG=Platform->Fedora->26] `:index:`[TAG=Platform->Fedora->27] ` +:index:`[TAG=Platform->Fedora->20] `:index:`[TAG=Platform->Fedora->21] `:index:`[TAG=Platform->Fedora->22] `:index:`[TAG=Platform->Fedora->23] `:index:`[TAG=Platform->Fedora->24] `:index:`[TAG=Platform->Fedora->25] `:index:`[TAG=Platform->Fedora->26] `:index:`[TAG=Platform->Fedora->27] ` # Tabular in LaTex format (original) @@ -348,7 +348,7 @@ Packages names not containing the word **bareos** are required packages where we **python-bareos** 17.2 17.2 17.2 =========================================================== =============================== ========= ==== ========= ==== ==== ==== ==== -:index:`[TAG=Platform->SLES->10sp4] `:index:`[TAG=Platform->SLES->11sp4] `:index:`[TAG=Platform->SLES->12sp1] `:index:`[TAG=Platform->SLES->12sp2] `:index:`[TAG=Platform->SLES->12sp3] ` +:index:`[TAG=Platform->SLES->10sp4] `:index:`[TAG=Platform->SLES->11sp4] `:index:`[TAG=Platform->SLES->12sp1] `:index:`[TAG=Platform->SLES->12sp2] `:index:`[TAG=Platform->SLES->12sp3] ` # Tabular in LaTex format (original) @@ -452,7 +452,7 @@ Packages names not containing the word **bareos** are required packages where we **python-six** 15.2-16.2 =========================================================== ============================= ========= ========= ===== ===== -:index:`[TAG=Platform->openSUSE->13.1] `:index:`[TAG=Platform->openSUSE->13.2] `:index:`[TAG=Platform->openSUSE->42.1] `:index:`[TAG=Platform->openSUSE->42.2] `:index:`[TAG=Platform->openSUSE->42.3] ` +:index:`[TAG=Platform->openSUSE->13.1] `:index:`[TAG=Platform->openSUSE->13.2] `:index:`[TAG=Platform->openSUSE->42.1] `:index:`[TAG=Platform->openSUSE->42.2] `:index:`[TAG=Platform->openSUSE->42.3] ` # Tabular in LaTex format (original) @@ -532,7 +532,7 @@ Packages names not containing the word **bareos** are required packages where we **python-bareos** 17.2 17.2 =========================================================== ================================= ========= ========= ==== ==== -:index:`[TAG=Platform->Debian->6] `:index:`[TAG=Platform->Debian->7] `:index:`[TAG=Platform->Debian->8] `:index:`[TAG=Platform->Debian->9] `:index:`[TAG=Platform->Univention->4.0] `:index:`[TAG=Platform->Univention->4.2] ` +:index:`[TAG=Platform->Debian->6] `:index:`[TAG=Platform->Debian->7] `:index:`[TAG=Platform->Debian->8] `:index:`[TAG=Platform->Debian->9] `:index:`[TAG=Platform->Univention->4.0] `:index:`[TAG=Platform->Univention->4.2] ` # Tabular in LaTex format (original) @@ -629,7 +629,7 @@ Packages names not containing the word **bareos** are required packages where we **univention-bareos** 15.2-16.2 17.2 =========================================================== ========================================= =================================== ========= ==== ========= ==== -:index:`[TAG=Platform->Ubuntu->10.04] `:index:`[TAG=Platform->Ubuntu->12.04] `:index:`[TAG=Platform->Ubuntu->14.04] `:index:`[TAG=Platform->Ubuntu->16.04] `:index:`[TAG=Platform->Ubuntu->8.04] ` +:index:`[TAG=Platform->Ubuntu->10.04] `:index:`[TAG=Platform->Ubuntu->12.04] `:index:`[TAG=Platform->Ubuntu->14.04] `:index:`[TAG=Platform->Ubuntu->16.04] `:index:`[TAG=Platform->Ubuntu->8.04] ` # Tabular in LaTex format (original) @@ -726,7 +726,7 @@ Packages names not containing the word **bareos** are required packages where we Univention Corporate Server ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Platform->Univention Corporate Server|see {Platform, Univention}] ` :os:`Univention` The Bareos version for the Univention App Center integraties into the Univention Enterprise Linux environment, making it easy to backup all the systems managed by the central Univention Corporate Server. +:index:`[TAG=Platform->Univention Corporate Server|see {Platform, Univention}] ` :os:`Univention` The Bareos version for the Univention App Center integraties into the Univention Enterprise Linux environment, making it easy to backup all the systems managed by the central Univention Corporate Server. Preamble ^^^^^^^^ @@ -739,8 +739,9 @@ The Bareos Univention App is shipped with a default configuration for the direct -.. warning:: - You need to review some Univention configuration registry (UCR) variables. Most likely, you will want to set the location where the backups are stored. Otherwise, you may quickly run out of disk space on your backup server! + .. warning:: + + You need to review some Univention configuration registry (UCR) variables. Most likely, you will want to set the location where the backups are stored. Otherwise, you may quickly run out of disk space on your backup server! You will find further information under :ref:`section-UniventionBackupStorage`. @@ -749,7 +750,7 @@ Quick Start - Determine the space requirements and where to store your backup data -- Set the ``bareos/*`` UCR variables according to your needs, see :ref:`section-UCR` +- Set the :strong:`bareos/*` UCR variables according to your needs, see :ref:`section-UCR` - Restart :command:`bareos-dir`, :command:`bareos-sd` and :command:`bareos-fd` (or simply reboot the server) @@ -770,42 +771,42 @@ Quick Start UCR variables ^^^^^^^^^^^^^ -``bareos/filestorage`` +:strong:`bareos/filestorage` : /var/lib/bareos/storage (default) - Location where to store the backup files. Make sure, it offers enough disk space for a configured backup volumes. -``bareos/max_full_volume_bytes`` +:strong:`bareos/max_full_volume_bytes` : 20 (default) - Maximum size (in GB) of a volume for the :config:option:`dir/pool = Full`\ backup pool -``bareos/max_full_volumes`` +:strong:`bareos/max_full_volumes` : 1 (default) - Maximum number of volumes for the :config:option:`dir/pool = Full`\ backup pool -``bareos/max_diff_volume_bytes`` +:strong:`bareos/max_diff_volume_bytes` : 10 (default) - Maximum size (in GB) of a volume for the :config:option:`dir/pool = Differential`\ backup pool -``bareos/max_diff_volumes`` +:strong:`bareos/max_diff_volumes` : 1 (default) - Maximum number of volumes for the :config:option:`dir/pool = Differential`\ backup pool -``bareos/max_incr_volume_bytes`` +:strong:`bareos/max_incr_volume_bytes` : 1 (default) - Maximum size (in GB) of a volume for the :config:option:`dir/pool = Incremental`\ backup pool -``bareos/max_incr_volumes`` +:strong:`bareos/max_incr_volumes` : 1 (default) - Maximum number of volumes for the :config:option:`dir/pool = Incremental`\ backup pool -``bareos/backup_myself`` +:strong:`bareos/backup_myself` : no (default) no @@ -814,12 +815,12 @@ UCR variables yes backup the server itself -``bareos/webui/console/user1/username`` +:strong:`bareos/webui/console/user1/username` : Administrator (default) - User name to login at the bareos-webui -``bareos/webui/console/user1/password`` +:strong:`bareos/webui/console/user1/password` : (no default value) - Password to login at the bareos-webui @@ -833,7 +834,7 @@ UCR variables can be set via the Univention Configuration Registry Web interface or using the :command:`ucr` command line tool: -.. code-block:: sh +.. code-block:: shell-session :caption: Enable backup of the server itself root@ucs:~# ucr set bareos/backup_myself=yes @@ -843,10 +844,11 @@ or using the :command:`ucr` command line tool: -.. warning:: - univention-bareos < 15.2 did require a manual reload/restart of the bareos-dir service: + .. warning:: + + univention-bareos < 15.2 did require a manual reload/restart of the bareos-dir service: -.. code-block:: sh +.. code-block:: shell-session :caption: let bareos-dir reload its configuration root@ucs:~# service bareos-dir reload @@ -859,14 +861,14 @@ After installation of the Bareos app, Bareos is ready for operation. A default c Bareos consists of three daemons called :command:`director` (or :command:`bareos-dir`), :command:`storage-daemon` (or :command:`bareos-sd`) and :command:`filedaemon` (or :command:`bareos-fd`). All three daemons are started right after the installation by the Univention App Center. -If you want to enable automatic backups of the server, you need to set the Univention configuration registry (UCR) variable ``bareos/backup_myself`` to :strong:`yes` and reload the director daemon. +If you want to enable automatic backups of the server, you need to set the Univention configuration registry (UCR) variable :strong:`bareos/backup_myself` to :strong:`yes` and reload the director daemon. Administration ^^^^^^^^^^^^^^ For general tasks the :ref:`bareos-webui ` can be used. Additional, there is the :command:`bconsole` command line tool: -.. code-block:: sh +.. code-block:: shell-session :caption: Starting the bconsole root@ucs:~# bconsole @@ -918,7 +920,7 @@ The default configuration uses three different pools, called :config:option:`dir If you change the UCR variables, the configuration files will be rewritten automatically. After each change you will need to reload the director daemon. -.. code-block:: sh +.. code-block:: shell-session :caption: Example for changing the Full pool size to $10 \ast 20$ GB root@ucs:~# ucr set bareos/max_full_volumes=10 @@ -932,8 +934,9 @@ If you change the UCR variables, the configuration files will be rewritten autom -.. warning:: - This only affects new volumes. Existing volumes will not change there size. + .. warning:: + + This only affects new volumes. Existing volumes will not change there size. .. _section-UniventionBackupStorage: @@ -942,14 +945,15 @@ Backup Storage -.. warning:: - Using the default configuration, Bareos will store backups on your local disk. You may want to store the data to another location to avoid using up all of your disk space. + .. warning:: + + Using the default configuration, Bareos will store backups on your local disk. You may want to store the data to another location to avoid using up all of your disk space. The location for backups is :file:`/var/lib/bareos/storage` in the default configuration. -For example, to use a NAS device for storing backups, you can mount your NAS volume via NFS on :file:`/var/lib/bareos/storage`. Alternatively, you can mount the NAS volume to another directory of your own choice, and change the UCR variable ``bareos/filestorage`` to the corresponding path. The directory needs to be writable by user **bareos**. +For example, to use a NAS device for storing backups, you can mount your NAS volume via NFS on :file:`/var/lib/bareos/storage`. Alternatively, you can mount the NAS volume to another directory of your own choice, and change the UCR variable :strong:`bareos/filestorage` to the corresponding path. The directory needs to be writable by user **bareos**. -.. code-block:: sh +.. code-block:: shell-session :caption: Example for changing the storage path root@ucs:/etc/bareos# ucr set bareos/filestorage=/path/to/your/storage @@ -958,21 +962,22 @@ For example, to use a NAS device for storing backups, you can mount your NAS vol -.. warning:: - You need to restart the Bareos storage daemon after having changed the storage path: + .. warning:: + + You need to restart the Bareos storage daemon after having changed the storage path: -.. code-block:: sh +.. code-block:: shell-session root@ucs:/# service bareos-sd restart Bareos Webui Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^ -After installation you just need to setup your login credentials via UCR variables. Therefore, set the Univention configuration registry (UCR) variable ``bareos/webui/console/user1/username`` and ``bareos/webui/consoles/user1/password`` according to your needs. The director configuration is automatically reloaded if one of those two variables changes. +After installation you just need to setup your login credentials via UCR variables. Therefore, set the Univention configuration registry (UCR) variable :strong:`bareos/webui/console/user1/username` and :strong:`bareos/webui/consoles/user1/password` according to your needs. The director configuration is automatically reloaded if one of those two variables changes. Alternatively you can also set those UCR variables via commandline. -.. code-block:: sh +.. code-block:: shell-session :caption: Example for changing webui login credentials root@ucs:~# ucr set bareos/webui/console/user1/username="bareos" @@ -1035,7 +1040,7 @@ Generated configuration files under :file:`/etc/bareos/bareos-dir-export/client/ - on Windows: :file:`C:\Program Files\Bareos\bareos-fd.d/director/` -.. code-block:: sh +.. code-block:: shell-session :caption: copy client configuration from the server to the testw1.example.com client (Linux) root@ucs:~# CLIENTNAME=testw1.example.com @@ -1062,7 +1067,7 @@ If you disable the Bareos backup for a client, the client will not be removed fr If you add three client, your client directory will look similar to this: -.. code-block:: sh +.. code-block:: shell-session root@ucs:/etc/bareos/autogenerated/clients# ls -l -rw-r--r-- 1 root root 430 16. Mai 15:15 generic.template @@ -1073,7 +1078,7 @@ If you add three client, your client directory will look similar to this: The client configuration file contains, as you can see below, the client connection and the job information: -.. code-block:: sh +.. code-block:: shell-session root@ucs:/etc/bareos/autogenerated/clients# cat testw2.example.com.include Client { @@ -1110,7 +1115,7 @@ Here the files intended for the target systems are generated under :file:`/etc/b - on Windows: :file:`C:\Program Files\Bareos\bareos-fd.conf` -.. code-block:: sh +.. code-block:: shell-session :caption: copy client configuration from the server to the testw1.example.com client (Linux) root@ucs:~# CLIENTNAME=testw1.example.com @@ -1119,7 +1124,7 @@ Here the files intended for the target systems are generated under :file:`/etc/b Debian.org / Ubuntu Universe ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Platform->Debian->Debian.org] ` :index:`[TAG=Platform->Debian->8] ` :index:`[TAG=Platform->Ubuntu->Universe] ` \index[general]{Platform!Ubuntu!Universe!15.04} +:index:`[TAG=Platform->Debian->Debian.org] ` :index:`[TAG=Platform->Debian->8] ` :index:`[TAG=Platform->Ubuntu->Universe] ` :index:`[TAG=Platform->Ubuntu->Universe->15.04] ` .. _section-DebianOrg: @@ -1134,7 +1139,7 @@ In the further text, these version will be named **Bareos (Debian.org)** (also f Limitations of the Debian.org/Ubuntu Universe version of Bareos ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -- Debian.org does not include the libfastlz compression library and therefore the Bareos (Debian.org) packages do not offer the fileset options ``compression=LZFAST``, ``compression=LZ4`` and ``compression=LZ4HC``. +- Debian.org does not include the libfastlz compression library and therefore the Bareos (Debian.org) packages do not offer the fileset options :strong:`compression=LZFAST`, :strong:`compression=LZ4` and :strong:`compression=LZ4HC`. - Debian.org does not include the **bareos-webui** package. @@ -1143,7 +1148,7 @@ Limitations of the Debian.org/Ubuntu Universe version of Bareos Mac OS X -------- -:index:`[TAG=Platform->Mac->OS X] ` +:index:`[TAG=Platform->Mac->OS X] ` Bareos for MacOS X is available either @@ -1153,27 +1158,27 @@ Bareos for MacOS X is available either However, you have to choose upfront, which client you want to use. Otherwise conflicts do occur. -Both packages contain the |bareosFd| and :command:`bconsole`. +Both packages contain the |fd| and :command:`bconsole`. Installing the Bareos Client as PKG ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Installation->MacOS] ` +:index:`[TAG=Installation->MacOS] ` -The Bareos installer package for Mac OS X contains the |bareosFd| for Mac OS X 10.5 or later. +The Bareos installer package for Mac OS X contains the |fd| for Mac OS X 10.5 or later. On your local Mac, you must be an admin user. The main user is an admin user. Download the :file:`bareos-client*.pkg` installer package from http://download.bareos.org/bareos/release/latest/MacOS/. -Find the .pkg you just downloaded. Install the .pkg by holding the CTRL key, left-clicking the installer and choosing ''open''. +Find the .pkg you just downloaded. Install the .pkg by holding the CTRL key, left-clicking the installer and choosing "open". Follow the directions given to you and finish the installation. Configuration ~~~~~~~~~~~~~ -To make use of your |bareosFd| on your system, it is required to configure the |bareosDir| and the local |bareosFd|. +To make use of your |fd| on your system, it is required to configure the |dir| and the local |fd|. Configure the server-side by follow the instructions at :ref:`section-AddAClient`. @@ -1182,9 +1187,9 @@ After configuring the server-side you can either transfer the necessary configur Option 1: Copy the director resource from the Bareos Director to the Client ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Assuming your client has the DNS entry :strong:`client2.example.com` and has been added to |bareosDir| as :config:option:`bareos-dir/client = client2-fd`\ : +Assuming your client has the DNS entry :strong:`client2.example.com` and has been added to |dir| as :config:option:`bareos-dir/client = client2-fd`\ : -.. code-block:: sh +.. code-block:: shell-session scp /etc/bareos/bareos-dir-export/client/client2-fd/bareos-fd.d/director/bareos-dir.conf root@client2.example.com:/usr/local/etc/bareos/bareos-fd.d/director/ @@ -1195,13 +1200,13 @@ Option 2: Edit the director resource on the Client Alternatively, you can edit the file :file:`/usr/local/etc/bareos/bareos-fd.d/director/bareos-dir.conf`. -This can be done by right-clicking the finder icon in your task bar, select ''Go to folder ...'' and paste :file:`/usr/local/etc/bareos/bareos-fd.d/director/`. +This can be done by right-clicking the finder icon in your task bar, select "Go to folder ..." and paste :file:`/usr/local/etc/bareos/bareos-fd.d/director/`. Select the :file:`bareos-dir.conf` file and open it. Alternatively you can also call following command on the command console: -.. code-block:: sh +.. code-block:: shell-session open -t /usr/local/etc/bareos/bareos-fd.d/director/bareos-dir.conf @@ -1220,16 +1225,17 @@ Set this client-side password to the same value as given on the server-side. -.. warning:: - The configuration file contains passwords and therefore must not be accessible for any users except admin users. + .. warning:: + + The configuration file contains passwords and therefore must not be accessible for any users except admin users. Restart bareos-fd after changing the configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The bareos-fd must be restarted to reread its configuration: -.. code-block:: sh - :caption: Restart the |bareosFd| +.. code-block:: shell-session + :caption: Restart the |fd| sudo launchctl stop org.bareos.bareos-fd sudo launchctl start org.bareos.bareos-fd @@ -1237,7 +1243,7 @@ The bareos-fd must be restarted to reread its configuration: Verify that the Bareos File Daemon is working ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Open the :command:`bconsole` on your |bareosDir| and check the status of the client with +Open the :command:`bconsole` on your |dir| and check the status of the client with .. code-block:: bareosconfig @@ -1245,8 +1251,8 @@ Open the :command:`bconsole` on your |bareosDir| and check the status of the cli In case, the client does not react, following command are useful the check the status: -.. code-block:: sh - :caption: Verify the status of |bareosFd| +.. code-block:: shell-session + :caption: Verify the status of |fd| # check if bareos-fd is started by system: sudo launchctl list org.bareos.bareos-fd @@ -1257,13 +1263,13 @@ In case, the client does not react, following command are useful the check the s # show files opened by bareos-fd sudo lsof -p `pgrep bareos-fd` - # check what process is listening on the |bareosFd| port + # check what process is listening on the |fd| port sudo lsof -n -iTCP:9102 | grep LISTEN You can also manually start bareos-fd in debug mode by: -.. code-block:: sh - :caption: Start |bareosFd| in debug mode +.. code-block:: shell-session + :caption: Start |fd| in debug mode sudo /usr/local/sbin/bareos-fd -f -d 100 diff --git a/docs/manuals/en/new_main_reference/source/Appendix/ReleaseNotes.rst b/docs/manuals/en/new_main_reference/source/Appendix/ReleaseNotes.rst index 25485e5a7a3..8e650d8926a 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/ReleaseNotes.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/ReleaseNotes.rst @@ -17,16 +17,19 @@ This chapter concentrates on things to do when updating an existing Bareos insta -.. warning:: - While all the source code is published on `GitHub `_, the releases of packages on ``_ is limited to the initial versions of a major release. Later maintenance releases are only published on ``_. + .. warning:: + + While all the source code is published on `GitHub `_, the releases of packages on http://download.bareos.org is limited to the initial versions of a major release. Later maintenance releases are only published on https://download.bareos.com. Bareos-17.2 ----------- +.. _bareos-17.2.7: + bareos-17.2.7 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-17.2.7->Release Notes] ` +:index:`[TAG=bareos-17.2.7->Release Notes] ` # Tabular in LaTex format (original) @@ -36,7 +39,7 @@ bareos-17.2.7 Code Release & 2018-07-13\\ Database Version & 2171 (unchanged)\\ Release Ticket & :ticket:`966`\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/17.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -45,7 +48,7 @@ bareos-17.2.7 Code Release 2018-07-13 Database Version 2171 (unchanged) Release Ticket :ticket:`966` -Url ``_ +Url http://download.bareos.com/bareos/release/17.2/ ================ =============================================== This release contains several bugfixes and enhancements. Excerpt: @@ -56,14 +59,16 @@ This release contains several bugfixes and enhancements. Excerpt: - :ticket:`967` :os:`Windows`: overwrite symbolic links on restore. -- :ticket:`983` |bareosSd|: prevent sporadic crash when :config:option:`sd/storage/CollectJobStatistics = yes`\ . +- :ticket:`983` |sd|: prevent sporadic crash when :config:option:`sd/storage/CollectJobStatistics = yes`\ . - :os:`SLES 12sp2` and :os:`SLES 12sp3`: provide **bareos-storage-ceph** and **bareos-filedaemon-ceph-plugin** packages. +.. _bareos-17.2.6: + bareos-17.2.6 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-17.2.6->Release Notes] ` +:index:`[TAG=bareos-17.2.6->Release Notes] ` # Tabular in LaTex format (original) @@ -73,7 +78,7 @@ bareos-17.2.6 Code Release & 2018-06-21\\ Database Version & 2171 (unchanged)\\ Release Ticket & :ticket:`916`\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/17.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -82,7 +87,7 @@ bareos-17.2.6 Code Release 2018-06-21 Database Version 2171 (unchanged) Release Ticket :ticket:`916` -Url ``_ +Url http://download.bareos.com/bareos/release/17.2/ ================ =============================================== This release contains several bugfixes and enhancements. Excerpt: @@ -97,9 +102,9 @@ This release contains several bugfixes and enhancements. Excerpt: - :ticket:`964` fixes the predefined queries. -- :ticket:`969` fixes a problem of restoring more files then selected in |bareosWebui|/BVFS. +- :ticket:`969` fixes a problem of restoring more files then selected in |webui|/BVFS. -- |bareosDir|: fixes for a crash after reload in the statistics thread (:ticket:`695`, :ticket:`903`). +- |dir|: fixes for a crash after reload in the statistics thread (:ticket:`695`, :ticket:`903`). - :command:`bareos-dbcheck`: cleanup and speedup for some some of the checks. @@ -107,10 +112,12 @@ This release contains several bugfixes and enhancements. Excerpt: - gfapi: stale file handles are treated as warnings +.. _bareos-17.2.5: + bareos-17.2.5 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-17.2.5->Release Notes] ` +:index:`[TAG=bareos-17.2.5->Release Notes] ` # Tabular in LaTex format (original) @@ -120,7 +127,7 @@ bareos-17.2.5 Code Release & 2018-02-16\\ Database Version & 2171 (unchanged)\\ Release Ticket & :ticket:`910`\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/17.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -129,12 +136,12 @@ bareos-17.2.5 Code Release 2018-02-16 Database Version 2171 (unchanged) Release Ticket :ticket:`910` -Url ``_ +Url http://download.bareos.com/bareos/release/17.2/ ================ =============================================== This release contains several bugfixes and enhancements. Excerpt: -- |bareosFd| is ready for :os:`AIX 7.1.0.0`. +- |fd| is ready for :os:`AIX 7.1.0.0`. - :ref:`VMwarePlugin` is also provided for :os:`Debian 9`. @@ -156,7 +163,7 @@ This release contains several bugfixes and enhancements. Excerpt: - :ticket:`895` added description to the output of :bcommand:`show filesets`. -- |bareosWebui|: Restore Browser fixes +- |webui|: Restore Browser fixes - There was the possibility of an endless loop if the BVFS API delivers unexpected results. This has been fixed. See bugreports :ticket:`887` and :ticket:`893` for details. @@ -164,10 +171,12 @@ This release contains several bugfixes and enhancements. Excerpt: - :config:option:`dir/client/NdmpBlockSize`\ changed type from :strong:`Pint32` to :strong:`Size32`. This should not affect any configuration, but is more consistent with other block size configuration directives. +.. _bareos-17.2.4: + bareos-17.2.4 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-17.2.4->Release Notes] ` +:index:`[TAG=bareos-17.2.4->Release Notes] ` # Tabular in LaTex format (original) @@ -177,8 +186,8 @@ bareos-17.2.4 Code Release & 2017-12-14\\ Database Version & 2171\\ Release Ticket & :ticket:`861`\\ - Url & ``_ \\ - & ``_ \\ + Url & http://download.bareos.org/bareos/release/17.2/ \\ + & http://download.bareos.com/bareos/release/17.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -187,8 +196,8 @@ bareos-17.2.4 Code Release 2017-12-14 Database Version 2171 Release Ticket :ticket:`861` -Url ``_ -\ ``_ +Url http://download.bareos.org/bareos/release/17.2/ +\ http://download.bareos.com/bareos/release/17.2/ ================ =============================================== This release contains several enhancements. Excerpt: @@ -207,7 +216,7 @@ This release contains several enhancements. Excerpt: - MacOS: added to build chain. - - |bareosFd| is ready for HP-UX 11.31 (ia64). + - |fd| is ready for HP-UX 11.31 (ia64). - Linux Distribution: Bareos tries to provide packages for all current platforms. For details, refer to :ref:`section-packages`. @@ -219,11 +228,12 @@ This release contains several enhancements. Excerpt: - For the denormalization the database schema must be modified. - .. warning:: - Updating the database to schema version >= 2170 will increase the required disk space. +.. warning:: + + Updating the database to schema version >= 2170 will increase the required disk space. Especially it will require around twice the amount of the current database disk space during the migration. - - The **Filename** database table does no longer exists. Therefore the :bcommand:`.bvfs_*` commands do no longer output the \dbcolumn{FilenameId} column. + - The **Filename** database table does no longer exists. Therefore the :bcommand:`.bvfs_*` commands do no longer output the **FilenameId** column. - NDMP_NATIVE support has been added. This include the NDMP features DAR and DDAR. For details see :ref:`section-NdmpNative`. @@ -254,10 +264,12 @@ This release contains several enhancements. Excerpt: Bareos-16.2 ----------- +.. _bareos-16.2.8: + bareos-16.2.8 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-16.2.8->Release Notes] ` +:index:`[TAG=bareos-16.2.8->Release Notes] ` # Tabular in LaTex format (original) @@ -267,7 +279,7 @@ bareos-16.2.8 Code Release & 2018-07-06\\ Database Version & 2004 (unchanged)\\ Release Ticket & :ticket:`863`\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/16.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -276,7 +288,7 @@ bareos-16.2.8 Code Release 2018-07-06 Database Version 2004 (unchanged) Release Ticket :ticket:`863` -Url ``_ +Url http://download.bareos.com/bareos/release/16.2/ ================ =============================================== This release contains several bugfixes and enhancements. Excerpt: @@ -301,10 +313,12 @@ This release contains several bugfixes and enhancements. Excerpt: - :ticket:`967` Windows: Symbolic links are now replaceable during restore +.. _bareos-16.2.7: + bareos-16.2.7 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-16.2.7->Release Notes] ` +:index:`[TAG=bareos-16.2.7->Release Notes] ` # Tabular in LaTex format (original) @@ -314,7 +328,7 @@ bareos-16.2.7 Code Release & 2017-10-09\\ Database Version & 2004 (unchanged)\\ Release Ticket & :ticket:`836`\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/16.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -323,7 +337,7 @@ bareos-16.2.7 Code Release 2017-10-09 Database Version 2004 (unchanged) Release Ticket :ticket:`836` -Url ``_ +Url http://download.bareos.com/bareos/release/16.2/ ================ =============================================== This release contains several bugfixes and enhancements. Excerpt: @@ -338,19 +352,19 @@ This release contains several bugfixes and enhancements. Excerpt: - - \sqlcommand{CREATE INDEX file_jpfnidpart_idx ON File(PathId,JobId,FilenameId) WHERE FileIndex = 0;} + ``CREATE INDEX file_jpfnidpart_idx ON File(PathId,JobId,FilenameId) WHERE FileIndex = 0;`` - - | If the index \sqlcommand{file_jfnidpart_idx} mentioned in 16.2.6 release notes exist, drop it: - | \sqlcommand{DROP INDEX file_jfnidpart_idx;} + - | If the index ``file_jfnidpart_idx`` mentioned in 16.2.6 release notes exist, drop it: + | ``DROP INDEX file_jfnidpart_idx;`` - MySQL/MariaDB - - \sqlcommand{CREATE INDEX PathId_JobId_FileNameId_FileIndex ON File(PathId,JobId,FilenameId,FileIndex);} + ``CREATE INDEX PathId_JobId_FileNameId_FileIndex ON File(PathId,JobId,FilenameId,FileIndex);`` - - | If the index \sqlcommand{PathId_JobId_FileIndex_FileNameId} mentioned in 16.2.6 release notes exist, drop it: - | \sqlcommand{DROP INDEX PathId_JobId_FileIndex_FileNameId ON File;} + - | If the index ``PathId_JobId_FileIndex_FileNameId`` mentioned in 16.2.6 release notes exist, drop it: + | ``DROP INDEX PathId_JobId_FileIndex_FileNameId ON File;`` - Utilize OpenSSL >= 1.1 if available @@ -364,10 +378,12 @@ This release contains several bugfixes and enhancements. Excerpt: - Packages for AIX and current HP-UX 11.31 +.. _bareos-16.2.6: + bareos-16.2.6 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-16.2.6->Release Notes] ` +:index:`[TAG=bareos-16.2.6->Release Notes] ` # Tabular in LaTex format (original) @@ -377,7 +393,7 @@ bareos-16.2.6 Code Release & 2017-06-22\\ Database Version & 2004 (unchanged)\\ Release Ticket & :ticket:`794`\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/16.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -386,7 +402,7 @@ bareos-16.2.6 Code Release 2017-06-22 Database Version 2004 (unchanged) Release Ticket :ticket:`794` -Url ``_ +Url http://download.bareos.com/bareos/release/16.2/ ================ =============================================== This release contains several bugfixes and enhancements. Excerpt: @@ -397,7 +413,7 @@ This release contains several bugfixes and enhancements. Excerpt: - Storage daemon now closes the network connection when MaximumConcurrentJobs reached. -- New directive :strong:`LanAddress` was added to the Client and Storage Resources of the director to facilitate a network topology where client and storage are situated inside of a LAN, but the Director is outside of that LAN. See :ref:`LanAddress` for details. +- New directive :strong:`LanAddress`\ was added to the Client and Storage Resources of the director to facilitate a network topology where client and storage are situated inside of a LAN, but the Director is outside of that LAN. See :ref:`LanAddress` for details. - A Problem in the storage abstraction layer was fixed where the director picked the wrong storage daemon when multiple storages/storage daemons were used. @@ -409,15 +425,16 @@ This release contains several bugfixes and enhancements. Excerpt: -.. warning:: - This decreases performance if your environment has a large numbers of directories. Creating an index improves the performance. + .. warning:: + + This decreases performance if your environment has a large numbers of directories. Creating an index improves the performance. - |postgresql| - | When using PostgreSQL, creating the following partial improves the performance sufficiently: - | \sqlcommand{CREATE INDEX file_jfnidpart_idx ON File(JobId, FilenameId) WHERE FileIndex = 0;} + | ``CREATE INDEX file_jfnidpart_idx ON File(JobId, FilenameId) WHERE FileIndex = 0;`` - | Run following command to create the partial index: | :file:`su - postgres -c 'echo "CREATE INDEX file_jfnidpart_idx ON File(JobId, FilenameId) WHERE FileIndex = 0; ANALYZE File;" | psql bareos'` @@ -427,7 +444,7 @@ This release contains several bugfixes and enhancements. Excerpt: |mysql| - | When using MySQL or MariaDB, creating the following index improves the performance: - | \sqlcommand{CREATE INDEX PathId_JobId_FileIndex_FileNameId ON File(PathId,JobId,FileIndex,FilenameId);} + | ``CREATE INDEX PathId_JobId_FileIndex_FileNameId ON File(PathId,JobId,FileIndex,FilenameId);`` - | Run following command to create the index: | :file:`echo "CREATE INDEX PathId_JobId_FileIndex_FileNameId ON File(PathId,JobId,FileIndex,FilenameId);" | mysql -u root bareos` @@ -446,10 +463,12 @@ This release contains several bugfixes and enhancements. Excerpt: - WebUI: jQuery was updated from version 1.12.4 to version 3.2.0., some outdated browsers like Internet Explorer 6-8, Opera 12.1x or Safari 5.1+ will no longer be supported, see `jQuery Browser Support `_ for details. +.. _bareos-16.2.5: + bareos-16.2.5 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-16.2.5->Release Notes] ` +:index:`[TAG=bareos-16.2.5->Release Notes] ` # Tabular in LaTex format (original) @@ -459,7 +478,7 @@ bareos-16.2.5 Code Release & 2017-03-03\\ Database Version & 2004 (unchanged)\\ Release Ticket & :ticket:`734`\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/16.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -468,7 +487,7 @@ bareos-16.2.5 Code Release 2017-03-03 Database Version 2004 (unchanged) Release Ticket :ticket:`734` -Url ``_ +Url http://download.bareos.com/bareos/release/16.2/ ================ =============================================== This release contains several bugfixes and enhancements. Excerpt: @@ -483,10 +502,12 @@ This release contains several bugfixes and enhancements. Excerpt: - WebUI: adds translations for Chinese, Italian and Spanish. +.. _bareos-16.2.4: + bareos-16.2.4 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-16.2.4->Release Notes] ` +:index:`[TAG=bareos-16.2.4->Release Notes] ` # Tabular in LaTex format (original) @@ -496,8 +517,8 @@ bareos-16.2.4 Code Release & 2016-10-28\\ Database Version & 2004 (unchanged)\\ Release Ticket & :ticket:`698`\\ - Url & ``_ \\ - & ``_ \\ + Url & http://download.bareos.org/bareos/release/16.2/ \\ + & http://download.bareos.com/bareos/release/16.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -506,18 +527,18 @@ bareos-16.2.4 Code Release 2016-10-28 Database Version 2004 (unchanged) Release Ticket :ticket:`698` -Url ``_ -\ ``_ +Url http://download.bareos.org/bareos/release/16.2/ +\ http://download.bareos.com/bareos/release/16.2/ ================ =============================================== First stable release of the Bareos 16.2 branch. - Configuration - - Bareos packages contain the default configuration in :ref:`section-ConfigurationSubdirectories`. Please read :ref:`section-UpdateToConfigurationSubdirectories` before updating (make a copy of your configuration directories for your |bareosDir| and |bareosSd| before updating). Note: as the old configuration files are still supported, in most cases no changes are required. + - Bareos packages contain the default configuration in :ref:`section-ConfigurationSubdirectories`. Please read :ref:`section-UpdateToConfigurationSubdirectories` before updating (make a copy of your configuration directories for your |dir| and |sd| before updating). Note: as the old configuration files are still supported, in most cases no changes are required. - - The default configuration does no longer name the :config:option:`Dir/Director`\ and :config:option:`Sd/Storage`\ resources after the systems hostname (:file:`$HOSTNAME-dir` resp. :file:`$HOSTNAME-sd`) but use :config:option:`Dir/Director = bareos-dir`\ resp. :config:option:`Sd/Storage = bareos-sd`\ as defaults. The prior solution had the disadvantage, that :file:`$HOSTNAME-dir` has also been set on |bareosFd| not running on the - |bareosDir|, which almost ever did require changing this setting. Also the new approach aligns better with :ref:`section-ConfigurationSubdirectories`. + - The default configuration does no longer name the :config:option:`Dir/Director`\ and :config:option:`Sd/Storage`\ resources after the systems hostname (:file:`$HOSTNAME-dir` resp. :file:`$HOSTNAME-sd`) but use :config:option:`Dir/Director = bareos-dir`\ resp. :config:option:`Sd/Storage = bareos-sd`\ as defaults. The prior solution had the disadvantage, that :file:`$HOSTNAME-dir` has also been set on |fd| not running on the + |dir|, which almost ever did require changing this setting. Also the new approach aligns better with :ref:`section-ConfigurationSubdirectories`. - Due to limitation of the build system, the default resource :config:option:`Dir/FileSet = Linux All`\ have been renamed to :config:option:`Dir/FileSet = LinuxAll`\ (no space between Linux and All). @@ -535,12 +556,12 @@ First stable release of the Bareos 16.2 branch. - Strict ACL handling - - Bareos Console :strong:`Acl`s do no longer automatically matches substrings (to avoid that e.g. :config:option:`dir/console/PoolAcl = Full`\ also matches :config:option:`dir/pool = VirtualFull`\ ). To configure the ACL to work as before, :config:option:`dir/console/PoolAcl = .*Full.*`\ must be set. Unfortunately the |bareosWebui| 15.2 :config:option:`Dir/Profile = webui`\ did use - :config:option:`dir/console/CommandAcl = .bvfs*`\ , which is also no longer works as intended. Moreover, to use all of |bareosWebui| 16.2 features, some additional commands must be permitted, so best use the new :config:option:`Dir/Profile = webui-admin`\ . + - Bareos Console :strong:`Acl`s do no longer automatically matches substrings (to avoid that e.g. :config:option:`dir/console/PoolAcl = Full`\ also matches :config:option:`dir/pool = VirtualFull`\ ). To configure the ACL to work as before, :config:option:`dir/console/PoolAcl = .*Full.*`\ must be set. Unfortunately the |webui| 15.2 :config:option:`Dir/Profile = webui`\ did use + :config:option:`dir/console/CommandAcl = .bvfs*`\ , which is also no longer works as intended. Moreover, to use all of |webui| 16.2 features, some additional commands must be permitted, so best use the new :config:option:`Dir/Profile = webui-admin`\ . - - |bareosWebui| + |webui| - Updating from Bareos 15.2: Adapt :config:option:`Dir/Profile = webui`\ (from bareos 15.2) to allow all commands of :config:option:`Dir/Profile = webui-admin`\ (:config:option:`dir/console/CommandAcl`\ ). Alternately modify all :config:option:`Dir/Console`\ s currently using :config:option:`Dir/Profile = webui`\ to use :config:option:`Dir/Profile = webui-admin`\ instead. @@ -549,10 +570,12 @@ First stable release of the Bareos 16.2 branch. Bareos-15.2 ----------- +.. _bareos-15.2.4: + bareos-15.2.4 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-15.2.4->Release Notes] ` +:index:`[TAG=bareos-15.2.4->Release Notes] ` # Tabular in LaTex format (original) @@ -562,7 +585,7 @@ bareos-15.2.4 Code Release & 2016-06-10\\ Database Version & 2004 (unchanged)\\ Release Ticket & :ticket:`641` \\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/15.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -571,7 +594,7 @@ bareos-15.2.4 Code Release 2016-06-10 Database Version 2004 (unchanged) Release Ticket :ticket:`641` -Url ``_ +Url http://download.bareos.com/bareos/release/15.2/ ================ =============================================== For upgrading from 14.2, please see release notes for 15.2.1. @@ -586,10 +609,12 @@ This release contains several bugfixes and enhancements. Excerpt: - Director memory leak caused by frequent bconsole calls +.. _bareos-15.2.3: + bareos-15.2.3 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-15.2.3->Release Notes] ` +:index:`[TAG=bareos-15.2.3->Release Notes] ` # Tabular in LaTex format (original) @@ -599,7 +624,7 @@ bareos-15.2.3 Code Release & 2016-03-11\\ Database Version & 2004 (unchanged)\\ Release Ticket & :ticket:`625` \\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/15.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -608,7 +633,7 @@ bareos-15.2.3 Code Release 2016-03-11 Database Version 2004 (unchanged) Release Ticket :ticket:`625` -Url ``_ +Url http://download.bareos.com/bareos/release/15.2/ ================ =============================================== For upgrading from 14.2, please see releasenotes for 15.2.1. @@ -631,10 +656,12 @@ This release contains several bugfixes and enhancements. Excerpt: - label barcodes now can run without interaction +.. _bareos-15.2.2: + bareos-15.2.2 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-15.2.2->Release Notes] ` +:index:`[TAG=bareos-15.2.2->Release Notes] ` # Tabular in LaTex format (original) @@ -645,8 +672,8 @@ bareos-15.2.2 Database Version & 2004\\ & Database update required (if coming from bareos-14.2). See the :ref:`bareos-update` section.\\ Release Ticket & :ticket:`554` \\ - Url & ``_ \\ - & ``_ \\ + Url & http://download.bareos.org/bareos/release/15.2/ \\ + & http://download.bareos.com/bareos/release/15.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -656,8 +683,8 @@ Code Release 2015-11-19 Database Version 2004 \ Database update required (if coming from bareos-14.2). See the :ref:`bareos-update` section. Release Ticket :ticket:`554` -Url ``_ -\ ``_ +Url http://download.bareos.org/bareos/release/15.2/ +\ http://download.bareos.com/bareos/release/15.2/ ================ ============================================================================================================ First stable release of the Bareos 15.2 branch. @@ -680,7 +707,7 @@ When coming from bareos-14.2.x, the following things have changed (same as in ba Database Version & 2004\\ & Database update required, see the :ref:`bareos-update` section.\\ Release Ticket & :ticket:`501` \\ - Url & ``_ \\ + Url & http://download.bareos.org/bareos/release/15.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -690,7 +717,7 @@ Code Release 2015-09-16 Database Version 2004 \ Database update required, see the :ref:`bareos-update` section. Release Ticket :ticket:`501` -Url ``_ +Url http://download.bareos.org/bareos/release/15.2/ ================ =============================================================================== Beta release. @@ -704,10 +731,12 @@ Bareos-14.2 It is known, that :command:`drop_database` scripts will not longer work on PostgreSQL < 8.4. However, as :command:`drop_database` scripts are very seldom needed, package dependencies do not yet enforce PostgreSQL >= 8.4. We plan to ensure this in future version of Bareos. +.. _bareos-14.2.7: + bareos-14.2.7 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-14.2.7->Release Notes] ` +:index:`[TAG=bareos-14.2.7->Release Notes] ` # Tabular in LaTex format (original) @@ -717,7 +746,7 @@ bareos-14.2.7 Code Release & 2016-07-11\\ Database Version & 2003 (unchanged)\\ Release Ticket & :ticket:`584` \\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/14.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -726,7 +755,7 @@ bareos-14.2.7 Code Release 2016-07-11 Database Version 2003 (unchanged) Release Ticket :ticket:`584` -Url ``_ +Url http://download.bareos.com/bareos/release/14.2/ ================ =============================================== This release contains several bugfixes. Excerpt: @@ -775,10 +804,12 @@ This release contains several bugfixes. Excerpt: - | Fix backup/restore of incremental backups | :ticket:`588`: Incremental MSSQL backup fails when database name contains spaces +.. _bareos-14.2.6: + bareos-14.2.6 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-14.2.6->Release Notes] ` +:index:`[TAG=bareos-14.2.6->Release Notes] ` # Tabular in LaTex format (original) @@ -788,7 +819,7 @@ bareos-14.2.6 Code Release & 2015-12-03\\ Database Version & 2003 (unchanged)\\ Release Ticket & :ticket:`474` \\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/14.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -797,15 +828,17 @@ bareos-14.2.6 Code Release 2015-12-03 Database Version 2003 (unchanged) Release Ticket :ticket:`474` -Url ``_ +Url http://download.bareos.com/bareos/release/14.2/ ================ =============================================== This release contains several bugfixes. +.. _bareos-14.2.5: + bareos-14.2.5 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-14.2.5->Release Notes] ` +:index:`[TAG=bareos-14.2.5->Release Notes] ` # Tabular in LaTex format (original) @@ -815,7 +848,7 @@ bareos-14.2.5 Code Release & 2015-06-01\\ Database Version & 2003 (unchanged)\\ Release Ticket & :ticket:`447` \\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/14.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -824,15 +857,17 @@ bareos-14.2.5 Code Release 2015-06-01 Database Version 2003 (unchanged) Release Ticket :ticket:`447` -Url ``_ +Url http://download.bareos.com/bareos/release/14.2/ ================ =============================================== This release contains several bugfixes and added the platforms :os:`Debian 8` and :os:`Fedora 21`. +.. _bareos-14.2.4: + bareos-14.2.4 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-14.2.4->Release Notes] ` +:index:`[TAG=bareos-14.2.4->Release Notes] ` # Tabular in LaTex format (original) @@ -842,7 +877,7 @@ bareos-14.2.4 Code Release & 2015-03-23 \\ Database Version & 2003 (unchanged)\\ Release Ticket & :ticket:`420` \\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/14.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -851,7 +886,7 @@ bareos-14.2.4 Code Release 2015-03-23 Database Version 2003 (unchanged) Release Ticket :ticket:`420` -Url ``_ +Url http://download.bareos.com/bareos/release/14.2/ ================ =============================================== This release contains several bugfixes, including one major bugfix (:ticket:`437`), relevant for those of you using backup to disk with autolabeling enabled. @@ -874,10 +909,12 @@ If an update is not possible immediately, autolabeling should be disabled and vo If you are affected by the 64k bug, we recommend that you schedule a full backup after fixing the problem in order to get a proper full backup of all files. +.. _bareos-14.2.3: + bareos-14.2.3 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-14.2.3->Release Notes] ` +:index:`[TAG=bareos-14.2.3->Release Notes] ` # Tabular in LaTex format (original) @@ -887,7 +924,7 @@ bareos-14.2.3 Code Release & 2015-02-02 \\ Database Version & 2003 (unchanged)\\ Release Ticket & :ticket:`393`\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/14.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -896,13 +933,15 @@ bareos-14.2.3 Code Release 2015-02-02 Database Version 2003 (unchanged) Release Ticket :ticket:`393` -Url ``_ +Url http://download.bareos.com/bareos/release/14.2/ ================ =============================================== +.. _bareos-14.2.2: + bareos-14.2.2 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-14.2.2->Release Notes] ` +:index:`[TAG=bareos-14.2.2->Release Notes] ` # Tabular in LaTex format (original) @@ -913,8 +952,8 @@ bareos-14.2.2 Database Version & 2003 (unchanged)\\ & Database update required if updating from version < 14.2.\\ & See the :ref:`bareos-update` section for details.\\ - Url & ``_ \\ - & ``_ \\ + Url & http://download.bareos.org/bareos/release/14.2/ \\ + & http://download.bareos.com/bareos/release/14.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -924,8 +963,8 @@ Code Release 2014-12-12 Database Version 2003 (unchanged) \ Database update required if updating from version < 14.2. \ See the :ref:`bareos-update` section for details. -Url ``_ -\ ``_ +Url http://download.bareos.org/bareos/release/14.2/ +\ http://download.bareos.com/bareos/release/14.2/ ================ ================================================================= First stable release of the Bareos 14.2 branch. @@ -941,7 +980,7 @@ First stable release of the Bareos 14.2 branch. Code Release & 2014-09-22 \\ Database Version & 2003\\ & Database update required, see the :ref:`bareos-update` section.\\ - Url & ``_ \\ + Url & http://download.bareos.org/bareos/release/14.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -950,7 +989,7 @@ First stable release of the Bareos 14.2 branch. Code Release 2014-09-22 Database Version 2003 \ Database update required, see the :ref:`bareos-update` section. -Url ``_ +Url http://download.bareos.org/bareos/release/14.2/ ================ =============================================================================== Beta release. @@ -958,10 +997,12 @@ Beta release. Bareos-13.2 ----------- +.. _bareos-13.2.5: + bareos-13.2.5 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-13.2.5->Release Notes] ` +:index:`[TAG=bareos-13.2.5->Release Notes] ` # Tabular in LaTex format (original) @@ -970,7 +1011,7 @@ bareos-13.2.5 \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2015-12-03 \\ Database Version & 2002 (unchanged)\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/13.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -978,15 +1019,17 @@ bareos-13.2.5 ================ =============================================== Code Release 2015-12-03 Database Version 2002 (unchanged) -Url ``_ +Url http://download.bareos.com/bareos/release/13.2/ ================ =============================================== This release contains several bugfixes. +.. _bareos-13.2.4: + bareos-13.2.4 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-13.2.4->Release Notes] ` +:index:`[TAG=bareos-13.2.4->Release Notes] ` # Tabular in LaTex format (original) @@ -995,7 +1038,7 @@ bareos-13.2.4 \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2014-11-05 \\ Database Version & 2002 (unchanged)\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/13.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -1003,13 +1046,15 @@ bareos-13.2.4 ================ =============================================== Code Release 2014-11-05 Database Version 2002 (unchanged) -Url ``_ +Url http://download.bareos.com/bareos/release/13.2/ ================ =============================================== +.. _bareos-13.2.3: + bareos-13.2.3 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-13.2.3->Release Notes] ` +:index:`[TAG=bareos-13.2.3->Release Notes] ` # Tabular in LaTex format (original) @@ -1019,7 +1064,7 @@ bareos-13.2.3 Code Release & 2014-03-11 \\ Database Version & 2002\\ & Database update required, see the :ref:`bareos-update` section.\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/13.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -1028,15 +1073,17 @@ bareos-13.2.3 Code Release 2014-03-11 Database Version 2002 \ Database update required, see the :ref:`bareos-update` section. -Url ``_ +Url http://download.bareos.com/bareos/release/13.2/ ================ =============================================================================== It is known, that :command:`drop_database` scripts will not longer work on PostgreSQL < 8.4. However, as :command:`drop_database` scripts are very seldom needed, package dependencies do not yet enforce PostgreSQL >= 8.4. We plan to ensure this in future version of Bareos. +.. _bareos-13.2.2: + bareos-13.2.2 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-13.2.2->Release Notes] ` +:index:`[TAG=bareos-13.2.2->Release Notes] ` # Tabular in LaTex format (original) @@ -1045,8 +1092,8 @@ bareos-13.2.2 \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2013-11-19 \\ Database Version & 2001 (unchanged)\\ - Url & ``_ \\ - & ``_ \\ + Url & http://download.bareos.org/bareos/release/13.2/ \\ + & http://download.bareos.com/bareos/release/13.2/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -1054,17 +1101,19 @@ bareos-13.2.2 ================ =============================================== Code Release 2013-11-19 Database Version 2001 (unchanged) -Url ``_ -\ ``_ +Url http://download.bareos.org/bareos/release/13.2/ +\ http://download.bareos.com/bareos/release/13.2/ ================ =============================================== Bareos-12.4 ----------- +.. _bareos-12.4.8: + bareos-12.4.8 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-12.4.8->Release Notes] ` +:index:`[TAG=bareos-12.4.8->Release Notes] ` # Tabular in LaTex format (original) @@ -1073,7 +1122,7 @@ bareos-12.4.8 \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2015-11-18 \\ Database Version & 2001 (unchanged)\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/12.4/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -1081,15 +1130,17 @@ bareos-12.4.8 ================ =============================================== Code Release 2015-11-18 Database Version 2001 (unchanged) -Url ``_ +Url http://download.bareos.com/bareos/release/12.4/ ================ =============================================== This release contains several bugfixes. +.. _bareos-12.4.6: + bareos-12.4.6 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-12.4.6->Release Notes] ` +:index:`[TAG=bareos-12.4.6->Release Notes] ` # Tabular in LaTex format (original) @@ -1098,8 +1149,8 @@ bareos-12.4.6 \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2013-11-19 \\ Database Version & 2001 (unchanged)\\ - Url & ``_ \\ - & ``_ \\ + Url & http://download.bareos.org/bareos/release/12.4/ \\ + & http://download.bareos.com/bareos/release/12.4/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -1107,14 +1158,16 @@ bareos-12.4.6 ================ =============================================== Code Release 2013-11-19 Database Version 2001 (unchanged) -Url ``_ -\ ``_ +Url http://download.bareos.org/bareos/release/12.4/ +\ http://download.bareos.com/bareos/release/12.4/ ================ =============================================== +.. _bareos-12.4.5: + bareos-12.4.5 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-12.4.5->Release Notes] ` +:index:`[TAG=bareos-12.4.5->Release Notes] ` # Tabular in LaTex format (original) @@ -1123,7 +1176,7 @@ bareos-12.4.5 \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2013-09-10 \\ Database Version & 2001 (unchanged)\\ - Url & ``_ \\ + Url & http://download.bareos.com/bareos/release/12.4/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -1131,13 +1184,15 @@ bareos-12.4.5 ================ =============================================== Code Release 2013-09-10 Database Version 2001 (unchanged) -Url ``_ +Url http://download.bareos.com/bareos/release/12.4/ ================ =============================================== +.. _bareos-12.4.4: + bareos-12.4.4 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-12.4.4->Release Notes] ` +:index:`[TAG=bareos-12.4.4->Release Notes] ` # Tabular in LaTex format (original) @@ -1146,8 +1201,8 @@ bareos-12.4.4 \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2013-06-17 \\ Database Version & 2001 (unchanged)\\ - Url & ``_ \\ - & ``_ \\ + Url & http://download.bareos.org/bareos/release/12.4/ \\ + & http://download.bareos.com/bareos/release/12.4/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -1155,14 +1210,16 @@ bareos-12.4.4 ================ =============================================== Code Release 2013-06-17 Database Version 2001 (unchanged) -Url ``_ -\ ``_ +Url http://download.bareos.org/bareos/release/12.4/ +\ http://download.bareos.com/bareos/release/12.4/ ================ =============================================== +.. _bareos-12.4.3: + bareos-12.4.3 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-12.4.3->Release Notes] ` +:index:`[TAG=bareos-12.4.3->Release Notes] ` # Tabular in LaTex format (original) @@ -1171,8 +1228,8 @@ bareos-12.4.3 \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2013-04-15 \\ Database Version & 2001 (unchanged)\\ - Url & ``_ \\ - & ``_ \\ + Url & http://download.bareos.org/bareos/release/12.4/ \\ + & http://download.bareos.com/bareos/release/12.4/ \\ \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): @@ -1180,14 +1237,16 @@ bareos-12.4.3 ================ =============================================== Code Release 2013-04-15 Database Version 2001 (unchanged) -Url ``_ -\ ``_ +Url http://download.bareos.org/bareos/release/12.4/ +\ http://download.bareos.com/bareos/release/12.4/ ================ =============================================== +.. _bareos-12.4.2: + bareos-12.4.2 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-12.4.2->Release Notes] ` +:index:`[TAG=bareos-12.4.2->Release Notes] ` # Tabular in LaTex format (original) @@ -1205,10 +1264,12 @@ Code Release 2013-03-03 Database Version 2001 (unchanged) ================ ================ +.. _bareos-12.4.1: + bareos-12.4.1 ~~~~~~~~~~~~~ -:index:`[TAG=bareos-12.4.1->Release Notes] ` +:index:`[TAG=bareos-12.4.1->Release Notes] ` # Tabular in LaTex format (original) diff --git a/docs/manuals/en/new_main_reference/source/Appendix/SystemRequirements.rst b/docs/manuals/en/new_main_reference/source/Appendix/SystemRequirements.rst index ca55f002d07..c35ad41ce8d 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/SystemRequirements.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/SystemRequirements.rst @@ -3,7 +3,7 @@ System Requirements =================== -:index:`[TAG=System Requirements] ` :index:`[TAG=Requirements->System] ` +:index:`[TAG=System Requirements] ` :index:`[TAG=Requirements->System] ` - The minimum versions for each of the databases supported by Bareos are: @@ -23,7 +23,7 @@ System Requirements .. _jansson: - :index:`[TAG=JSON] ` :index:`[TAG=Jansson->\see{JSON}] ` Bareos :sinceVersion:`15.2.0: requires: jansson` offers a JSON API mode, see `Bareos Developer Guide (api-mode-2-json) `_. On some platform, the Jansson library is directory available. On others it can easly be added. For some older platforms, we compile Bareos without JSON API mode. + :index:`[TAG=JSON] ` :index:`[TAG=Jansson->\see{JSON}] ` Bareos :sinceVersion:`15.2.0: requires: jansson` offers a JSON API mode, see `Bareos Developer Guide (api-mode-2-json) `_. On some platform, the Jansson library is directory available. On others it can easly be added. For some older platforms, we compile Bareos without JSON API mode. diff --git a/docs/manuals/en/new_main_reference/source/Appendix/TheBootstrapFile.rst b/docs/manuals/en/new_main_reference/source/Appendix/TheBootstrapFile.rst index 0ef771ff4ac..8a762722016 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/TheBootstrapFile.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/TheBootstrapFile.rst @@ -3,7 +3,7 @@ The Bootstrap File ================== -:index:`[TAG=File->Bootstrap] ` :index:`[TAG=Bootstrap->File] ` +:index:`[TAG=File->Bootstrap] ` :index:`[TAG=Bootstrap->File] ` .. TODO: This chapter is going to be rewritten (by Philipp). @@ -14,7 +14,7 @@ The bootstrap file contains ASCII information that permits precise specification Bootstrap File Format --------------------- -:index:`[TAG=Bootstrap->File Format] ` +:index:`[TAG=Bootstrap->File Format] ` The general format of a bootstrap file is: @@ -45,51 +45,51 @@ directs the Storage daemon (or the bextract program) to restore only those files The full set of permitted keywords presented in the order in which they are matched against the Volume records are: Volume - :index:`[TAG=Bootstrap->Volume] ` The value field specifies what Volume the following commands apply to. Each Volume specification becomes the current Volume, to which all the following commands apply until a new current Volume (if any) is specified. If the Volume name contains spaces, it should be enclosed in quotes. At lease one Volume specification is required. + :index:`[TAG=Bootstrap->Volume] ` The value field specifies what Volume the following commands apply to. Each Volume specification becomes the current Volume, to which all the following commands apply until a new current Volume (if any) is specified. If the Volume name contains spaces, it should be enclosed in quotes. At lease one Volume specification is required. Count - :index:`[TAG=Bootstrap->Count] ` The value is the total number of files that will be restored for this Volume. This allows the Storage daemon to know when to stop reading the Volume. This value is optional. + :index:`[TAG=Bootstrap->Count] ` The value is the total number of files that will be restored for this Volume. This allows the Storage daemon to know when to stop reading the Volume. This value is optional. VolFile - :index:`[TAG=Bootstrap->VolFile] ` The value is a file number, a list of file numbers, or a range of file numbers to match on the current Volume. The file number represents the physical file on the Volume where the data is stored. For a tape volume, this record is used to position to the correct starting file, and once the tape is past the last specified file, reading will stop. + :index:`[TAG=Bootstrap->VolFile] ` The value is a file number, a list of file numbers, or a range of file numbers to match on the current Volume. The file number represents the physical file on the Volume where the data is stored. For a tape volume, this record is used to position to the correct starting file, and once the tape is past the last specified file, reading will stop. VolBlock - :index:`[TAG=Bootstrap->VolBlock] ` The value is a block number, a list of block numbers, or a range of block numbers to match on the current Volume. The block number represents the physical block within the file on the Volume where the data is stored. + :index:`[TAG=Bootstrap->VolBlock] ` The value is a block number, a list of block numbers, or a range of block numbers to match on the current Volume. The block number represents the physical block within the file on the Volume where the data is stored. VolSessionTime - :index:`[TAG=Bootstrap->VolSessionTime] ` The value specifies a Volume Session Time to be matched from the current volume. + :index:`[TAG=Bootstrap->VolSessionTime] ` The value specifies a Volume Session Time to be matched from the current volume. VolSessionId - :index:`[TAG=Bootstrap->VolSessionId] ` The value specifies a VolSessionId, a list of volume session ids, or a range of volume session ids to be matched from the current Volume. Each VolSessionId and VolSessionTime pair corresponds to a unique Job that is backed up on the Volume. + :index:`[TAG=Bootstrap->VolSessionId] ` The value specifies a VolSessionId, a list of volume session ids, or a range of volume session ids to be matched from the current Volume. Each VolSessionId and VolSessionTime pair corresponds to a unique Job that is backed up on the Volume. JobId - :index:`[TAG=Bootstrap->JobId] ` The value specifies a JobId, list of JobIds, or range of JobIds to be selected from the current Volume. Note, the JobId may not be unique if you have multiple Directors, or if you have reinitialized your database. The JobId filter works only if you do not run multiple simultaneous jobs. This value is optional and not used by Bareos to restore files. + :index:`[TAG=Bootstrap->JobId] ` The value specifies a JobId, list of JobIds, or range of JobIds to be selected from the current Volume. Note, the JobId may not be unique if you have multiple Directors, or if you have reinitialized your database. The JobId filter works only if you do not run multiple simultaneous jobs. This value is optional and not used by Bareos to restore files. Job - :index:`[TAG=Bootstrap->Job] ` The value specifies a Job name or list of Job names to be matched on the current Volume. The Job corresponds to a unique VolSessionId and VolSessionTime pair. However, the Job is perhaps a bit more readable by humans. Standard regular expressions (wildcards) may be used to match Job names. The Job filter works only if you do not run multiple simultaneous jobs. This value is optional and not used by Bareos to restore files. + :index:`[TAG=Bootstrap->Job] ` The value specifies a Job name or list of Job names to be matched on the current Volume. The Job corresponds to a unique VolSessionId and VolSessionTime pair. However, the Job is perhaps a bit more readable by humans. Standard regular expressions (wildcards) may be used to match Job names. The Job filter works only if you do not run multiple simultaneous jobs. This value is optional and not used by Bareos to restore files. Client - :index:`[TAG=Bootstrap->Client] ` The value specifies a Client name or list of Clients to will be matched on the current Volume. Standard regular expressions (wildcards) may be used to match Client names. The Client filter works only if you do not run multiple simultaneous jobs. This value is optional and not used by Bareos to restore files. + :index:`[TAG=Bootstrap->Client] ` The value specifies a Client name or list of Clients to will be matched on the current Volume. Standard regular expressions (wildcards) may be used to match Client names. The Client filter works only if you do not run multiple simultaneous jobs. This value is optional and not used by Bareos to restore files. FileIndex - :index:`[TAG=Bootstrap->FileIndex] ` The value specifies a FileIndex, list of FileIndexes, or range of FileIndexes to be selected from the current Volume. Each file (data) stored on a Volume within a Session has a unique FileIndex. For each Session, the first file written is assigned FileIndex equal to one and incremented for each file backed up. + :index:`[TAG=Bootstrap->FileIndex] ` The value specifies a FileIndex, list of FileIndexes, or range of FileIndexes to be selected from the current Volume. Each file (data) stored on a Volume within a Session has a unique FileIndex. For each Session, the first file written is assigned FileIndex equal to one and incremented for each file backed up. This for a given Volume, the triple VolSessionId, VolSessionTime, and FileIndex uniquely identifies a file stored on the Volume. Multiple copies of the same file may be stored on the same Volume, but for each file, the triple VolSessionId, VolSessionTime, and FileIndex will be unique. This triple is stored in the Catalog database for each file. To restore a particular file, this value (or a range of FileIndexes) is required. FileRegex - :index:`[TAG=Bootstrap->FileRegex] ` The value is a regular expression. When specified, only matching filenames will be restored. + :index:`[TAG=Bootstrap->FileRegex] ` The value is a regular expression. When specified, only matching filenames will be restored. :: FileRegex=^/etc/passwd(.old)? Slot - :index:`[TAG=Bootstrap->Slot] ` The value specifies the autochanger slot. There may be only a single Slot specification for each Volume. + :index:`[TAG=Bootstrap->Slot] ` The value specifies the autochanger slot. There may be only a single Slot specification for each Volume. Stream - :index:`[TAG=Bootstrap->Stream] ` The value specifies a Stream, a list of Streams, or a range of Streams to be selected from the current Volume. Unless you really know what you are doing (the internals of Bareos), you should avoid this specification. This value is optional and not used by Bareos to restore files. + :index:`[TAG=Bootstrap->Stream] ` The value specifies a Stream, a list of Streams, or a range of Streams to be selected from the current Volume. Unless you really know what you are doing (the internals of Bareos), you should avoid this specification. This value is optional and not used by Bareos to restore files. The Volume record is a bit special in that it must be the first record. The other keyword records may appear in any order and any number following a Volume record. @@ -234,7 +234,7 @@ and the following bootstrap file would restore those files: Automatic Generation of Bootstrap Files --------------------------------------- -:index:`[TAG=Files->Automatic Generation of Bootstrap] ` :index:`[TAG=Bootstrap->Automatic Generation] ` +:index:`[TAG=Files->Automatic Generation of Bootstrap] ` :index:`[TAG=Bootstrap->Automatic Generation] ` One thing that is probably worth knowing: the bootstrap files that are generated automatically at the end of the job are not as optimized as those generated by the restore command. This is because during Incremental and Differential jobs, the records pertaining to the files written for the Job are appended to the end of the bootstrap file. As consequence, all the files saved to an Incremental or Differential job will be restored first by the Full save, then by any Incremental or Differential saves. @@ -263,7 +263,7 @@ The no answers the Do you want to run this (yes/mod/no) question. Bootstrap for bscan ------------------- -:index:`[TAG=bscan] ` :index:`[TAG=bscan->bootstrap] ` :index:`[TAG=Bootstrap->bscan] ` :index:`[TAG=Command->bscan] ` +:index:`[TAG=bscan] ` :index:`[TAG=bscan->bootstrap] ` :index:`[TAG=Bootstrap->bscan] ` :index:`[TAG=Command->bscan] ` .. _bscanBootstrap: @@ -286,7 +286,7 @@ If you have a very large number of Volumes to scan with bscan, you may exceed th Bootstrap Example ----------------- -:index:`[TAG=Example->Bootstrap] ` :index:`[TAG=Bootstrap->Example] ` +:index:`[TAG=Example->Bootstrap] ` :index:`[TAG=Bootstrap->Example] ` If you want to extract or copy a single Job, you can do it by selecting by JobId (code not tested) or better yet, if you know the VolSessionTime and the VolSessionId (printed on Job report and in Catalog), specifying this is by far the best. Using the VolSessionTime and VolSessionId is the way Bareos does restores. A bsr file might look like the following: diff --git a/docs/manuals/en/new_main_reference/source/Appendix/Troubleshooting.rst b/docs/manuals/en/new_main_reference/source/Appendix/Troubleshooting.rst index 27fc03b5f54..df4ec29d344 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/Troubleshooting.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/Troubleshooting.rst @@ -13,7 +13,7 @@ The Bareos programs contain a lot of debug messages. Normally, these are not pri Client Access Problems ---------------------- -:index:`[TAG=Problem->Cannot Access a Client] ` There are several reasons why a |bareosDir| could not contact a client on a different machine. They are: +:index:`[TAG=Problem->Cannot Access a Client] ` There are several reasons why a |dir| could not contact a client on a different machine. They are: - Check if the client file daemon is really running. @@ -30,12 +30,12 @@ Some of the DNS and Firewall problems can be circumvented by configuring clients Difficulties Connecting from the FD to the SD ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Problem->Connecting from the FD to the SD] ` +:index:`[TAG=Problem->Connecting from the FD to the SD] ` If you are having difficulties getting one or more of your File daemons to connect to the Storage daemon, it is most likely because you have not used a fully qualified domain name on the :config:option:`dir/storage/Address`\ directive. That is the resolver on the File daemon’s machine (not on the Director’s) must be able to resolve the name you supply into an IP address. An example of an address that is guaranteed not to work: :strong:`localhost`. An example that may work: :strong:`bareos-sd1`. An example that is more likely to work: :strong:`bareos-sd1.example.com`. -You can verify how a |bareosFd| resolves a DNS name by the following command: +You can verify how a |fd| resolves a DNS name by the following command: :: @@ -48,12 +48,12 @@ You can verify how a |bareosFd| resolves a DNS name by the following command: bareos-fd resolves bareos-sd1.example.com to host[ipv4;192.168.0.1] \end{bconsole} -If your address is correct, then make sure that no other program is using the port 9103 on the Storage daemon’s machine. The Bacula project has reserved these port numbers by IANA, therefore they should only be used by Bacula and its replacements like Bareos. However, apparently some HP printers do use these port numbers. A :command:`netstat -lntp` on the |bareosSd|’s machine can determine who is listening on the 9103 port (used for FD to SD communications in Bareos). +If your address is correct, then make sure that no other program is using the port 9103 on the Storage daemon’s machine. The Bacula project has reserved these port numbers by IANA, therefore they should only be used by Bacula and its replacements like Bareos. However, apparently some HP printers do use these port numbers. A :command:`netstat -lntp` on the |sd|’s machine can determine who is listening on the 9103 port (used for FD to SD communications in Bareos). Authorization Errors ~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Problem->Authorization Errors] ` :index:`[TAG=Concurrent Jobs] ` +:index:`[TAG=Problem->Authorization Errors] ` :index:`[TAG=Concurrent Jobs] ` .. _AuthorizationErrors: @@ -76,20 +76,20 @@ Here is a picture that indicates what names/passwords in which files/Resources m -In the left column, you will find the Director, Storage, and Client resources, with their names and passwords – these are all in the |bareosDir| configuration. The right column is where the corresponding values should be found in the Console, Storage daemon (SD), and File daemon (FD) configuration files. +In the left column, you will find the Director, Storage, and Client resources, with their names and passwords – these are all in the |dir| configuration. The right column is where the corresponding values should be found in the Console, Storage daemon (SD), and File daemon (FD) configuration files. -Another thing to check is to ensure that the Bareos component you are trying to access has :strong:`Maximum Concurrent Jobs` set large enough to handle each of the Jobs and the Console that want to connect simultaneously. Once the maximum connections has been reached, each Bareos component will reject all new connections. +Another thing to check is to ensure that the Bareos component you are trying to access has :strong:`Maximum Concurrent Jobs`\ set large enough to handle each of the Jobs and the Console that want to connect simultaneously. Once the maximum connections has been reached, each Bareos component will reject all new connections. .. _ConcurrentJobs: Concurrent Jobs --------------- -:index:`[TAG=Job->Concurrent Jobs] ` :index:`[TAG=Running Concurrent Jobs] ` :index:`[TAG=Concurrent Jobs] ` +:index:`[TAG=Job->Concurrent Jobs] ` :index:`[TAG=Running Concurrent Jobs] ` :index:`[TAG=Concurrent Jobs] ` -Bareos can run multiple concurrent jobs. Using the :strong:`Maximum Concurrent Jobs` directives, you can configure how many and which jobs can be run simultaneously: +Bareos can run multiple concurrent jobs. Using the :strong:`Maximum Concurrent Jobs`\ directives, you can configure how many and which jobs can be run simultaneously: -|bareosDir| +|dir| | - @@ -108,7 +108,7 @@ Bareos can run multiple concurrent jobs. Using the :strong:`Maximum Concurrent J :config:option:`dir/storage/MaximumConcurrentJobs`\ -|bareosSd| +|sd| | - @@ -119,14 +119,14 @@ Bareos can run multiple concurrent jobs. Using the :strong:`Maximum Concurrent J :config:option:`sd/device/MaximumConcurrentJobs`\ -|bareosFd| +|fd| | - :config:option:`fd/client/MaximumConcurrentJobs`\ -For example, if you want two different jobs to run simultaneously backing up the same Client to the same Storage device, they will run concurrently only if you have set :strong:`Maximum Concurrent Jobs` greater than one in the :strong:`Director` resource, the :strong:`Client` resource, and the :strong:`Storage` resource in |bareosDir| configuration. +For example, if you want two different jobs to run simultaneously backing up the same Client to the same Storage device, they will run concurrently only if you have set :strong:`Maximum Concurrent Jobs`\ greater than one in the :config:option:`Dir/Director`\ resource, the :config:option:`Dir/Client`\ resource, and the :config:option:`Dir/Storage`\ resource in |dir| configuration. @@ -171,7 +171,7 @@ Below is a super stripped down :file:`bareos-dir.conf` file showing you the four Media VolWrites: integer out of range ------------------------------------- -:index:`[TAG=Errors->integer out of range] ` :index:`[TAG=Catalog->Media->VolWrites] ` +:index:`[TAG=Errors->integer out of range] ` :index:`[TAG=Catalog->Media->VolWrites] ` In some situation, you receive an error message similar to this: @@ -180,7 +180,7 @@ In some situation, you receive an error message similar to this: 12-Apr 15:10 bareos-dir JobId 15860: Fatal error: Catalog error updating Media record. sql_update.c:385 update UPDATE Media SET VolJobs=12,VolFiles=10,VolBlocks=155013,VolBytes=10000263168,VolMounts=233,VolErrors=0,VolWrites=2147626019,MaxVolBytes=0,VolStatus='Append',Slot=1,InChanger=1,VolReadTime=0,VolWriteTime=842658562655,LabelType=0,StorageId=3,PoolId=2,VolRetention=144000,VolUseDuration=82800,MaxVolJobs=0,MaxVolFiles=0,Enabled=1,LocationId=0,ScratchPoolId=0,RecyclePoolId=0,RecycleCount=201,Recycle=1,ActionOnPurge=0,MinBlocksize=0,MaxBlocksize=0 WHERE VolumeName='000194L5' failed: ERROR: integer out of range -The database column \dbcolumn{VolWrites} in the **Media** table stores the number of write accesses to a volume. It is only used for statistics. +The database column **VolWrites** in the **Media** table stores the number of write accesses to a volume. It is only used for statistics. However, it has happened that the number of write accesses exceeds the maximum value supported by the database column (on |postgresql| it is currently 2147483647, 32 bit, signed integer). The result is a database error, similar to the one mentioned above. @@ -217,14 +217,14 @@ In the long run, it is planed to modify the database schema to enable storing mu Tape Labels: ANSI or IBM ------------------------ -:index:`[TAG=Label->Tape Labels] ` :index:`[TAG=Tape->Label->ANSI] ` :index:`[TAG=Tape->Label->IBM] ` +:index:`[TAG=Label->Tape Labels] ` :index:`[TAG=Tape->Label->ANSI] ` :index:`[TAG=Tape->Label->IBM] ` By default, Bareos uses its own tape label (see :ref:`backward-compatibility-tape-format` and :config:option:`dir/pool/LabelType`\ ). However, Bareos also supports reading and write ANSI and IBM tape labels. Reading ~~~~~~~ -Reading ANSI/IBM labels is important, if some of your tapes are used by other programs that also support ANSI/IBM labels. For example, LTFS tapes :index:`[TAG=Tape->LTFS] ` are indicated by an ANSI label. +Reading ANSI/IBM labels is important, if some of your tapes are used by other programs that also support ANSI/IBM labels. For example, LTFS tapes :index:`[TAG=Tape->LTFS] ` are indicated by an ANSI label. If your are running Bareos in such an environment, you must set :config:option:`sd/device/CheckLabels`\ to yes, otherwise Bareos will not recognize that these tapes are already in use. @@ -242,7 +242,7 @@ If you have labeled your volumes outside of Bareos, then the ANSI/IBM label will Tape Drive ---------- -:index:`[TAG=Problem->Tape] ` +:index:`[TAG=Problem->Tape] ` This chapter is concerned with testing and configuring your tape drive to make sure that it will work properly with Bareos using the btape program. @@ -269,8 +269,7 @@ Do not proceed to the next item until you have succeeded with the previous one. #. Make sure you have a valid and correct Device resource corresponding to your drive. For Linux users, generally, the default one works. For FreeBSD users, there are two possible Device configurations (see below). For other drives and/or OSes, you will need to first ensure that your system tape modes are properly setup (see below), then possibly modify you Device resource depending on the output from the btape program (next item). When doing this, you should consult the - :ref:`Storage Daemon - Configuration ` of this manual. + :ref:`Storage Daemon Configuration ` of this manual. #. If you are using a Fibre Channel to connect your tape drive to Bareos, please be sure to disable any caching in the NSR (network storage router, which is a Fibre Channel to SCSI converter). @@ -285,8 +284,7 @@ Do not proceed to the next item until you have succeeded with the previous one. - It isn’t necessary to run the autochanger part of the test at this time, but do not go past this point until the basic test succeeds. If you do have an autochanger, please be sure to read the :ref:`Autochanger - chapter ` of this manual. + It isn’t necessary to run the autochanger part of the test at this time, but do not go past this point until the basic test succeeds. If you do have an autochanger, please be sure to read the :ref:`Autochanger chapter ` of this manual. #. Run the btape fill command, preferably with two volumes. This can take a long time. If you have an autochanger and it is configured, Bareos will automatically use it. If you do not have it configured, you can manually issue the appropriate mtx command, or press the autochanger buttons to change the tape when requested to do so. @@ -334,7 +332,7 @@ Testing Autochanger and Adapting mtx-changer script .. _section-MtxChangerManualUsage: - :index:`[TAG=Autochanger->Testing] ` :index:`[TAG=Autochanger->mtx-changer] ` :index:`[TAG=Command->mtx-changer] ` :index:`[TAG=Problem->Autochanger] ` :index:`[TAG=Problem->mtx-changer] ` + :index:`[TAG=Autochanger->Testing] ` :index:`[TAG=Autochanger->mtx-changer] ` :index:`[TAG=Command->mtx-changer] ` :index:`[TAG=Problem->Autochanger] ` :index:`[TAG=Problem->mtx-changer] ` In case, Bareos does not work well with the Autochanger, it is preferable to "hand-test" that the changer works. To do so, we suggest you do the following commands: @@ -423,7 +421,7 @@ It should print "3" Note, we have used an "illegal" slot number 0. In this case, will unload the tape into slot 3. Once all the above commands work correctly, assuming that you have the right Changer Command in your configuration, Bareos should be able to operate the changer. The only remaining area of problems will be if your autoloader needs some time to get the tape loaded after issuing the command. After the mtx-changer script returns, Bareos will immediately rewind and read the tape. If Bareos gets rewind I/O errors after a tape change, you will probably need to configure the -``load_sleep`` paramenter in the config file :file:`/etc/bareos/mtx-changer.conf`. You can test whether or not you need a sleep by putting the following commands into a file and running it as a script: +:strong:`load_sleep` paramenter in the config file :file:`/etc/bareos/mtx-changer.conf`. You can test whether or not you need a sleep by putting the following commands into a file and running it as a script: @@ -437,7 +435,7 @@ Once all the above commands work correctly, assuming that you have the right Cha -If the above script runs, you probably have no timing problems. If it does not run, start by putting a sleep 30 or possibly a sleep 60 in the script just after the mtx-changer load command. If that works, then you should configure the ``load_sleep`` paramenter in the config file :file:`/etc/bareos/mtx-changer.conf` to the specified value so that it will be effective when Bareos runs. +If the above script runs, you probably have no timing problems. If it does not run, start by putting a sleep 30 or possibly a sleep 60 in the script just after the mtx-changer load command. If that works, then you should configure the :strong:`load_sleep` paramenter in the config file :file:`/etc/bareos/mtx-changer.conf` to the specified value so that it will be effective when Bareos runs. A second problem that comes up with a small number of autochangers is that they need to have the cartridge ejected before it can be removed. If this is the case, the load 3 will never succeed regardless of how long you wait. If this seems to be your problem, you can insert an eject just after the unload so that the script looks like: @@ -454,7 +452,7 @@ A second problem that comes up with a small number of autochangers is that they -If this solves your problems, set the parameter ``offline`` in the config file :file:`/etc/bareos/mtx-changer.conf` to "1". +If this solves your problems, set the parameter :strong:`offline` in the config file :file:`/etc/bareos/mtx-changer.conf` to "1". Restore ------- @@ -462,7 +460,7 @@ Restore Restore a pruned job using a pattern ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Restore->pruned job] ` :index:`[TAG=Problem->Restore->pruned job] ` :index:`[TAG=Regex] ` +:index:`[TAG=Restore->pruned job] ` :index:`[TAG=Problem->Restore->pruned job] ` :index:`[TAG=Regex] ` It is possible to configure Bareos in a way, that job information are still stored in the Bareos catalog, while the individual file information are already pruned. @@ -484,7 +482,7 @@ See also :ref:`FileRegex bsr option ` for more information. Problems Restoring Files ~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Restore->Files->Problem] ` :index:`[TAG=Problem->Restoring Files] ` :index:`[TAG=Problem->Tape->fixed mode] ` :index:`[TAG=Problem->Tape->variable mode] ` +:index:`[TAG=Restore->Files->Problem] ` :index:`[TAG=Problem->Restoring Files] ` :index:`[TAG=Problem->Tape->fixed mode] ` :index:`[TAG=Problem->Tape->variable mode] ` The most frequent problems users have restoring files are error messages such as: @@ -525,7 +523,7 @@ Try the following things, each separately, and reset your Device resource to wha Restoring Files Can Be Slow ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Restore->slow] ` :index:`[TAG=Problem->Restore->slow] ` +:index:`[TAG=Restore->slow] ` :index:`[TAG=Problem->Restore->slow] ` Restoring files is generally much slower than backing them up for several reasons. The first is that during a backup the tape is normally already positioned and Bareos only needs to write. On the other hand, because restoring files is done so rarely, Bareos keeps only the start file and block on the tape for the whole job rather than on a file by file basis which would use quite a lot of space in the catalog. @@ -540,7 +538,7 @@ For all the above reasons the restore process is generally much slower than back Restoring When Things Go Wrong ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Catalog->Restore] ` :index:`[TAG=Restore->Catalog] ` :index:`[TAG=Disaster->Recovery->Catalog] ` :index:`[TAG=Problem->Repair Catalog] ` +:index:`[TAG=Catalog->Restore] ` :index:`[TAG=Restore->Catalog] ` :index:`[TAG=Disaster->Recovery->Catalog] ` :index:`[TAG=Problem->Repair Catalog] ` This and the following sections will try to present a few of the kinds of problems that can come up making restoring more difficult. We will try to provide a few ideas how to get out of these problem situations. In addition to what is presented here, there is more specific information on restoring a :ref:`Client ` and your :ref:`Server ` in the :ref:`RescueChapter` chapter of this manual. diff --git a/docs/manuals/en/new_main_reference/source/Appendix/VerifyFileIntegrityWithBareos.rst b/docs/manuals/en/new_main_reference/source/Appendix/VerifyFileIntegrityWithBareos.rst index 0e63650d5db..0e0b87f6e40 100644 --- a/docs/manuals/en/new_main_reference/source/Appendix/VerifyFileIntegrityWithBareos.rst +++ b/docs/manuals/en/new_main_reference/source/Appendix/VerifyFileIntegrityWithBareos.rst @@ -3,7 +3,7 @@ Verify File Integrity with Bareos ================================= -:index:`[TAG=Security->Using Bareos to Improve Computer] ` :index:`[TAG=Verify->File Integrity] ` +:index:`[TAG=Security->Using Bareos to Improve Computer] ` :index:`[TAG=Verify->File Integrity] ` Since Bareos maintains a catalog of files, their attributes, and either SHA1 or MD5 signatures, it can be an ideal tool for improving computer security. This is done by making a snapshot of your system files with a Verify Job and then checking the current state of your system against the snapshot, on a regular basis (e.g. nightly). @@ -38,7 +38,7 @@ Then you decide what attributes of each file you want compared by specifying com The Details ----------- -:index:`[TAG=Verify->Details] ` +:index:`[TAG=Verify->Details] ` In the discussion that follows, we will make reference to the Verify Configuration Example that is included below in the A Verify Configuration Example section. You might want to look it over now to get an idea of what it does. @@ -61,7 +61,7 @@ other hand, as long as I don’t load any new packages, none of these files chan Running the Verify ------------------ -:index:`[TAG=Verify->Running] ` +:index:`[TAG=Verify->Running] ` The first thing you will want to do is to run an InitCatalog level Verify Job. This will initialize the catalog to contain the file information that will later be used as a basis for comparisons with the actual file system, thus allowing you to detect any changes (and possible intrusions into your system). @@ -177,7 +177,7 @@ To use a previous job, you can add ``jobid=xxx`` option in run command line. It What To Do When Differences Are Found ------------------------------------- -:index:`[TAG=Verify->Differences] ` +:index:`[TAG=Verify->Differences] ` If you have setup your messages correctly, you should be notified if there are any differences and exactly what they are. For example, below is the email received after doing an update of OpenSSH: @@ -264,7 +264,7 @@ The FileSet that is shown below is what I use on my Red Hat 7.3 system. With a b A Verify Configuration Example ------------------------------ -:index:`[TAG=Verify->Example] ` +:index:`[TAG=Verify->Example] ` diff --git a/docs/manuals/en/new_main_reference/source/Configuration/Console.rst b/docs/manuals/en/new_main_reference/source/Configuration/Console.rst index 6b3a625e16b..7647036b62b 100644 --- a/docs/manuals/en/new_main_reference/source/Configuration/Console.rst +++ b/docs/manuals/en/new_main_reference/source/Configuration/Console.rst @@ -3,7 +3,7 @@ Console Configuration ===================== -:index:`[TAG=Configuration->Console] ` :index:`[TAG=Console Configuration] ` +:index:`[TAG=Configuration->Console] ` :index:`[TAG=Console Configuration] ` The Console configuration file is the simplest of all the configuration files, and in general, you should not need to change it except for the password. It simply contains the information necessary to contact the Director or Directors. @@ -16,7 +16,7 @@ The following Console Resource definition must be defined: Director Resource ----------------- -:index:`[TAG=Director Resource] ` :index:`[TAG=Resource->Director] ` +:index:`[TAG=Director Resource] ` :index:`[TAG=Resource->Director] ` The Director resource defines the attributes of the Director running on the network. You may have multiple Director resource specifications in a single Console configuration file. If you have more than one, you will be prompted to choose one when you start the Console program. @@ -73,7 +73,7 @@ An actual example might be: Console Resource ---------------- -:index:`[TAG=Console Resource] ` :index:`[TAG=Resource->Console] ` +:index:`[TAG=Console Resource] ` :index:`[TAG=Resource->Console] ` There are three different kinds of consoles, which the administrator or user can use to interact with the Director. These three kinds of consoles comprise three different security levels. @@ -134,7 +134,7 @@ Note, the Console resource is optional, but can be useful for restricted console Example Console Configuration File ---------------------------------- -:index:`[TAG=Configuration->bconsole] ` +:index:`[TAG=Configuration->bconsole] ` A Console configuration file might look like this: @@ -147,7 +147,7 @@ A Console configuration file might look like this: Password = "PASSWORD" } -With this configuration, the console program (e.g. :command:`bconsole`) will try to connect to a |bareosDir| named **bareos.example.com-dir** at the network address :strong:`bareos.example.com` and authenticate to the admin console using the password **PASSWORD**. +With this configuration, the console program (e.g. :command:`bconsole`) will try to connect to a |dir| named **bareos.example.com-dir** at the network address :strong:`bareos.example.com` and authenticate to the admin console using the password **PASSWORD**. .. _section-ConsoleAccessExample: diff --git a/docs/manuals/en/new_main_reference/source/Configuration/CustomizingTheConfiguration.rst b/docs/manuals/en/new_main_reference/source/Configuration/CustomizingTheConfiguration.rst index 965e0deb51e..cdedc2c4295 100644 --- a/docs/manuals/en/new_main_reference/source/Configuration/CustomizingTheConfiguration.rst +++ b/docs/manuals/en/new_main_reference/source/Configuration/CustomizingTheConfiguration.rst @@ -27,7 +27,7 @@ The following configuration files must be present: Configuration Path Layout ------------------------- -:index:`[TAG=Configuration->Directories] ` :index:`[TAG=Configuration->Subdirectories] ` +:index:`[TAG=Configuration->Directories] ` :index:`[TAG=Configuration->Subdirectories] ` When a Bareos component starts, it reads its configuration. In Bareos < 16.2.2 only configuration files (which optionally can include other files) are supported. Since Bareos :sinceVersion:`16.2.2: Subdirectory Configuration Scheme` also configuration subdirectories are supported. @@ -182,7 +182,7 @@ In Bareos < 16.2.2, Bareos uses one configuration file per component. Most larger Bareos environments split their configuration into separate files, making it easier to manage the configuration. -Also some extra packages (bareos-webui, plugins, ...) require a configuration, which must be included into the |bareosDir| or |bareosSd| configuration. The subdirectory approach makes it easier to add or modify the configuration resources of different Bareos packages. +Also some extra packages (bareos-webui, plugins, ...) require a configuration, which must be included into the |dir| or |sd| configuration. The subdirectory approach makes it easier to add or modify the configuration resources of different Bareos packages. The Bareos :ref:`configure ` command requires a configuration directory structure, as provided by the subdirectory approach. @@ -215,7 +215,7 @@ Resource file conventions - :file:`CONFIGDIR/COMPONENT.d/RESOURCE/NAME.conf.example` - - For example, the |bareosWebui| entails one config resource and one config resource example for the |bareosDir|: + - For example, the |webui| entails one config resource and one config resource example for the |dir|: - :file:`CONFIGDIR/bareos-director.d/profile/webui-admin.conf` @@ -226,8 +226,9 @@ Resource file conventions - Normally you should not remove resources that are already in use (jobs, clients, ...). Instead you should disable them by adding the directive ``Enable = no``. Otherwise you take the risk that orphaned entries are kept in the Bareos catalog. However, if a resource has not been used or all references have been cleared from the database, they can also be removed from the configuration. - .. warning:: - If you want to remove a configuration resource that is part of a Bareos package, +.. warning:: + + If you want to remove a configuration resource that is part of a Bareos package, replace the resource configuration file by an empty file. This prevents the resource from reappearing in the course of a package update. @@ -254,8 +255,9 @@ Updates from Bareos < 16.2.4 - .. warning:: - Problems can occur if you have implemented an own wildcard mechanism to load your configuration + .. warning:: + + Problems can occur if you have implemented an own wildcard mechanism to load your configuration from the same subdirectories as used by the new packages (:file:`CONFIGDIR/COMPONENT.d/*/*.conf`). In this case, newly installed configuration resource files can alter your current configuration by adding resources. @@ -266,9 +268,9 @@ Updates from Bareos < 16.2.4 - The correct way of migrating to the new configuration scheme would be to split the configuration file into resources, store them in the resource directories and then remove the original configuration file. - - For migrating the |bareosDir| configuration, the script `bareos-migrate-config.sh `_ exists. Being called, it connects via :command:`bconsole` to a running |bareosDir| and creates subdirectories with the resource configuration files. + - For migrating the |dir| configuration, the script `bareos-migrate-config.sh `_ exists. Being called, it connects via :command:`bconsole` to a running |dir| and creates subdirectories with the resource configuration files. - .. code-block:: sh + .. code-block:: shell-session :caption: bareos-migrate-config.sh # prepare temporary directory @@ -292,11 +294,11 @@ Updates from Bareos < 16.2.4 # install newly generated configuration cp -a /tmp/bareos-dir.d /etc/bareos/ - 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 `remove configuration resource files <#section-deleteConfigurationResourceFiles>`__. + Restart the |dir| and verify your configuration. Also make sure, that all resource configuration files coming from Bareos packages exists, in doubt as empty files, see `remove configuration resource files <#section-deleteConfigurationResourceFiles>`__. - Another way, without splitting the configuration into resource files is: - - .. code-block:: sh + - .. code-block:: shell-session :caption: move configuration to subdirectory mkdir CONFIGDIR/COMPONENT.d/migrate && mv CONFIGDIR/COMPONENT.conf CONFIGDIR/COMPONENT.d/migrate @@ -321,7 +323,7 @@ Character Sets :index:`[TAG=Character Sets] ` Bareos is designed to handle most character sets of the world, US ASCII, German, French, Chinese, ... However, it does this by encoding everything in UTF-8, and it expects all configuration files (including those read on Win32 machines) to be in UTF-8 format. UTF-8 is typically the default on Linux machines, but not on all Unix machines, nor on Windows, so you must take some care to ensure that your locale is set properly before starting Bareos. -:index:`[TAG=Windows->Configuration Files->UTF-8] ` To ensure that Bareos configuration files can be correctly read including foreign characters, the LANG environment variable must end in .UTF-8. A full example is en_US.UTF-8. The exact syntax may vary a bit from OS to OS, so that the way you have to define it will differ from the example. On most newer Win32 machines you can use :command:`notepad` to edit the conf files, then choose output encoding UTF-8. +:index:`[TAG=Windows->Configuration Files->UTF-8] ` To ensure that Bareos configuration files can be correctly read including foreign characters, the LANG environment variable must end in .UTF-8. A full example is en_US.UTF-8. The exact syntax may vary a bit from OS to OS, so that the way you have to define it will differ from the example. On most newer Win32 machines you can use :command:`notepad` to edit the conf files, then choose output encoding UTF-8. Bareos assumes that all filenames are in UTF-8 format on Linux and Unix machines. On Win32 they are in Unicode (UTF-16) and will hence be automatically converted to UTF-8 format. @@ -330,7 +332,7 @@ Bareos assumes that all filenames are in UTF-8 format on Linux and Unix machines Comments ~~~~~~~~ -:index:`[TAG=Configuration->Comments] ` +:index:`[TAG=Configuration->Comments] ` When reading a configuration, blank lines are ignored and everything after a hash sign (#) until the end of the line is taken to be a comment. @@ -344,9 +346,9 @@ A semicolon (;) is a logical end of line and anything after the semicolon is con Including other Configuration Files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Including other Configuration Files] ` :index:`[TAG=Files->Including other Configuration] ` :index:`[TAG=Configuration->Including Files] ` +:index:`[TAG=Including other Configuration Files] ` :index:`[TAG=Files->Including other Configuration] ` :index:`[TAG=Configuration->Including Files] ` -If you wish to break your configuration file into smaller pieces, you can do so by including other files using the syntax :strong:`@filename` where :file:`filename` is the full path and filename of another file. The :strong:`@filename` specification can be given anywhere a primitive token would appear. +If you wish to break your configuration file into smaller pieces, you can do so by including other files using the syntax :strong:`@filename`\ where :file:`filename` is the full path and filename of another file. The :strong:`@filename`\ specification can be given anywhere a primitive token would appear. .. code-block:: bareosconfig :caption: include a configuration file @@ -360,7 +362,7 @@ Since Bareos :sinceVersion:`16.2.1: Including configuration files by wildcard` w @/etc/bareos/extra/*.conf -By using :strong:`@|command` it is also possible to include the output of a script as a configuration: +By using :strong:`@|command`\ it is also possible to include the output of a script as a configuration: .. code-block:: bareosconfig :caption: use the output of a script as configuration @@ -381,11 +383,11 @@ The scripts are called at the start of the daemon. You should use this with care Resource -------- -:index:`[TAG=Configuration->Resource] ` +:index:`[TAG=Configuration->Resource] ` A resource is defined as the resource type (see :ref:`ResTypes`), followed by an open brace (:file:`{`), a number of :ref:`section-ConfigurationResourceDirective`s, and ended by a closing brace (:file:`}`) -Each resource definition MUST contain a :strong:`Name` directive. It can contain a :strong:`Description` directive. The :strong:`Name` directive is used to uniquely identify the resource. The :strong:`Description` directive can be used during the display of the Resource to provide easier human recognition. For example: +Each resource definition MUST contain a :strong:`Name`\ directive. It can contain a :strong:`Description`\ directive. The :strong:`Name`\ directive is used to uniquely identify the resource. The :strong:`Description`\ directive can be used during the display of the Resource to provide easier human recognition. For example: .. code-block:: bareosconfig :caption: Resource example @@ -396,9 +398,9 @@ Each resource definition MUST contain a :strong:`Name` directive. It can contain Query File = "/usr/lib/bareos/scripts/query.sql" } -defines the Director resource with the name ``bareos-dir`` and a query file :file:`/usr/lib/bareos/scripts/query.sql`. +defines the Director resource with the name :strong:`bareos-dir` and a query file :file:`/usr/lib/bareos/scripts/query.sql`. -:index:`[TAG=Configuration->Naming Convention] ` +:index:`[TAG=Configuration->Naming Convention] ` When naming resources, for some resource types naming conventions should be applied: @@ -457,8 +459,9 @@ Within a quoted string, any character following a backslash (\) is taken as itse -.. warning:: - If the configure directive is used to define a number, the number is never to be put between surrounding quotes. This is even true if the number is specified together with its unit, like ``365 days``. + .. warning:: + + If the configure directive is used to define a number, the number is never to be put between surrounding quotes. This is even true if the number is specified together with its unit, like :strong:`365 days`. Numbers @@ -469,7 +472,7 @@ Numbers are not to be quoted, see :ref:`section-Quotes`. Also do not prepend num Data Types ^^^^^^^^^^ -:index:`[TAG=Configuration->Data Types] ` :index:`[TAG=Data Type] ` +:index:`[TAG=Configuration->Data Types] ` :index:`[TAG=Data Type] ` .. _DataTypes: @@ -478,11 +481,11 @@ Data Types When parsing the resource directives, Bareos classifies the data according to the types listed below. acl - :index:`[TAG=Data Type->acl] ` + :index:`[TAG=Data Type->acl] ` .. _DataTypeAcl: - This directive defines what is permitted to be accessed. It does this by using a list of regular expressions, separated by commas (:strong:`,`) or using multiple directives. If :strong:`!` is prepended, the expression is negated. The special keyword ``*all*`` allows unrestricted access. + This directive defines what is permitted to be accessed. It does this by using a list of regular expressions, separated by commas (:strong:`,`) or using multiple directives. If :strong:`!` is prepended, the expression is negated. The special keyword :strong:`*all*` allows unrestricted access. Depending on the type of the ACL, the regular expressions can be either resource names, paths or console commands. @@ -537,8 +540,9 @@ acl - .. warning:: - + .. warning:: + + ACL checking stops at the first match. So the following definition allows all commands, which might not be what you expected: @@ -549,7 +553,7 @@ acl Command ACL = *all*, !sqlquery auth-type - :index:`[TAG=Data Type->auth-type] ` + :index:`[TAG=Data Type->auth-type] ` .. _DataTypeAuthType: @@ -567,7 +571,7 @@ auth-type - Use MD5 hashing integer - :index:`[TAG=Data Type->integer] ` + :index:`[TAG=Data Type->integer] ` .. _DataTypeInteger: @@ -576,7 +580,7 @@ integer Don’t use quotes around the number, see :ref:`section-Quotes`. long integer - :index:`[TAG=Data Type->long integer] ` + :index:`[TAG=Data Type->long integer] ` .. _DataTypeLongInteger: @@ -585,7 +589,7 @@ long integer Don’t use quotes around the number, see :ref:`section-Quotes`. job protocol - :index:`[TAG=Data Type->job protocol] ` + :index:`[TAG=Data Type->job protocol] ` .. _DataTypeJobProtocol: @@ -597,7 +601,7 @@ job protocol Native Bareos job protocol. NDMP - Deprecated. Alias for |ndmpBareos|. + Deprecated. Alias for |ndmpbareos|. NDMP_BAREOS Since Bareos :sinceVersion:`17.2.3: NDMP BAREOS`. See :ref:`section-NdmpBareos`. @@ -606,7 +610,7 @@ job protocol Since Bareos :sinceVersion:`17.2.3: NDMP NATIVE`. See :ref:`section-NdmpNative`. name - :index:`[TAG=Data Type->name] ` + :index:`[TAG=Data Type->name] ` .. _DataTypeName: @@ -615,21 +619,21 @@ name Please note that Bareos resource names as well as certain other names (e.g. Volume names) must contain only letters (including ISO accented letters), numbers, and a few special characters (space, underscore, ...). All other characters and punctuation are invalid. password - :index:`[TAG=Data Type->password] ` + :index:`[TAG=Data Type->password] ` .. _DataTypePassword: This is a Bareos password and it is stored internally in MD5 hashed format. path - :index:`[TAG=Data Type->path] ` + :index:`[TAG=Data Type->path] ` .. _DataTypeDirectory: A path is either a quoted or non-quoted string. A path will be passed to your standard shell for expansion when it is scanned. Thus constructs such as $HOME are interpreted to be their correct values. The path can either reference to a file or a directory. positive integer - :index:`[TAG=Data Type->positive integer] ` + :index:`[TAG=Data Type->positive integer] ` .. _DataTypePositiveInteger: @@ -638,7 +642,7 @@ positive integer Don’t use quotes around the number, see :ref:`section-Quotes`. speed - :index:`[TAG=Data Type->speed] ` + :index:`[TAG=Data Type->speed] ` .. _DataTypeSpeed: @@ -647,35 +651,35 @@ speed Don’t use quotes around the parameter, see :ref:`section-Quotes`. string - :index:`[TAG=Data Type->string] ` + :index:`[TAG=Data Type->string] ` .. _DataTypeString: A quoted string containing virtually any character including spaces, or a non-quoted string. A string may be of any length. Strings are typically values that correspond to filenames, directories, or system command names. A backslash (\) turns the next character into itself, so to include a double quote in a string, you precede the double quote with a backslash. Likewise to include a backslash. string-list - :index:`[TAG=Data Type->string list] ` + :index:`[TAG=Data Type->string list] ` .. _DataTypeStringList: Multiple strings, specified in multiple directives, or in a single directive, separated by commas (**,**). strname - :index:`[TAG=Data Type->strname] ` + :index:`[TAG=Data Type->strname] ` .. _DataTypeStrname: - is similar to a \dtName, except that the name may be quoted and can thus contain additional characters including spaces. + is similar to a :strong:`Name`, except that the name may be quoted and can thus contain additional characters including spaces. net-address - :index:`[TAG=Data Type->net-address] ` + :index:`[TAG=Data Type->net-address] ` .. _DataTypeNetAddress: - is either a domain name or an IP address specified as a dotted quadruple in string or quoted string format. This directive only permits a single address to be specified. The \dtNetPort must be specificly separated. If multiple net-addresses are needed, please assess if it is also possible to specify \dtNetAddresses (plural). + is either a domain name or an IP address specified as a dotted quadruple in string or quoted string format. This directive only permits a single address to be specified. The :strong:`NetPort` must be specificly separated. If multiple net-addresses are needed, please assess if it is also possible to specify :strong:`NetAddresses` (plural). net-addresses - :index:`[TAG=Data Type->net-addresses] ` + :index:`[TAG=Data Type->net-addresses] ` .. _DataTypeNetAddresses: @@ -707,7 +711,7 @@ net-addresses resolutions will be permitted, and likewise with ip6. net-port - :index:`[TAG=Data Type->net-port] ` + :index:`[TAG=Data Type->net-port] ` .. _DataTypeNetPort: @@ -716,14 +720,14 @@ net-port Don’t use quotes around the parameter, see :ref:`section-Quotes`. resource - :index:`[TAG=Data Type->resource] ` + :index:`[TAG=Data Type->resource] ` .. _DataTypeRes: A resource defines a relation to the name of another resource. size - :index:`[TAG=Data Type->size] ` + :index:`[TAG=Data Type->size] ` .. _DataTypeSize: @@ -754,7 +758,7 @@ size Don’t use quotes around the parameter, see :ref:`section-Quotes`. time - :index:`[TAG=Data Type->time] ` + :index:`[TAG=Data Type->time] ` .. _DataTypeTime: @@ -807,7 +811,7 @@ time Don’t use quotes around the parameter, see :ref:`section-Quotes`. audit-command-list - :index:`[TAG=Data Type->audit command list] ` + :index:`[TAG=Data Type->audit command list] ` .. _DataTypeAuditCommandList: @@ -820,12 +824,12 @@ audit-command-list Based on the type \dtStringList. -yes\|no` - :index:`[TAG=Data Type->\yesno] ` :index:`[TAG=Data Type->boolean] ` +yes\\|no` + :index:`[TAG=Data Type->\yesno] ` :index:`[TAG=Data Type->boolean] ` .. _DataTypeYesNo: - Either a ``yes`` or a ``no`` (or ``true`` or ``false``). + Either a :strong:`yes` or a :strong:`no` (or :strong:`true` or :strong:`false`). .. _VarsChapter: @@ -908,30 +912,30 @@ At the configuration of autochanger commands the following variables can be used \begin{tabular}{p{2cm}p{7cm}} :strong:`Variable` & :strong:`Description` \\ - ``\%a`` & Archive Device Name\\ - ``\%c`` & Changer Device Name\\ - ``\%d`` & Changer Drive Index\\ - ``\%f`` & Client's Name\\ - ``\%j`` & Job Name\\ - ``\%o`` & Command\\ - ``\%s`` & Slot Base 0\\ - ``\%S`` & Slot Base 1\\ - ``\%v`` & Volume Name + :strong:`\%a` & Archive Device Name\\ + :strong:`\%c` & Changer Device Name\\ + :strong:`\%d` & Changer Drive Index\\ + :strong:`\%f` & Client's Name\\ + :strong:`\%j` & Job Name\\ + :strong:`\%o` & Command\\ + :strong:`\%s` & Slot Base 0\\ + :strong:`\%S` & Slot Base 1\\ + :strong:`\%v` & Volume Name \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): ============================ =================== **Variable** **Description** -``\%a`` Archive Device Name -``\%c`` Changer Device Name -``\%d`` Changer Drive Index -``\%f`` Client’s Name -``\%j`` Job Name -``\%o`` Command -``\%s`` Slot Base 0 -``\%S`` Slot Base 1 -``\%v`` Volume Name +:strong:`\%a` Archive Device Name +:strong:`\%c` Changer Device Name +:strong:`\%d` Changer Drive Index +:strong:`\%f` Client’s Name +:strong:`\%j` Job Name +:strong:`\%o` Command +:strong:`\%s` Slot Base 0 +:strong:`\%S` Slot Base 1 +:strong:`\%v` Volume Name ============================ =================== Variable Expansion in Mount Commands @@ -945,22 +949,22 @@ At the configuration of mount commands the following variables can be used: \begin{tabular}{p{2cm}p{7cm}} :strong:`Variable` & :strong:`Description` \\ - ``\%a`` & Archive Device Name\\ - ``\%e`` & Erase\\ - ``\%n`` & Part Number\\ - ``\%m`` & Mount Point\\ - ``\%v`` & Last Part Name + :strong:`\%a` & Archive Device Name\\ + :strong:`\%e` & Erase\\ + :strong:`\%n` & Part Number\\ + :strong:`\%m` & Mount Point\\ + :strong:`\%v` & Last Part Name \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): ============================ =================== **Variable** **Description** -``\%a`` Archive Device Name -``\%e`` Erase -``\%n`` Part Number -``\%m`` Mount Point -``\%v`` Last Part Name +:strong:`\%a` Archive Device Name +:strong:`\%e` Erase +:strong:`\%n` Part Number +:strong:`\%m` Mount Point +:strong:`\%v` Last Part Name ============================ =================== Variable Expansion on RunScripts @@ -979,48 +983,48 @@ At the configuration of mail and operator commands the following variables can b \begin{tabular}{p{2cm}p{7cm}} :strong:`Variable` & :strong:`Description` \\ - ``\%c`` & Client's Name\\ - ``\%d`` & Director's Name\\ - ``\%e`` & Job Exit Code\\ - ``\%i`` & JobId\\ - ``\%j`` & Unique Job Id\\ - ``\%l`` & Job Level\\ - ``\%n`` & Unadorned Job Name\\ - ``\%s`` & Since Time\\ - ``\%t`` & Job Type (Backup, ...)\\ - ``\%r`` & Recipients\\ - ``\%v`` & Read Volume Name\\ - ``\%V`` & Write Volume Name\\ - ``\%b`` & Job Bytes\\ - ``\%B`` & Job Bytes in human readable format \\ - ``\%F`` & Job Files + :strong:`\%c` & Client's Name\\ + :strong:`\%d` & Director's Name\\ + :strong:`\%e` & Job Exit Code\\ + :strong:`\%i` & JobId\\ + :strong:`\%j` & Unique Job Id\\ + :strong:`\%l` & Job Level\\ + :strong:`\%n` & Unadorned Job Name\\ + :strong:`\%s` & Since Time\\ + :strong:`\%t` & Job Type (Backup, ...)\\ + :strong:`\%r` & Recipients\\ + :strong:`\%v` & Read Volume Name\\ + :strong:`\%V` & Write Volume Name\\ + :strong:`\%b` & Job Bytes\\ + :strong:`\%B` & Job Bytes in human readable format \\ + :strong:`\%F` & Job Files \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): ============================ ================================== **Variable** **Description** -``\%c`` Client’s Name -``\%d`` Director’s Name -``\%e`` Job Exit Code -``\%i`` JobId -``\%j`` Unique Job Id -``\%l`` Job Level -``\%n`` Unadorned Job Name -``\%s`` Since Time -``\%t`` Job Type (Backup, ...) -``\%r`` Recipients -``\%v`` Read Volume Name -``\%V`` Write Volume Name -``\%b`` Job Bytes -``\%B`` Job Bytes in human readable format -``\%F`` Job Files +:strong:`\%c` Client’s Name +:strong:`\%d` Director’s Name +:strong:`\%e` Job Exit Code +:strong:`\%i` JobId +:strong:`\%j` Unique Job Id +:strong:`\%l` Job Level +:strong:`\%n` Unadorned Job Name +:strong:`\%s` Since Time +:strong:`\%t` Job Type (Backup, ...) +:strong:`\%r` Recipients +:strong:`\%v` Read Volume Name +:strong:`\%V` Write Volume Name +:strong:`\%b` Job Bytes +:strong:`\%B` Job Bytes in human readable format +:strong:`\%F` Job Files ============================ ================================== Resource Types ~~~~~~~~~~~~~~ -:index:`[TAG=Types->Resource] ` :index:`[TAG=Resource Types] ` +:index:`[TAG=Types->Resource] ` :index:`[TAG=Resource Types] ` .. _ResTypes: @@ -1028,7 +1032,7 @@ Resource Types The following table lists all current Bareos resource types. It shows what resources must be defined for each service (daemon). The default configuration files will already contain at least one example of each permitted resource. -\addcontentsline{lot}{table}{Resource Types} + # Tabular in LaTex format (original) @@ -1036,65 +1040,65 @@ The following table lists all current Bareos resource types. It shows what resou \begin{longtable}{|l||c|c|c|c|} \hline - :strong:`\bf Resource ` & + :strong:` Resource ` & :strong:` :ref:`Director ` ` & :strong:` :ref:`Client ` ` & :strong:` :ref:`Storage ` ` & :strong:` :ref:`Console ` ` \\ \hline \hline - {Autochanger} & & & :ref:`x ` & \\ + {Autochanger} & & & :ref:`|checkmark| ` & \\ \hline - {Catalog } & :ref:`x ` & & & \\ + {Catalog } & :ref:`|checkmark| ` & & & \\ \hline - {Client } & :ref:`x ` & :ref:`x ` & & \\ + {Client } & :ref:`|checkmark| ` & :ref:`|checkmark| ` & & \\ \hline - {Console } & :ref:`x ` & & & :ref:`x ` \\ + {Console } & :ref:`|checkmark| ` & & & :ref:`|checkmark| ` \\ \hline - {Device } & & & :ref:`x ` & \\ + {Device } & & & :ref:`|checkmark| ` & \\ \hline - {Director } & :ref:`x ` & :ref:`x ` & :ref:`x ` & :ref:`x ` \\ + {Director } & :ref:`|checkmark| ` & :ref:`|checkmark| ` & :ref:`|checkmark| ` & :ref:`|checkmark| ` \\ \hline - {FileSet } & :ref:`x ` & & & \\ + {FileSet } & :ref:`|checkmark| ` & & & \\ \hline - {Job} & :ref:`x ` & & & \\ + {Job} & :ref:`|checkmark| ` & & & \\ \hline - {JobDefs } & :ref:`x ` & & & \\ + {JobDefs } & :ref:`|checkmark| ` & & & \\ \hline - {Message } & :ref:`x ` & :ref:`x ` & :ref:`x ` & \\ + {Message } & :ref:`|checkmark| ` & :ref:`|checkmark| ` & :ref:`|checkmark| ` & \\ \hline - {NDMP } & & & :ref:`x ` & \\ + {NDMP } & & & :ref:`|checkmark| ` & \\ \hline - {Pool } & :ref:`x ` & & & \\ + {Pool } & :ref:`|checkmark| ` & & & \\ \hline - {Profile} & :ref:`x ` & & & \\ + {Profile} & :ref:`|checkmark| ` & & & \\ \hline - {Schedule } & :ref:`x ` & & & \\ + {Schedule } & :ref:`|checkmark| ` & & & \\ \hline - {Storage } & :ref:`x ` & & :ref:`x ` & \\ + {Storage } & :ref:`|checkmark| ` & & :ref:`|checkmark| ` & \\ \hline \end{longtable} # Tabular converted from LaTeX to RST (or empty, in case of problems): ================================================== ========================================================================== ===================================================================== ======================================================================= ========================================================================= -:strong:`\bf Resource ` :strong:` :ref:`Director ` ` :strong:` :ref:`Client ` ` :strong:` :ref:`Storage ` ` :strong:` :ref:`Console ` ` +:strong:` Resource ` :strong:` :ref:`Director ` ` :strong:` :ref:`Client ` ` :strong:` :ref:`Storage ` ` :strong:` :ref:`Console ` ` ================================================== ========================================================================== ===================================================================== ======================================================================= ========================================================================= -Autochanger :ref:`x ` -Catalog :ref:`x ` -Client :ref:`x ` :ref:`x ` -Console :ref:`x ` :ref:`x ` -Device :ref:`x ` -Director :ref:`x ` :ref:`x ` :ref:`x ` :ref:`x ` -FileSet :ref:`x ` -Job :ref:`x ` -JobDefs :ref:`x ` -Message :ref:`x ` :ref:`x ` :ref:`x ` -NDMP :ref:`x ` -Pool :ref:`x ` -Profile :ref:`x ` -Schedule :ref:`x ` -Storage :ref:`x ` :ref:`x ` +Autochanger :ref:`|checkmark| ` +Catalog :ref:`|checkmark| ` +Client :ref:`|checkmark| ` :ref:`|checkmark| ` +Console :ref:`|checkmark| ` :ref:`|checkmark| ` +Device :ref:`|checkmark| ` +Director :ref:`|checkmark| ` :ref:`|checkmark| ` :ref:`|checkmark| ` :ref:`|checkmark| ` +FileSet :ref:`|checkmark| ` +Job :ref:`|checkmark| ` +JobDefs :ref:`|checkmark| ` +Message :ref:`|checkmark| ` :ref:`|checkmark| ` :ref:`|checkmark| ` +NDMP :ref:`|checkmark| ` +Pool :ref:`|checkmark| ` +Profile :ref:`|checkmark| ` +Schedule :ref:`|checkmark| ` +Storage :ref:`|checkmark| ` :ref:`|checkmark| ` ================================================== ========================================================================== ===================================================================== ======================================================================= ========================================================================= .. _Names: @@ -1102,7 +1106,7 @@ Storage :ref:`x Names and Passwords] ` :index:`[TAG=Passwords] ` +:index:`[TAG=Authorization->Names and Passwords] ` :index:`[TAG=Passwords] ` In order for one daemon to contact another daemon, it must authorize itself with a password. In most cases, the password corresponds to a particular name, so both the name and the password must match to be authorized. Passwords are plain text, any text. They are not generated by any special process; just use random text. diff --git a/docs/manuals/en/new_main_reference/source/Configuration/Director.rst b/docs/manuals/en/new_main_reference/source/Configuration/Director.rst index fade28d3fc3..5b0b84d9a5f 100644 --- a/docs/manuals/en/new_main_reference/source/Configuration/Director.rst +++ b/docs/manuals/en/new_main_reference/source/Configuration/Director.rst @@ -7,17 +7,17 @@ Director Configuration .. _DirectorConfChapter: - :index:`[TAG=Director->Configuration] ` :index:`[TAG=Configuration->Director] ` + :index:`[TAG=Director->Configuration] ` :index:`[TAG=Configuration->Director] ` 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 recognized data types see :ref:`ConfigureChapter`. -:index:`[TAG=Types->Director Resource] ` :index:`[TAG=Director->Resource Types] ` :index:`[TAG=Resource Types] ` +:index:`[TAG=Types->Director Resource] ` :index:`[TAG=Director->Resource Types] ` :index:`[TAG=Resource Types] ` Everything revolves around a job and is tied to a job in one way or another. -The |bareosDir| knows about following resource types: +The |dir| knows about following resource types: - :ref:`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. @@ -44,7 +44,7 @@ The |bareosDir| knows about following resource types: Director Resource ----------------- -:index:`[TAG=Director Resource] ` :index:`[TAG=Resource->Director] ` +:index:`[TAG=Director Resource] ` :index:`[TAG=Resource->Director] ` The Director resource defines the attributes of the Directors running on the network. Only a single Director resource is allowed. @@ -144,7 +144,7 @@ Job Resource .. _JobResource: - :index:`[TAG=Resource->Job] ` :index:`[TAG=Job->Resource] ` + :index:`[TAG=Resource->Job] ` :index:`[TAG=Job->Resource] ` The Job resource defines a Job (Backup, Restore, ...) that Bareos must perform. Each Job resource definition contains the name of a Client and a FileSet to backup, the Schedule for the Job, where the data are to be stored, and what media Pool can be used. In effect, each Job resource must specify What, Where, How, and When or FileSet, Storage, Backup/Restore/Level, and Schedule respectively. Note, the FileSet must be specified for a restore job for historical reasons, but it is no longer used. @@ -345,7 +345,7 @@ The following is an example of a valid Job resource definition: JobDefs Resource ---------------- -:index:`[TAG=Job->JobDefs Resource] ` :index:`[TAG=Resource->JobDefs] ` +:index:`[TAG=Job->JobDefs Resource] ` :index:`[TAG=Resource->JobDefs] ` The JobDefs resource permits all the same directives that can appear in a Job resource. However, a JobDefs resource does not create a Job, rather it can be referenced within a Job to provide defaults for that Job. This permits you to concisely define several nearly identical Jobs, each one referencing a JobDefs resource which contains the defaults. Only the changes from the defaults need to be mentioned in each Job. @@ -354,7 +354,7 @@ The JobDefs resource permits all the same directives that can appear in a Job re Schedule Resource ----------------- -:index:`[TAG=Resource->Schedule] ` :index:`[TAG=Schedule->Resource] ` +:index:`[TAG=Resource->Schedule] ` :index:`[TAG=Schedule->Resource] ` The Schedule resource provides a means of automatically scheduling a Job as well as the ability to override the default Level, Pool, Storage and Messages resources. If a Schedule resource is not referenced in a Job, the Job can only be run manually. In general, you specify an action to be taken and when. @@ -461,7 +461,7 @@ w03/w05. Technical Notes on Schedules ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Schedule->Technical Notes on Schedules] ` +:index:`[TAG=Schedule->Technical Notes on Schedules] ` Internally Bareos keeps a schedule as a bit mask. There are six masks and a minute field to each schedule. The masks are hour, day of the month (mday), month, day of the week (wday), week of the month (wom), and week of the year (woy). The schedule is initialized to have the bits of each of these masks set, which means that at the beginning of every hour, the job will run. When you specify a month for the first time, the mask will be cleared and the bit corresponding to your selected month will be selected. If you specify a second month, the bit corresponding to it will also be added to the mask. Thus when Bareos checks the masks to see if the bits are set corresponding to the current time, your job will run only in the two months you have set. Likewise, if you set a time (hour), the hour mask will be cleared, and the hour you specify will be set in the bit mask and the minutes will be stored in the minute field. @@ -477,7 +477,7 @@ FileSet Resource .. _FileSetResource: - :index:`[TAG=Resource->FileSet] ` :index:`[TAG=FileSet->Resource] ` + :index:`[TAG=Resource->FileSet] ` :index:`[TAG=FileSet->Resource] ` The FileSet resource defines what files are to be included or excluded in a backup job. A FileSet resource is required for each backup Job. It consists of a list of files or directories to be included, a list of files or directories to be excluded and the various backup options such as compression, encryption, and signatures that are to be applied to each file. @@ -596,16 +596,12 @@ File = filename | dirname | | command | \Partitions] ` :index:`[TAG=Backup->Raw Partitions] ` If you explicitly specify a block device such as /dev/hda1, then Bareos will assume that this is a raw partition to be backed up. In this case, you are strongly urged to specify a sparse=yes include option, otherwise, you will save the whole partition rather than just the actual data that the partition contains. For example: + - :index:`[TAG=Backup->Partitions] ` :index:`[TAG=Backup->Raw Partitions] ` If you explicitly specify a block device such as /dev/hda1, then Bareos will assume that this is a raw partition to be backed up. In this case, you are strongly urged to specify a sparse=yes include option, otherwise, you will save the whole partition rather than just the actual data that the partition contains. For example: .. code-block:: bareosconfig :caption: Backup Raw Partitions @@ -772,7 +760,7 @@ The directives within an Options resource may be one of the following: \item [compression=] \\ :index:`[TAG=compression] ` - :index:`[TAG=Directive->compression] ` + :index:`[TAG=Directive->compression] ` Configures the software compression to be used by the File Daemon. The compression is done on a file by file basis. @@ -795,12 +783,12 @@ The directives within an Options resource may be one of the following: All files saved will be software compressed using the GNU ZIP compression format. - Specifying {\bf GZIP} uses the default compression level 6 (i.e. {\bf - GZIP} is identical to {\bf GZIP6}). If you want a different compression + Specifying :strong:`GZIP` uses the default compression level 6 (i.e. :strong:` + GZIP` is identical to :strong:`GZIP6`). If you want a different compression level (1 through 9), you can specify it by appending the level number - with no intervening spaces to {\bf GZIP}. Thus {\bf compression=GZIP1} - would give minimum compression but the fastest algorithm, and {\bf - compression=GZIP9} would give the highest level of compression, but + with no intervening spaces to :strong:`GZIP`. Thus :strong:`compression=GZIP1` + would give minimum compression but the fastest algorithm, and :strong:` + compression=GZIP9` would give the highest level of compression, but requires more computation. According to the GZIP documentation, compression levels greater than six generally give very little extra compression and are rather CPU intensive. @@ -840,8 +828,9 @@ The directives within an Options resource may be one of the following: -.. warning:: - As LZ4 compression is not supported by Bacula, make sure :config:option:`fd/client/Compatible`\ = no. + .. warning:: + + As LZ4 compression is not supported by Bacula, make sure :config:option:`fd/client/Compatible`\ = no. \item [compression=LZ4HC] \\ All files saved will be software compressed using the LZ4HC @@ -858,8 +847,9 @@ The directives within an Options resource may be one of the following: -.. warning:: - As LZ4 compression is not supported by Bacula, make sure :config:option:`fd/client/Compatible`\ = no. + .. warning:: + + As LZ4 compression is not supported by Bacula, make sure :config:option:`fd/client/Compatible`\ = no. \end{description} @@ -867,14 +857,14 @@ The directives within an Options resource may be one of the following: \item [signature=] \\ :index:`[TAG=signature] `% - :index:`[TAG=Directive->signature] `% + :index:`[TAG=Directive->signature] `% It is strongly recommend to use signatures for your backups. Note, only one type of signature can be computed per file. \begin{description} \item [signature=MD5] \\ :index:`[TAG=MD5] `% - :index:`[TAG=signature->MD5] `% + :index:`[TAG=signature->MD5] `% An MD5 signature will be computed for each files saved. Adding this option generates about 5\% extra overhead for each file saved. In addition to the additional CPU time, the MD5 signature adds 16 more @@ -882,7 +872,7 @@ The directives within an Options resource may be one of the following: \item [signature=SHA1] \\ :index:`[TAG=SHA1] `% - :index:`[TAG=signature->SHA1] `% + :index:`[TAG=signature->SHA1] `% An SHA1 signature will be computed for each files saved. The SHA1 algorithm is purported to be some what slower than the MD5 algorithm, but at the same @@ -892,32 +882,32 @@ The directives within an Options resource may be one of the following: \item [signature=SHA256] \\ :index:`[TAG=SHA256] `% - :index:`[TAG=signature->SHA256] `% + :index:`[TAG=signature->SHA256] `% \item [signature=SHA512] \\ :index:`[TAG=SHA512] `% - :index:`[TAG=signature->SHA512] `% + :index:`[TAG=signature->SHA512] `% \end{description} \item[basejob=] :index:`[TAG=basejob] ` - :index:`[TAG=Directive->basejob] ` + :index:`[TAG=Directive->basejob] ` - The options letters specified are used when running a {\bf Backup Level=Full} + The options letters specified are used when running a :strong:`Backup Level=Full` with BaseJobs. The options letters are the same than in the :strong:`verify=` option below. \item[accurate=] :index:`[TAG=Accurate] ` - :index:`[TAG=Directive->accurate] ` The options letters specified are used when - running a {\bf Backup Level=Incremental/Differential} in Accurate mode. The + :index:`[TAG=Directive->accurate] ` The options letters specified are used when + running a :strong:`Backup Level=Incremental/Differential` in Accurate mode. The options letters are the same than in the :strong:`verify=` option below. \item [verify=] \\ :index:`[TAG=verify] ` - :index:`[TAG=Directive->verify] ` - The options letters specified are used when running a {\bf Verify - Level=Catalog} as well as the {\bf DiskToCatalog} level job. The options + :index:`[TAG=Directive->verify] ` + The options letters specified are used when running a :strong:`Verify + Level=Catalog` as well as the :strong:`DiskToCatalog` level job. The options letters may be any combination of the following: \begin{description} @@ -963,14 +953,14 @@ The directives within an Options resource may be one of the following: \end{description} - A useful set of general options on the {\bf Level=Catalog} or {\bf - Level=DiskToCatalog} verify is {\bf pins5} i.e. compare permission bits, + A useful set of general options on the :strong:`Level=Catalog` or :strong:` + Level=DiskToCatalog` verify is :strong:`pins5` i.e. compare permission bits, inodes, number of links, size, and MD5 changes. \item [onefs=yes|no] \\ :index:`[TAG=onefs] ` - :index:`[TAG=Directive->onefs] ` - If set to {\bf yes} (the default), {\bf Bareos} will remain on a single + :index:`[TAG=Directive->onefs] ` + If set to :strong:`yes` (the default), :strong:`Bareos` will remain on a single file system. That is it will not backup file systems that are mounted on a subdirectory. If you are using a *nix system, you may not even be aware that there are several different filesystems as they are often @@ -980,8 +970,7 @@ The directives within an Options resource may be one of the following: to backup a particular partition. An example of the informational message in the job report is: - - \begin{verbatim} + \begin{verbatim}\begin{bmessage}{} rufus-fd: /misc is a different filesystem. Will not descend from / into /misc rufus-fd: /net is a different filesystem. Will not descend from / into /net rufus-fd: /var/lib/nfs/rpc_pipefs is a different filesystem. Will not descend from /var/lib/nfs into /var/lib/nfs/rpc_pipefs @@ -989,37 +978,35 @@ The directives within an Options resource may be one of the following: rufus-fd: /sys is a different filesystem. Will not descend from / into /sys rufus-fd: /dev is a different filesystem. Will not descend from / into /dev rufus-fd: /home is a different filesystem. Will not descend from / into /home - \end{verbatim} - + \end{bmessage}\end{verbatim} If you wish to backup multiple filesystems, you can explicitly list each filesystem you want saved. Otherwise, if you set the onefs option - to {\bf no}, Bareos will backup all mounted file systems (i.e. traverse mount - points) that are found within the {\bf FileSet}. Thus if you have NFS or + to :strong:`no`, Bareos will backup all mounted file systems (i.e. traverse mount + points) that are found within the :strong:`FileSet`. Thus if you have NFS or Samba file systems mounted on a directory listed in your FileSet, they will - also be backed up. Normally, it is preferable to set {\bf onefs=yes} and to + also be backed up. Normally, it is preferable to set :strong:`onefs=yes` and to explicitly name each filesystem you want backed up. Explicitly naming the filesystems you want backed up avoids the possibility of getting into a infinite loop recursing filesystems. Another possibility is to - use {\bf onefs=no} and to set {\bf fstype=ext2, ...}. + use :strong:`onefs=no` and to set :strong:`fstype=ext2, ...`. See the example below for more details. If you think that Bareos should be backing up a particular directory - and it is not, and you have {\bf onefs=no} set, before you complain, + and it is not, and you have :strong:`onefs=no` set, before you complain, please do: - - \begin{verbatim} - stat / - stat - \end{verbatim} - - where you replace {\bf filesystem} with the one in question. If the - {\bf Device:} number is different for / and for your filesystem, then they + \begin{verbatim}\begin{commands}{} + stat / + stat + \end{commands}\end{verbatim} + + where you replace :strong:`filesystem` with the one in question. If the + :strong:`Device:` number is different for / and for your filesystem, then they are on different filesystems. E.g. - - \begin{verbatim} + + \begin{verbatim}\begin{commands}{} stat / File: `/' Size: 4096 Blocks: 16 IO Block: 4096 directory @@ -1037,90 +1024,88 @@ The directives within an Options resource may be one of the following: Access: 2005-11-10 12:28:02.000000000 +0100 Modify: 2005-11-06 12:36:48.000000000 +0100 Change: 2005-11-06 12:36:48.000000000 +0100 - \end{verbatim} - + \end{commands}\end{verbatim} + - Also be aware that even if you include {\bf /home} in your list + Also be aware that even if you include :strong:`/home` in your list of files to backup, as you most likely should, you will get the informational message that "/home is a different filesystem" when - Bareos is processing the {\bf /} directory. This message does not + Bareos is processing the :strong:`/` directory. This message does not indicate an error. This message means that while examining the - {\bf File =} referred to in the second part of the message, Bareos will + :strong:`File =` referred to in the second part of the message, Bareos will not descend into the directory mentioned in the first part of the message. However, it is possible that the separate filesystem will be backed up despite the message. For example, consider the following FileSet: - - \begin{verbatim} + \begin{verbatim}\begin{bconfig}{} File = / File = /var - \end{verbatim} - + \end{bconfig}\end{verbatim} - where {\bf /var} is a separate filesystem. In this example, you will get a - message saying that Bareos will not decend from {\bf /} into {\bf /var}. But - it is important to realise that Bareos will descend into {\bf /var} from the + where :strong:`/var` is a separate filesystem. In this example, you will get a + message saying that Bareos will not decend from :strong:`/` into :strong:`/var`. But + it is important to realise that Bareos will descend into :strong:`/var` from the second File directive shown above. In effect, the warning is bogus, but it is supplied to alert you to possible omissions from your FileSet. In - this example, {\bf /var} will be backed up. If you changed the FileSet such - that it did not specify {\bf /var}, then {\bf /var} will not be backed up. + this example, :strong:`/var` will be backed up. If you changed the FileSet such + that it did not specify :strong:`/var`, then :strong:`/var` will not be backed up. \item [honor nodump flag=] \\ :index:`[TAG=honornodumpflag] ` - :index:`[TAG=Directive->honornodumpflag] ` - If your file system supports the {\bf nodump} flag (e. g. most + :index:`[TAG=Directive->honornodumpflag] ` + If your file system supports the :strong:`nodump` flag (e. g. most BSD-derived systems) Bareos will honor the setting of the flag - when this option is set to {\bf yes}. Files having this flag set + when this option is set to :strong:`yes`. Files having this flag set will not be included in the backup and will not show up in the - catalog. For directories with the {\bf nodump} flag set recursion + catalog. For directories with the :strong:`nodump` flag set recursion is turned off and the directory will be listed in the catalog. - If the {\bf honor nodump flag} option is not defined - or set to {\bf no} every file and directory will be eligible for + If the :strong:`honor nodump flag` option is not defined + or set to :strong:`no` every file and directory will be eligible for backup. \item [portable=yes|no] \\ :index:`[TAG=portable] ` - :index:`[TAG=Directive->portable] ` + :index:`[TAG=Directive->portable] ` .. _portable: - If set to {\bf yes} (default is {\bf no}), the Bareos File daemon will + If set to :strong:`yes` (default is :strong:`no`), the Bareos File daemon will backup Win32 files in a portable format, but not all Win32 file attributes will be saved and restored. By default, this option is set - to {\bf no}, which means that on Win32 systems, the data will be backed + to :strong:`no`, which means that on Win32 systems, the data will be backed up using Windows API calls and on WinNT/2K/XP, all the security and ownership attributes will be properly backed up (and restored). However this format is not portable to other systems -- e.g. Unix, Win95/98/Me. When backing up Unix systems, this option is ignored, and unless you have a specific need to have portable backups, we recommend accept the - default ({\bf no}) so that the maximum information concerning your files + default (:strong:`no`) so that the maximum information concerning your files is saved. \item [recurse=yes|no] \\ :index:`[TAG=recurse] ` - :index:`[TAG=Directive->recurse] ` - If set to {\bf yes} (the default), Bareos will recurse (or descend) into + :index:`[TAG=Directive->recurse] ` + If set to :strong:`yes` (the default), Bareos will recurse (or descend) into all subdirectories found unless the directory is explicitly excluded - using an {\bf exclude} definition. If you set {\bf recurse=no}, Bareos + using an :strong:`exclude` definition. If you set :strong:`recurse=no`, Bareos will save the subdirectory entries, but not descend into the subdirectories, and thus will not save the files or directories contained in the subdirectories. Normally, you will want the default - ({\bf yes}). + (:strong:`yes`). \item [sparse=yes|no] \\ :index:`[TAG=sparse] ` - :index:`[TAG=Directive->sparse] ` + :index:`[TAG=Directive->sparse] ` Enable special code that checks for sparse files such as created by - ndbm. The default is {\bf no}, so no checks are made for sparse files. - You may specify {\bf sparse=yes} even on files that are not sparse file. + ndbm. The default is :strong:`no`, so no checks are made for sparse files. + You may specify :strong:`sparse=yes` even on files that are not sparse file. No harm will be done, but there will be a small additional overhead to check for buffers of all zero, and if there is a 32K block of all zeros (see below), that block will become a hole in the file, which may not be desirable if the original file was not a sparse file. - {\bf Restrictions:} Bareos reads files in 32K buffers. If the whole + :strong:`Restrictions:` Bareos reads files in 32K buffers. If the whole buffer is zero, it will be treated as a sparse block and not written to tape. However, if any part of the buffer is non-zero, the whole buffer will be written to tape, possibly including some disk sectors (generally @@ -1138,7 +1123,7 @@ The directives within an Options resource may be one of the following: such a file, a lot of space will be used to write zeros to the volume. Worse yet, when you restore the file, all the previously empty space will now be allocated using much more disk space. By turning on the - {\bf sparse} option, Bareos will specifically look for empty space in + :strong:`sparse` option, Bareos will specifically look for empty space in the file, and any empty space will not be written to the Volume, nor will it be restored. The price to pay for this is that Bareos must search each block it reads before writing it. On a slow system, this @@ -1151,7 +1136,7 @@ The directives within an Options resource may be one of the following: \item [readfifo=yes|no] \\ :index:`[TAG=readfifo] ` - :index:`[TAG=Directive->readfifo] ` + :index:`[TAG=Directive->readfifo] ` .. _readfifo: @@ -1161,7 +1146,7 @@ The directives within an Options resource may be one of the following: data on a restore to any FIFO (pipe) that is explicitly mentioned in the FileSet. In this case, you must have a program already running that writes into the FIFO for a backup or reads from the FIFO on a restore. - This can be accomplished with the {\bf RunBeforeJob} directive. If this + This can be accomplished with the :strong:`RunBeforeJob` directive. If this is not the case, Bareos will hang indefinitely on reading/writing the FIFO. When this is not enabled (default), the Client simply saves the directory entry for the FIFO. @@ -1173,9 +1158,9 @@ The directives within an Options resource may be one of the following: to work correctly. He simply adds the following to the beginning of the RunBeforeJob script: - \begin{verbatim} - exec > /dev/null - \end{verbatim} + \begin{verbatim}\begin{commands}{} + exec > /dev/null + \end{commands}\end{verbatim} \begin{verbatim}\begin{bconfig}{FileSet with Fifo} @@ -1189,7 +1174,7 @@ The directives within an Options resource may be one of the following: \end{bconfig}\end{verbatim} This feature can be used to do a "hot" database backup. - You can use the {\bf RunBeforeJob} to create the fifo + You can use the :strong:`RunBeforeJob` to create the fifo and to start a program that dynamically reads your database and writes it to the fifo. Bareos will then write it to the Volume. @@ -1206,7 +1191,7 @@ The directives within an Options resource may be one of the following: \item [noatime=yes|no] \\ :index:`[TAG=noatime] ` - :index:`[TAG=Directive->noatime] ` + :index:`[TAG=Directive->noatime] ` If enabled, and if your Operating System supports the O\_NOATIME file open flag, Bareos will open all files to be backed up with this option. It makes it possible to read a file without updating the inode atime @@ -1217,7 +1202,7 @@ The directives within an Options resource may be one of the following: file integrity checkers (and Bareos can fit on both categories). This option is particularly useful for sites where users are sensitive - to their MailBox file access time. It replaces both the {\bf keepatime} + to their MailBox file access time. It replaces both the :strong:`keepatime` option without the inconveniences of that option (see below). If your Operating System does not support this option, it will be @@ -1226,18 +1211,18 @@ The directives within an Options resource may be one of the following: \item [mtimeonly=yes|no] \\ :index:`[TAG=mtimeonly] ` - :index:`[TAG=Directive->mtimeonly] ` + :index:`[TAG=Directive->mtimeonly] ` If enabled, tells the Client that the selection of files during Incremental and Differential backups should based only on the st\_mtime - value in the stat() packet. The default is {\bf no} which means that + value in the stat() packet. The default is :strong:`no` which means that the selection of files to be backed up will be based on both the st\_mtime and the st\_ctime values. In general, it is not recommended to use this option. \item [keepatime=yes|no] \\ :index:`[TAG=keepatime] ` - :index:`[TAG=Directive->keepatime] ` - The default is {\bf no}. When enabled, Bareos will reset the st\_atime + :index:`[TAG=Directive->keepatime] ` + The default is :strong:`no`. When enabled, Bareos will reset the st\_atime (access time) field of files that it backs up to their value prior to the backup. This option is not generally recommended as there are very few programs that use st\_atime, and the backup overhead is increased @@ -1251,25 +1236,25 @@ The directives within an Options resource may be one of the following: change time (st\_ctime) will automatically be modified by the system, so on the next incremental job, the file will be backed up even if it has not changed. As a consequence, you will probably also want - to use {\bf mtimeonly = yes} as well as keepatime (thanks to + to use :strong:`mtimeonly = yes` as well as keepatime (thanks to Rudolf Cejka for this tip). \item [checkfilechanges=yes|no] \\ :index:`[TAG=checkfilechanges] ` - :index:`[TAG=Directive->checkfilechanges] ` + :index:`[TAG=Directive->checkfilechanges] ` If enabled, the Client will check size, age of each file after their backup to see if they have changed during backup. If time or size mismatch, an error will raise. - \begin{verbatim} + \begin{verbatim}\begin{bmessage}{} zog-fd: Client1.2007-03-31_09.46.21 Error: /tmp/test mtime changed during backup. - \end{verbatim} + \end{bmessage}\end{verbatim} In general, it is recommended to use this option. \item [hardlinks=yes|no] \\ :index:`[TAG=hardlinks] ` - :index:`[TAG=Directive->hardlinks] ` + :index:`[TAG=Directive->hardlinks] ` When enabled (default), this directive will cause hard links to be backed up. However, the File daemon keeps track of hard linked files and will backup the data only once. The process of keeping track of the @@ -1278,16 +1263,16 @@ The directives within an Options resource may be one of the following: you use a program like BackupPC, it can create hundreds of thousands, or even millions of hard links. Backups become very long and the File daemon will consume a lot of CPU power checking hard links. In such a case, - set {\bf hardlinks=no} and hard links will not be backed up. Note, using + set :strong:`hardlinks=no` and hard links will not be backed up. Note, using this option will most likely backup more data and on a restore the file system will not be restored identically to the original. \item [wild=] \\ :index:`[TAG=wild] ` - :index:`[TAG=Directive->wild] ` + :index:`[TAG=Directive->wild] ` Specifies a wild-card string to be applied to the filenames and - directory names. Note, if {\bf Exclude} is not enabled, the wild-card - will select which files are to be included. If {\bf Exclude=yes} is + directory names. Note, if :strong:`Exclude` is not enabled, the wild-card + will select which files are to be included. If :strong:`Exclude=yes` is specified, the wild-card will select which files are to be excluded. Multiple wild-card directives may be specified, and they will be applied in turn until the first one that matches. Note, if you exclude a @@ -1301,11 +1286,11 @@ The directives within an Options resource may be one of the following: \item [wilddir=] \\ :index:`[TAG=wilddir] ` - :index:`[TAG=Directive->wilddir] ` + :index:`[TAG=Directive->wilddir] ` Specifies a wild-card string to be applied to directory names only. No - filenames will be matched by this directive. Note, if {\bf Exclude} is + filenames will be matched by this directive. Note, if :strong:`Exclude` is not enabled, the wild-card will select directories to be - included. If {\bf Exclude=yes} is specified, the wild-card will select + included. If :strong:`Exclude=yes` is specified, the wild-card will select which directories are to be excluded. Multiple wild-card directives may be specified, and they will be applied in turn until the first one that matches. Note, if you exclude a directory, no files or directories @@ -1320,15 +1305,15 @@ The directives within an Options resource may be one of the following: \item [wildfile=] \\ :index:`[TAG=wildfile] ` - :index:`[TAG=Directive->wildfile] ` + :index:`[TAG=Directive->wildfile] ` Specifies a wild-card string to be applied to non-directories. That is no directory entries will be matched by this directive. However, note that the match is done against the full path and filename, so your wild-card string must take into account that filenames are preceded by the full path. - If {\bf Exclude} + If :strong:`Exclude` is not enabled, the wild-card will select which files are to be - included. If {\bf Exclude=yes} is specified, the wild-card will select + included. If :strong:`Exclude=yes` is specified, the wild-card will select which files are to be excluded. Multiple wild-card directives may be specified, and they will be applied in turn until the first one that matches. @@ -1344,7 +1329,7 @@ The directives within an Options resource may be one of the following: \item [regex=] \\ :index:`[TAG=regex] ` - :index:`[TAG=Directive->regex] ` + :index:`[TAG=Directive->regex] ` @@ -1353,9 +1338,9 @@ The directives within an Options resource may be one of the following: Specifies a POSIX extended regular expression to be applied to the - filenames and directory names, which include the full path. If {\bf - Exclude} is not enabled, the regex will select which files are to be - included. If {\bf Exclude=yes} is specified, the regex will select + filenames and directory names, which include the full path. If :strong:` + Exclude` is not enabled, the regex will select which files are to be + included. If :strong:`Exclude=yes` is specified, the regex will select which files are to be excluded. Multiple regex directives may be specified within an Options resource, and they will be applied in turn until the first one that matches. Note, if you exclude a directory, no @@ -1377,14 +1362,14 @@ The directives within an Options resource may be one of the following: \item [regexfile=] \\ :index:`[TAG=regexfile] ` - :index:`[TAG=Directive->regexfile] ` + :index:`[TAG=Directive->regexfile] ` Specifies a POSIX extended regular expression to be applied to non-directories. No directories will be matched by this directive. However, note that the match is done against the full path and filename, so your regex string must take into account that filenames are preceded by the full path. - If {\bf Exclude} is not enabled, the regex will select which files are - to be included. If {\bf Exclude=yes} is specified, the regex will + If :strong:`Exclude` is not enabled, the regex will select which files are + to be included. If :strong:`Exclude=yes` is specified, the regex will select which files are to be excluded. Multiple regex directives may be specified, and they will be applied in turn until the first one that matches. @@ -1398,11 +1383,11 @@ The directives within an Options resource may be one of the following: \item [regexdir=] \\ :index:`[TAG=regexdir] ` - :index:`[TAG=Directive->regexdir] ` + :index:`[TAG=Directive->regexdir] ` Specifies a POSIX extended regular expression to be applied to directory names only. No filenames will be matched by this directive. Note, if - {\bf Exclude} is not enabled, the regex will select directories - files are to be included. If {\bf Exclude=yes} is specified, the + :strong:`Exclude` is not enabled, the regex will select directories + files are to be included. If :strong:`Exclude=yes` is specified, the regex will select which files are to be excluded. Multiple regex directives may be specified, and they will be applied in turn until the first one that matches. Note, if you exclude a directory, no @@ -1421,18 +1406,18 @@ The directives within an Options resource may be one of the following: \item [aclsupport=yes|no] \\ :index:`[TAG=aclsupport] ` - :index:`[TAG=Directive->aclsupport] ` + :index:`[TAG=Directive->aclsupport] ` .. _ACLSupport: - The default is {\bf yes} since Bareos 18.2. If this option is set to yes, and you have the - POSIX {\bf libacl} installed on your Linux system, Bareos will backup the + The default is :strong:`yes` since Bareos 18.2. If this option is set to yes, and you have the + POSIX :strong:`libacl` installed on your Linux system, Bareos will backup the file and directory Unix Access Control Lists (ACL) as defined in IEEE Std 1003.1e draft 17 and "POSIX.1e" (abandoned). This feature is available on Unix systems only and requires the Linux ACL library. Bareos is - automatically compiled with ACL support if the {\bf libacl} library is + automatically compiled with ACL support if the :strong:`libacl` library is installed on your Linux system (shown in config.out). While restoring the files Bareos will try to restore the ACLs, if there is no ACL support available on the system, Bareos restores the files and directories but @@ -1467,14 +1452,14 @@ The directives within an Options resource may be one of the following: \item [xattrsupport=yes|no] \\ :index:`[TAG=xattrsupport] ` - :index:`[TAG=Directive->xattrsupport] ` - The default is {\bf yes} since Bareos 18.2. If this option is set to yes, and your + :index:`[TAG=Directive->xattrsupport] ` + The default is :strong:`yes` since Bareos 18.2. If this option is set to yes, and your operating system support either so called Extended Attributes or Extensible Attributes Bareos will backup the file and directory XATTR data. This feature is available on UNIX only and depends on support of some specific library calls in libc. - The XATTR stream format between Operating Systems is {\bf not} + The XATTR stream format between Operating Systems is :strong:`not` compatible so an XATTR saved on Linux cannot for example be restored on Solaris. @@ -1498,15 +1483,15 @@ The directives within an Options resource may be one of the following: \item [ignore case=yes|no] \\ :index:`[TAG=ignore case] ` - :index:`[TAG=Directive->ignore case] ` - The default is {\bf no}. On Windows systems, you will almost surely - want to set this to {\bf yes}. When this directive is set to {\bf yes} + :index:`[TAG=Directive->ignore case] ` + The default is :strong:`no`. On Windows systems, you will almost surely + want to set this to :strong:`yes`. When this directive is set to :strong:`yes` all the case of character will be ignored in wild-card and regex comparisons. That is an uppercase A will match a lowercase a. \item [fstype=filesystem-type] \\ :index:`[TAG=fstype] ` - :index:`[TAG=Directive->fstype] ` + :index:`[TAG=Directive->fstype] ` This option allows you to select files and directories by the filesystem type. The permitted filesystem-type names are: @@ -1519,15 +1504,15 @@ The directives within an Options resource may be one of the following: filesystem for a particular directive, that directory will not be backed up. This directive can be used to prevent backing up non-local filesystems. Normally, when you use this directive, you - would also set {\bf onefs=no} so that Bareos will traverse filesystems. + would also set :strong:`onefs=no` so that Bareos will traverse filesystems. This option is not implemented in Win32 systems. \item [DriveType=Windows-drive-type] \\ :index:`[TAG=DriveType] ` - :index:`[TAG=Directive->DriveType] ` + :index:`[TAG=Directive->DriveType] ` This option is effective only on Windows machines and is - somewhat similar to the Unix/Linux {\bf fstype} described + somewhat similar to the Unix/Linux :strong:`fstype` described above, except that it allows you to select what Windows drive types you want to allow. By default all drive types are accepted. @@ -1542,20 +1527,20 @@ The directives within an Options resource may be one of the following: filesystem for a particular directive, that directory will not be backed up. This directive can be used to prevent backing up non-local filesystems. Normally, when you use this directive, you - would also set {\bf onefs=no} so that Bareos will traverse filesystems. + would also set :strong:`onefs=no` so that Bareos will traverse filesystems. This option is not implemented in Unix/Linux systems. \item [hfsplussupport=yes|no] \\ :index:`[TAG=hfsplussupport] ` - :index:`[TAG=Directive->hfsplussupport] ` + :index:`[TAG=Directive->hfsplussupport] ` This option allows you to turn on support for Mac OSX HFS plus finder information. \item [strippath=] \\ :index:`[TAG=strippath] ` - :index:`[TAG=Directive->strippath] ` - This option will cause {\bf integer} paths to be stripped from + :index:`[TAG=Directive->strippath] ` + This option will cause :strong:`integer` paths to be stripped from the front of the full path/filename being backed up. This can be useful if you are migrating data from another vendor or if you have taken a snapshot into some subdirectory. This directive @@ -1564,7 +1549,7 @@ The directives within an Options resource may be one of the following: \item [size=sizeoption] \\ :index:`[TAG=size] ` - :index:`[TAG=Directive->size] ` + :index:`[TAG=Directive->size] ` This option will allow you to select files by their actual size. You can select either files smaller than a certain size or bigger then a certain size, files of a size in a certain range or files @@ -1581,8 +1566,8 @@ The directives within an Options resource may be one of the following: \item [shadowing=none|localwarn|localremove|globalwarn|globalremove] \\ :index:`[TAG=shadowing] ` - :index:`[TAG=Directive->shadowing] ` - The default is {\bf none}. This option performs a check within the + :index:`[TAG=Directive->shadowing] ` + The default is :strong:`none`. This option performs a check within the fileset for any file-list entries which are shadowing each other. Lets say you specify / and /usr but /usr is not a separate filesystem. Then in the normal situation both / and /usr would lead to data being @@ -1623,7 +1608,7 @@ The directives within an Options resource may be one of the following: \item [meta=tag] \\ :index:`[TAG=meta] ` - :index:`[TAG=Directive->meta] ` + :index:`[TAG=Directive->meta] ` This option will add a meta tag to a fileset. These meta tags are used by the Native NDMP protocol to pass NDMP backup or restore environment variables via the Data Management Agent (DMA) in Bareos to the remote @@ -1670,12 +1655,12 @@ For example: } } -Another way to exclude files and directories is to use the :strong:`Exclude` option from the Include section. +Another way to exclude files and directories is to use the :strong:`Exclude`\ option from the Include section. FileSet Examples ~~~~~~~~~~~~~~~~ -:index:`[TAG=Example->FileSet] ` :index:`[TAG=FileSet->Example] ` +:index:`[TAG=Example->FileSet] ` :index:`[TAG=FileSet->Example] ` The following is an example of a valid FileSet resource definition. Note, the first Include pulls in the contents of the file :file:`/etc/backup.list` when Bareos is started (i.e. the @), and that file must have each filename to be backed up preceded by a File = and on a separate line. @@ -1740,7 +1725,7 @@ You can add wild-cards to the File directives listed in the Exclude directory, b Now lets take a slight variation on the above and suppose you want to save all your whole filesystem except :file:`/tmp`. The problem that comes up is that Bareos will not normally cross from one filesystem to another. Doing a :command:`df` command, you get the following output: -.. code-block:: sh +.. code-block:: shell-session :caption: df df @@ -1960,7 +1945,7 @@ The FileSet resource definition below implements this by including specifc direc Windows FileSets ~~~~~~~~~~~~~~~~ -:index:`[TAG=Windows->FileSet] ` :index:`[TAG=FileSet->Windows] ` +:index:`[TAG=Windows->FileSet] ` :index:`[TAG=FileSet->Windows] ` .. _win32: @@ -1997,9 +1982,9 @@ Thanks to Thiago Lima for summarizing the above items for us. If you are having On Win32 systems, if you move a directory or file or rename a file into the set of files being backed up, and a Full backup has already been made, Bareos will not know there are new files to be saved during an Incremental or Differential backup (blame Microsoft, not us). To avoid this problem, please copy any new directory or files into the backup area. If you do not have enough disk to copy the directory or files, move them, but then initiate a Full backup. Example Fileset for Windows -''''''''''''''''''''''''''' +^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=FileSet->Windows Example] ` :index:`[TAG=Windows->FileSet->Example] ` +:index:`[TAG=FileSet->Windows Example] ` :index:`[TAG=Windows->FileSet->Example] ` The following example demostrates a Windows FileSet. It backups all data from all fixed drives and only excludes some Windows temporary data. @@ -2024,12 +2009,12 @@ The following example demostrates a Windows FileSet. It backups all data from al } } -\variable{File = /} includes all Windows drives. Using \variable{Drive Type = fixed} excludes drives like USB-Stick or CD-ROM Drive. Using \variable{WildDir = "[A-Z]:/RECYCLER"} excludes the backup of the directory :file:`RECYCLER` from all drives. +``File = /``\ includes all Windows drives. Using ``Drive Type = fixed``\ excludes drives like USB-Stick or CD-ROM Drive. Using ``WildDir = "[A-Z]:/RECYCLER"``\ excludes the backup of the directory :file:`RECYCLER` from all drives. Testing Your FileSet ~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=FileSet->Testing Your] ` :index:`[TAG=Testing Your FileSet] ` +:index:`[TAG=FileSet->Testing Your] ` :index:`[TAG=Testing Your FileSet] ` If you wish to get an idea of what your FileSet will really backup or if your exclusion rules will work correctly, you can test it by using the :ref:`estimate ` command. @@ -2062,7 +2047,7 @@ to give you a listing of all files that match. In the above example, it should b Client Resource --------------- -:index:`[TAG=Resource->Client] ` :index:`[TAG=Client Resource] ` +:index:`[TAG=Resource->Client] ` :index:`[TAG=Client Resource] ` The Client (or FileDaemon) resource defines the attributes of the Clients that are served by this Director; that is the machines that are to be backed up. You will need one Client resource definition for each machine to be backed up. @@ -2180,7 +2165,7 @@ The following is an example of a Quota Configuration in Client resource: Storage Resource ---------------- -:index:`[TAG=Resource->Storage] ` :index:`[TAG=Storage Resource] ` +:index:`[TAG=Resource->Storage] ` :index:`[TAG=Storage Resource] ` The Storage resource defines which Storage daemons are available for use by the Director. @@ -2268,7 +2253,7 @@ The following is an example of a valid Storage resource definition: Pool Resource ------------- -:index:`[TAG=Resource->Pool] ` :index:`[TAG=Pool Resource] ` +:index:`[TAG=Resource->Pool] ` :index:`[TAG=Pool Resource] ` The Pool resource defines the set of storage Volumes (tapes or files) to be used by Bareos to write the data. By configuring different Pools, you can determine which set of Volumes (media) receives the backup data. This permits, for example, to store all full backup data on one set of Volumes and all incremental backups on another set of Volumes. Alternatively, you could assign a different set of Volumes to each machine that you backup. This is most easily done by defining multiple Pools. @@ -2375,7 +2360,7 @@ The following is an example of a valid Pool resource definition: Scratch Pool ~~~~~~~~~~~~ -:index:`[TAG=Scratch Pool] ` :index:`[TAG=Pool->Scratch] ` +:index:`[TAG=Scratch Pool] ` :index:`[TAG=Pool->Scratch] ` In general, you can give your Pools any name you wish, but there is one important restriction: the Pool named Scratch, if it exists behaves like a scratch pool of Volumes in that when Bareos needs a new Volume for writing and it cannot find one, it will look in the Scratch pool, and if it finds an available Volume, it will move it out of the Scratch pool into the Pool currently being used by the job. @@ -2384,7 +2369,7 @@ In general, you can give your Pools any name you wish, but there is one importan Catalog Resource ---------------- -:index:`[TAG=Resource->Catalog] ` :index:`[TAG=Catalog Resource] ` +:index:`[TAG=Resource->Catalog] ` :index:`[TAG=Catalog Resource] ` The Catalog Resource defines what catalog to use for the current job. Currently, Bareos can only handle a single database server (SQLite, MySQL, PostgreSQL) that is defined when configuring Bareos. However, there may be as many Catalogs (databases) defined as you wish. For example, you may want each Client to have its own Catalog database, or you may want backup jobs to use one database and verify or restore jobs to use another database. @@ -2465,7 +2450,7 @@ or for a Catalog on another machine: Messages Resource ----------------- -:index:`[TAG=Resource->Messages] ` :index:`[TAG=Messages Resource] ` +:index:`[TAG=Resource->Messages] ` :index:`[TAG=Messages Resource] ` For the details of the Messages Resource, please see the :ref:`MessagesChapter` of this manual. @@ -2474,15 +2459,15 @@ For the details of the Messages Resource, please see the :ref:`MessagesChapter` Console Resource ---------------- -:index:`[TAG=Console Resource] ` :index:`[TAG=Resource->Console] ` +:index:`[TAG=Console Resource] ` :index:`[TAG=Resource->Console] ` There are three different kinds of consoles, which the administrator or user can use to interact with the Director. These three kinds of consoles comprise three different security levels. Default Console - :index:`[TAG=Console->Default Console] ` the first console type is an ''anonymous'' or ''default'' console, which has full privileges. There is no console resource necessary for this type since the password is specified in the Director’s resource and consequently such consoles do not have a name as defined on a :strong:`Name` directive. Typically you would use it only for administrators. + :index:`[TAG=Console->Default Console] ` the first console type is an "anonymous" or "default" console, which has full privileges. There is no console resource necessary for this type since the password is specified in the Director’s resource and consequently such consoles do not have a name as defined on a :strong:`Name`\ directive. Typically you would use it only for administrators. Named Console - :index:`[TAG=Named Console] ` :index:`[TAG=Console->Named Console] ` :index:`[TAG=Console->Restricted Console] ` the second type of console, is a ''named'' console (also called ''Restricted Console'') defined within a Console resource in both the Director’s configuration file and in the Console’s configuration file. Both the names and the passwords in these two entries must match much as is the case for Client programs. + :index:`[TAG=Named Console] ` :index:`[TAG=Console->Named Console] ` :index:`[TAG=Console->Restricted Console] ` the second type of console, is a "named" console (also called "Restricted Console") defined within a Console resource in both the Director’s configuration file and in the Console’s configuration file. Both the names and the passwords in these two entries must match much as is the case for Client programs. This second type of console begins with absolutely no privileges except those explicitly specified in the Director’s Console resource. Thus 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. Examples of this are shown below. @@ -2551,9 +2536,9 @@ The example at :ref:`section-ConsoleAccessExample` shows how to use a console re Profile Resource ---------------- -:index:`[TAG=Profile Resource] ` :index:`[TAG=Resource->Profile] ` +:index:`[TAG=Profile Resource] ` :index:`[TAG=Resource->Profile] ` -The Profile Resource defines a set of ACLs. :ref:`DirectorResourceConsole`s can be tight to one or more profiles (:config:option:`dir/console/Profile`\ ), making it easier to use a common set of ACLs. +The Profile Resource defines a set of ACLs. :ref:`DirectorResourceConsole` can be tight to one or more profiles (:config:option:`dir/console/Profile`\ ), making it easier to use a common set of ACLs. @@ -2586,7 +2571,7 @@ The Profile Resource defines a set of ACLs. :ref:`DirectorResourceConsole`s can Counter Resource ---------------- -:index:`[TAG=Resource->Counter] ` :index:`[TAG=Counter Resource] ` +:index:`[TAG=Resource->Counter] ` :index:`[TAG=Counter Resource] ` The Counter Resource defines a counter variable that can be accessed by variable expansion used for creating Volume labels with the :config:option:`dir/pool/LabelFormat`\ directive. diff --git a/docs/manuals/en/new_main_reference/source/Configuration/FileDaemon.rst b/docs/manuals/en/new_main_reference/source/Configuration/FileDaemon.rst index d3bd81f6607..2131d6c75d3 100644 --- a/docs/manuals/en/new_main_reference/source/Configuration/FileDaemon.rst +++ b/docs/manuals/en/new_main_reference/source/Configuration/FileDaemon.rst @@ -3,7 +3,7 @@ Client/File Daemon Configuration ================================ -:index:`[TAG=Configuration->Client/File daemon] ` :index:`[TAG=Client/File daemon Configuration] ` +:index:`[TAG=Configuration->Client/File daemon] ` :index:`[TAG=Client/File daemon Configuration] ` The Client (or File Daemon) Configuration is one of the simpler ones to specify. Generally, other than changing the Client name so that error messages are easily identified, you will not need to modify the default Client configuration file. @@ -20,7 +20,7 @@ For a general discussion of configuration file and resources including the data Client Resource --------------- -:index:`[TAG=Resource->Client] ` :index:`[TAG=Client Resource] ` +:index:`[TAG=Resource->Client] ` :index:`[TAG=Client Resource] ` The Client Resource (or FileDaemon) resource defines the name of the Client (as used by the Director) as well as the port on which the Client listens for Director connections. @@ -129,7 +129,7 @@ The following is an example of a valid Client resource definition: Director Resource ----------------- -:index:`[TAG=Director Resource] ` :index:`[TAG=Resource->Director] ` +:index:`[TAG=Director Resource] ` :index:`[TAG=Resource->Director] ` The Director resource defines the name and password of the Directors that are permitted to contact this Client. @@ -205,7 +205,7 @@ The following is an example of a valid Director resource definition: Messages Resource ----------------- -:index:`[TAG=Messages Resource] ` :index:`[TAG=Resource->Messages] ` +:index:`[TAG=Messages Resource] ` :index:`[TAG=Resource->Messages] ` Please see the :ref:`Messages Resource ` Chapter of this manual for the details of the Messages Resource. diff --git a/docs/manuals/en/new_main_reference/source/Configuration/Messages.rst b/docs/manuals/en/new_main_reference/source/Configuration/Messages.rst index 1f75d91ea14..1cfcccace96 100644 --- a/docs/manuals/en/new_main_reference/source/Configuration/Messages.rst +++ b/docs/manuals/en/new_main_reference/source/Configuration/Messages.rst @@ -7,21 +7,21 @@ Messages Configuration .. _ResourceMessages: - :index:`[TAG=Resource->Messages] ` :index:`[TAG=Messages Resource] ` + :index:`[TAG=Resource->Messages] ` :index:`[TAG=Messages Resource] ` Messages Resource ----------------- The Messages resource defines how messages are to be handled and destinations to which they should be sent. -Even though each daemon has a full message handler, within the |bareosFd| and the |bareosSd|, you will normally choose to send all the appropriate messages back to the |bareosDir|. This permits all the messages associated with a single Job to be combined in the Director and sent as a single email message to the user, or logged together in a single file. +Even though each daemon has a full message handler, within the |fd| and the |sd|, you will normally choose to send all the appropriate messages back to the |dir|. This permits all the messages associated with a single Job to be combined in the Director and sent as a single email message to the user, or logged together in a single file. Each message that Bareos generates (i.e. that each daemon generates) has an associated type such as INFO, WARNING, ERROR, FATAL, etc. Using the message resource, you can specify which message types you wish to see and where they should be sent. In addition, a message may be sent to multiple destinations. For example, you may want all error messages both logged as well as sent to you in an email. By defining multiple messages resources, you can have different message handling for each type of Job (e.g. Full backups versus Incremental backups). In general, messages are attached to a Job and are included in the Job report. There are some rare cases, where this is not possible, e.g. when no job is running, or if a communications error occurs between a daemon and the director. In those cases, the message may remain in the system, and should be flushed at the end of the next Job. -The records contained in a Messages resource consist of a destination specification followed by a list of message-types in the format: :index:`[TAG=Messages->destination] ` +The records contained in a Messages resource consist of a destination specification followed by a list of message-types in the format: :index:`[TAG=Messages->destination] ` destination = message-type1, message-type2, message-type3, ... @@ -83,59 +83,59 @@ For any destination, the message-type field is a comma separated list of the fol info | - | :index:`[TAG=Messages->type->info] ` General information messages. + | :index:`[TAG=Messages->type->info] ` General information messages. warning | - | :index:`[TAG=Messages->type->warning] ` Warning messages. Generally this is some unusual condition but not expected to be serious. + | :index:`[TAG=Messages->type->warning] ` Warning messages. Generally this is some unusual condition but not expected to be serious. error | - | :index:`[TAG=Messages->type->error] ` Non-fatal error messages. The job continues running. Any error message should be investigated as it means that something went wrong. + | :index:`[TAG=Messages->type->error] ` Non-fatal error messages. The job continues running. Any error message should be investigated as it means that something went wrong. fatal | - | :index:`[TAG=Messages->type->fatal] ` Fatal error messages. Fatal errors cause the job to terminate. + | :index:`[TAG=Messages->type->fatal] ` Fatal error messages. Fatal errors cause the job to terminate. terminate | - | :index:`[TAG=Messages->type->terminate] ` Message generated when the daemon shuts down. + | :index:`[TAG=Messages->type->terminate] ` Message generated when the daemon shuts down. notsaved | - | :index:`[TAG=Messages->type->notsaved] ` Files not saved because of some error. Usually because the file cannot be accessed (i.e. it does not exist or is not mounted). + | :index:`[TAG=Messages->type->notsaved] ` Files not saved because of some error. Usually because the file cannot be accessed (i.e. it does not exist or is not mounted). skipped | - | :index:`[TAG=Messages->type->skipped] ` Files that were skipped because of a user supplied option such as an incremental backup or a file that matches an exclusion pattern. This is not considered an error condition such as the files listed for the notsaved type because the configuration file explicitly requests these types of files to be skipped. For example, any unchanged file during an incremental backup, or any subdirectory if the no recursion option is specified. + | :index:`[TAG=Messages->type->skipped] ` Files that were skipped because of a user supplied option such as an incremental backup or a file that matches an exclusion pattern. This is not considered an error condition such as the files listed for the notsaved type because the configuration file explicitly requests these types of files to be skipped. For example, any unchanged file during an incremental backup, or any subdirectory if the no recursion option is specified. mount | - | :index:`[TAG=Messages->type->mount] ` Volume mount or intervention requests from the Storage daemon. These requests require a specific operator intervention for the job to continue. + | :index:`[TAG=Messages->type->mount] ` Volume mount or intervention requests from the Storage daemon. These requests require a specific operator intervention for the job to continue. restored | - | :index:`[TAG=Messages->type->restored] ` The ls style listing generated for each file restored is sent to this message class. + | :index:`[TAG=Messages->type->restored] ` The ls style listing generated for each file restored is sent to this message class. all | - | :index:`[TAG=Messages->type->all] ` All message types. + | :index:`[TAG=Messages->type->all] ` All message types. security | - | :index:`[TAG=Messages->type->security] ` Security info/warning messages principally from unauthorized connection attempts. + | :index:`[TAG=Messages->type->security] ` Security info/warning messages principally from unauthorized connection attempts. alert | - | :index:`[TAG=Messages->type->alert] ` Alert messages. These are messages generated by tape alerts. + | :index:`[TAG=Messages->type->alert] ` Alert messages. These are messages generated by tape alerts. volmgmt | - | :index:`[TAG=Messages->type->volmgmt] ` Volume management messages. Currently there are no volume management messages generated. + | :index:`[TAG=Messages->type->volmgmt] ` Volume management messages. Currently there are no volume management messages generated. audit | - | :index:`[TAG=Messages->type->audit] ` :index:`[TAG=auditing] ` Audit messages. Interacting with the Bareos Director will be audited. Can be configured with in resource :config:option:`dir/director/Auditing`\ . + | :index:`[TAG=Messages->type->audit] ` :index:`[TAG=auditing] ` Audit messages. Interacting with the Bareos Director will be audited. Can be configured with in resource :config:option:`dir/director/Auditing`\ . The following is an example of a valid Messages resource definition, where all messages except files explicitly skipped or daemon termination messages are sent by email to backupoperator@example.com. In addition all mount messages are sent to the operator (i.e. emailed to backupoperator@example.com). Finally all messages other than explicitly skipped files and files saved are sent to the console: diff --git a/docs/manuals/en/new_main_reference/source/Configuration/Monitor.rst b/docs/manuals/en/new_main_reference/source/Configuration/Monitor.rst index 09a488bcd63..bf30843f3ea 100644 --- a/docs/manuals/en/new_main_reference/source/Configuration/Monitor.rst +++ b/docs/manuals/en/new_main_reference/source/Configuration/Monitor.rst @@ -3,7 +3,7 @@ Monitor Configuration ===================== -:index:`[TAG=Monitor Configuration] ` :index:`[TAG=Configuration->Monitor] ` +:index:`[TAG=Monitor Configuration] ` :index:`[TAG=Configuration->Monitor] ` The Monitor configuration file is a stripped down version of the Director configuration file, mixed with a Console configuration file. It simply contains the information necessary to contact Directors, Clients, and Storage daemons you want to monitor. @@ -20,7 +20,7 @@ The following Monitor Resource definition must be defined: Monitor Resource ---------------- -:index:`[TAG=Monitor Resource] ` :index:`[TAG=Resource->Monitor] ` +:index:`[TAG=Monitor Resource] ` :index:`[TAG=Resource->Monitor] ` The Monitor resource defines the attributes of the Monitor running on the network. The parameters you define here must be configured as a Director resource in Clients and Storages configuration files, and as a Console resource in Directors configuration files. @@ -47,7 +47,7 @@ The Monitor resource defines the attributes of the Monitor running on the networ Director Resource ----------------- -:index:`[TAG=Director Resource] ` :index:`[TAG=Resource->Director] ` +:index:`[TAG=Director Resource] ` :index:`[TAG=Resource->Director] ` The Director resource defines the attributes of the Directors that are monitored by this Monitor. @@ -72,7 +72,7 @@ You may have multiple Director resource specifications in a single Monitor confi Client Resource --------------- -:index:`[TAG=Resource->Client] ` :index:`[TAG=Client Resource] ` +:index:`[TAG=Resource->Client] ` :index:`[TAG=Client Resource] ` The Client resource defines the attributes of the Clients that are monitored by this Monitor. @@ -99,7 +99,7 @@ You may have multiple Director resource specifications in a single Monitor confi Storage Resource ---------------- -:index:`[TAG=Resource->Storage] ` :index:`[TAG=Storage Resource] ` +:index:`[TAG=Resource->Storage] ` :index:`[TAG=Storage Resource] ` The Storage resource defines the attributes of the Storages that are monitored by this Monitor. @@ -131,7 +131,7 @@ Tray Monitor Tray Monitor Security ~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Tray Monitor Security] ` :index:`[TAG=Security->Tray Monitor] ` +:index:`[TAG=Tray Monitor Security] ` :index:`[TAG=Security->Tray Monitor] ` There is no security problem in relaxing the permissions on tray-monitor.conf as long as FD, SD and DIR are configured properly, so the passwords contained in this file only gives access to the status of the daemons. It could be a security problem if you consider the status information as potentially dangerous (most people consider this as not being dangerous). @@ -144,7 +144,7 @@ There is no security problem in relaxing the permissions on tray-monitor.conf as Example Tray Monitor configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Tray Monitor->Configuration] ` :index:`[TAG=Configuration->Tray Monitor] ` +:index:`[TAG=Tray Monitor->Configuration] ` :index:`[TAG=Configuration->Tray Monitor] ` An example Tray Monitor configuration file might be the following: diff --git a/docs/manuals/en/new_main_reference/source/Configuration/StorageDaemon.rst b/docs/manuals/en/new_main_reference/source/Configuration/StorageDaemon.rst index e1eade89f54..57686f502dc 100644 --- a/docs/manuals/en/new_main_reference/source/Configuration/StorageDaemon.rst +++ b/docs/manuals/en/new_main_reference/source/Configuration/StorageDaemon.rst @@ -3,9 +3,9 @@ Storage Daemon Configuration ============================ -:index:`[TAG=Configuration] ` :index:`[TAG=Storage Daemon->Configuration] ` :index:`[TAG=Configuration->Storage Daemon] ` +:index:`[TAG=Configuration] ` :index:`[TAG=Storage Daemon->Configuration] ` :index:`[TAG=Configuration->Storage Daemon] ` -The |bareosSd| configuration file has relatively few resource definitions. However, due to the great variation in backup media and system capabilities, the storage daemon must be highly configurable. As a consequence, there are quite a large number of directives in the Device Resource definition that allow you to define all the characteristics of your Storage device (normally a tape drive). Fortunately, with modern storage devices, the defaults are sufficient, and very few directives +The |sd| configuration file has relatively few resource definitions. However, due to the great variation in backup media and system capabilities, the storage daemon must be highly configurable. As a consequence, there are quite a large number of directives in the Device Resource definition that allow you to define all the characteristics of your Storage device (normally a tape drive). Fortunately, with modern storage devices, the defaults are sufficient, and very few directives are actually needed. For a general discussion of configuration file and resources including the data types recognized by Bareos, please see the :ref:`Configuration ` chapter of this manual. The following Storage Resource definitions must be defined: @@ -29,7 +29,7 @@ Following resources are optional: Storage Resource ---------------- -:index:`[TAG=Resource->Storage] ` :index:`[TAG=Storage->Resource] ` +:index:`[TAG=Resource->Storage] ` :index:`[TAG=Storage->Resource] ` In general, the properties specified under the Storage resource define global properties of the Storage daemon. Each Storage daemon configuration file must have one and only one Storage resource definition. @@ -148,7 +148,7 @@ The following is a typical Storage daemon storage resource definition. Director Resource ----------------- -:index:`[TAG=Resource->Director] ` :index:`[TAG=Director->Resource] ` +:index:`[TAG=Resource->Director] ` :index:`[TAG=Director->Resource] ` The Director resource specifies the Name of the Director which is permitted to use the services of the Storage daemon. There may be multiple Director resources. The Director Name and Password must match the corresponding values in the Director’s configuration file. @@ -207,7 +207,7 @@ NDMP Resource .. _StorageResourceNDMP: - :index:`[TAG=Resource->NDMP] ` :index:`[TAG=NDMP->Resource] ` + :index:`[TAG=Resource->NDMP] ` :index:`[TAG=NDMP->Resource] ` The NDMP Resource specifies the authentication details of each NDMP client. There may be multiple NDMP resources for a single Storage daemon. In general, the properties specified within the NDMP resource are specific to one client. @@ -230,7 +230,7 @@ The NDMP Resource specifies the authentication details of each NDMP client. Ther Device Resource --------------- -:index:`[TAG=Resource->Device] ` :index:`[TAG=Device->Resource] ` +:index:`[TAG=Resource->Device] ` :index:`[TAG=Device->Resource] ` The Device Resource specifies the details of each device (normally a tape drive) that can be used by the Storage daemon. There may be multiple Device resources for a single Storage daemon. In general, the properties specified within the Device resource are specific to the Device. @@ -399,8 +399,8 @@ Devices that require a mount (USB) \begin{description} \item :config:option:`sd/device/RequiresMount`\ - You must set this directive to {\bf yes} for removable devices such as - USB unless they are automounted, and to {\bf no} for all other devices + You must set this directive to :strong:`yes` for removable devices such as + USB unless they are automounted, and to :strong:`no` for all other devices (tapes/files). This directive indicates if the device requires to be mounted to be read, and if it must be written in a special way. If it set, :config:option:`sd/device/MountPoint`\ , @@ -459,7 +459,7 @@ Devices that require a mount (USB) Autochanger Resource -------------------- -:index:`[TAG=Autochanger Resource] ` :index:`[TAG=Resource->Autochanger] ` +:index:`[TAG=Autochanger Resource] ` :index:`[TAG=Resource->Autochanger] ` .. _AutochangerRes: @@ -524,7 +524,7 @@ For details refer to the :ref:`AutochangersChapter` chapter. Messages Resource ----------------- -:index:`[TAG=Resource->Messages] ` :index:`[TAG=Messages->Resource] ` +:index:`[TAG=Resource->Messages] ` :index:`[TAG=Messages->Resource] ` For a description of the Messages Resource, please see the :ref:`MessagesChapter` chapter of this manual. diff --git a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/CriticalItemsToImplementBeforeProduction.rst b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/CriticalItemsToImplementBeforeProduction.rst index df33891155d..9ff22ed65c2 100644 --- a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/CriticalItemsToImplementBeforeProduction.rst +++ b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/CriticalItemsToImplementBeforeProduction.rst @@ -3,7 +3,7 @@ Critical Items to Implement Before Production ============================================= -:index:`[TAG=Production->Critical Items to Implement Before] ` :index:`[TAG=Critical Items to Implement Before Production] ` +:index:`[TAG=Production->Critical Items to Implement Before] ` :index:`[TAG=Critical Items to Implement Before Production] ` We recommend you take your time before implementing a production on a Bareos backup system since Bareos is a rather complex program, and if you make a mistake, you may suddenly find that you cannot restore your files in case of a disaster. This is especially true if you have not previously used a major backup product. diff --git a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/GettingStartedWithBareos.rst b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/GettingStartedWithBareos.rst index a9d84b60e56..7a85e862763 100644 --- a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/GettingStartedWithBareos.rst +++ b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/GettingStartedWithBareos.rst @@ -6,7 +6,7 @@ Getting Started with Bareos Understanding Jobs and Schedules -------------------------------- -:index:`[TAG=Schedule->Understanding Schedules] ` +:index:`[TAG=Schedule->Understanding Schedules] ` .. _JobsandSchedules: @@ -22,7 +22,7 @@ Finally, be aware that in addition to the backup jobs there are restore, verify, Understanding Pools, Volumes and Labels --------------------------------------- -:index:`[TAG=Pools->Understanding] ` :index:`[TAG=Volumes->Understanding] ` :index:`[TAG=Label->Understanding Labels] ` +:index:`[TAG=Pools->Understanding] ` :index:`[TAG=Volumes->Understanding] ` :index:`[TAG=Label->Understanding Labels] ` .. _PoolsVolsLabels: @@ -47,7 +47,7 @@ For more on Pools, see the :ref:`DirectorResourcePool` section of the Director C Setting Up Bareos Configuration Files ------------------------------------- -:index:`[TAG=Configuration->Files] ` +:index:`[TAG=Configuration->Files] ` On Unix, Bareos configuration files are usually located in the :file:`/etc/bareos/` directory and are named accordingly to the programs that use it. Since Bareos :sinceVersion:`16.2.4: Subdirectory Configuration Scheme used as Default` the default configuration is stored as one file per resource in subdirectories under :file:`bareos-dir.d`, :file:`bareos-sd.d` or :file:`bareos-fd.d`. For details, see :ref:`ConfigureChapter` and :ref:`section-SubdirectoryConfigurationScheme`. @@ -55,15 +55,15 @@ On Unix, Bareos configuration files are usually located in the :file:`/etc/bareo Testing your Configuration Files -------------------------------- -:index:`[TAG=Testing->Configuration Files] ` +:index:`[TAG=Testing->Configuration Files] ` -You can test if your configuration file is syntactically correct by running the appropriate daemon with the ``-t`` option. The daemon will process the configuration file and print any error messages then terminate. +You can test if your configuration file is syntactically correct by running the appropriate daemon with the :strong:`-t` option. The daemon will process the configuration file and print any error messages then terminate. -As the |bareosDir| and |bareosSd| runs as user **bareos**, testing the configuration should be done as **bareos**. +As the |dir| and |sd| runs as user **bareos**, testing the configuration should be done as **bareos**. -This is especially required to test the |bareosDir|, as it also connects to the database and checks if the catalog schema version is correct. Depending on your database, only the **bareos** has permission to access it. +This is especially required to test the |dir|, as it also connects to the database and checks if the catalog schema version is correct. Depending on your database, only the **bareos** has permission to access it. -.. code-block:: sh +.. code-block:: shell-session :caption: Testing Configuration Files su bareos -s /bin/sh -c "/usr/sbin/bareos-dir -t" diff --git a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/InstallingBareos.rst b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/InstallingBareos.rst index 24a2851b1c4..ab30fd50c36 100644 --- a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/InstallingBareos.rst +++ b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/InstallingBareos.rst @@ -3,7 +3,7 @@ Installing Bareos ================= -:index:`[TAG=Bareos->Installing] ` :index:`[TAG=Installation->Linux] ` +:index:`[TAG=Bareos->Installing] ` :index:`[TAG=Installation->Linux] ` If you are like me, you want to get Bareos running immediately to get a feel for it, then later you want to go back and read about all the details. This chapter attempts to accomplish just that: get you going quickly without all the details. @@ -57,6 +57,7 @@ Bareos offers the following database backends: | .. warning:: + The Sqlite backend is only intended for testing, not for productive use. PostgreSQL @@ -85,11 +86,11 @@ Install on RedHat based Linux Distributions RHEL>7, CentOS>7, Fedora ^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Platform->RHEL] ` :index:`[TAG=Platform->CentOS] ` :index:`[TAG=Platform->Fedora] ` +:index:`[TAG=Platform->RHEL] ` :index:`[TAG=Platform->CentOS] ` :index:`[TAG=Platform->Fedora] ` Bareos :sinceVersion:`15.2.0: requires: jansson` requires the :ref:`Jansson library ` package. On RHEL 7 it is available through the RHEL Server Optional channel. On CentOS 7 and Fedora is it included on the main repository. -.. code-block:: sh +.. code-block:: shell-session :caption: Bareos installation on RHEL > 7 / CentOS > 7 / Fedora # @@ -117,11 +118,11 @@ Bareos :sinceVersion:`15.2.0: requires: jansson` requires the :ref:`Jansson libr RHEL 6, CentOS 6 ^^^^^^^^^^^^^^^^ -:index:`[TAG=Platform->RHEL->6] ` :index:`[TAG=Platform->CentOS->6] ` +:index:`[TAG=Platform->RHEL->6] ` :index:`[TAG=Platform->CentOS->6] ` Bareos :sinceVersion:`15.2.0: requires: jansson` requires the :ref:`Jansson library ` package. This package is available on `EPEL `_ 6. Make sure, it is available on your system. -.. code-block:: sh +.. code-block:: shell-session :caption: Bareos installation on RHEL > 6 / CentOS > 6 # @@ -152,11 +153,11 @@ Bareos :sinceVersion:`15.2.0: requires: jansson` requires the :ref:`Jansson libr RHEL 5 ^^^^^^ -:index:`[TAG=Platform->RHEL->5] ` +:index:`[TAG=Platform->RHEL->5] ` yum in RHEL 5/CentOS 5 has slightly different behaviour as far as dependency resolving is concerned: it sometimes install a dependent package after the one that has the dependency defined. To make sure that it works, install the desired Bareos database backend package first in a separate step: -.. code-block:: sh +.. code-block:: shell-session :caption: Bareos installation on RHEL 5 / CentOS 5 # @@ -184,9 +185,9 @@ Install on SUSE based Linux Distributions SUSE Linux Enterprise Server (SLES), openSUSE ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Platform->SLES] ` :index:`[TAG=Platform->openSUSE] ` +:index:`[TAG=Platform->SLES] ` :index:`[TAG=Platform->openSUSE] ` -.. code-block:: sh +.. code-block:: shell-session :caption: Bareos installation on SLES / openSUSE # @@ -221,11 +222,11 @@ Install on Debian based Linux Distributions Debian / Ubuntu ^^^^^^^^^^^^^^^ -:index:`[TAG=Platform->Debian] ` :index:`[TAG=Platform->Ubuntu] ` +:index:`[TAG=Platform->Debian] ` :index:`[TAG=Platform->Ubuntu] ` Bareos :sinceVersion:`15.2.0: requires: jansson` requires the :ref:`Jansson library ` package. On Ubuntu is it available in Ubuntu Universe. In Debian, is it included in the main repository. -.. code-block:: sh +.. code-block:: shell-session :caption: Bareos installation on Debian / Ubuntu # @@ -294,7 +295,7 @@ Follow the instructions during install to configure it according to your needs. -If you decide not to use **dbconfig-common** (selecting ```` on the initial dialog), follow the instructions for :ref:`section-CreateDatabaseOtherDistributions`. +If you decide not to use **dbconfig-common** (selecting :strong:`` on the initial dialog), follow the instructions for :ref:`section-CreateDatabaseOtherDistributions`. The selectable database backends depend on the **bareos-database-*** packages installed. @@ -310,7 +311,7 @@ PostgreSQL If your are using PostgreSQL and your PostgreSQL administration user is **postgres** (default), use following commands: -.. code-block:: sh +.. code-block:: shell-session :caption: Setup Bareos catalog with PostgreSQL su postgres -c /usr/lib/bareos/scripts/create_bareos_database @@ -332,7 +333,7 @@ Make sure, that **root** has direct access to the local MySQL server. Check if t It is recommended, to secure the Bareos database connection with a password. See :ref:`Catalog Maintenance -- MySQL ` about how to archieve this. For testing, using a password-less MySQL connection is probable okay. Setup the Bareos database tables by following commands: -.. code-block:: sh +.. code-block:: shell-session :caption: Setup Bareos catalog with MySQL /usr/lib/bareos/scripts/create_bareos_database @@ -346,7 +347,7 @@ As some Bareos updates require a database schema update, therefore the file :fil Start the daemons ----------------- -.. code-block:: sh +.. code-block:: shell-session :caption: Start the Bareos Daemons service bareos-dir start diff --git a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/InstallingBareosWebui.rst b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/InstallingBareosWebui.rst index e9233c71120..607078684e9 100644 --- a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/InstallingBareosWebui.rst +++ b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/InstallingBareosWebui.rst @@ -7,11 +7,11 @@ Installing Bareos Webui .. _section-install-webui: - :index:`[TAG=Webui] ` :index:`[TAG=Webui->Install] ` + :index:`[TAG=Webui] ` :index:`[TAG=Webui->Install] ` -This chapter addresses the installation process of the |bareosWebui|. +This chapter addresses the installation process of the |webui|. -Since :sinceVersion:`15.2.0: bareos-webui` |bareosWebui| is part of the Bareos project and available for a number of platforms. +Since :sinceVersion:`15.2.0: bareos-webui` |webui| is part of the Bareos project and available for a number of platforms. .. image:: /include/images/bareos-webui-jobs.* :width: 80.0% @@ -63,9 +63,9 @@ System Requirements - A working Bareos environment. -- |bareosDir| version >= |bareosWebui| version. +- |dir| version >= |webui| version. -- The |bareosWebui| can be installed on any host. It does not have to be installed on the same as the |bareosDir|. +- The |webui| can be installed on any host. It does not have to be installed on the same as the |dir|. - The default installation uses an Apache webserver with mod-rewrite, mod-php and mod-setenv. @@ -76,7 +76,7 @@ System Requirements Version < 16.2 ~~~~~~~~~~~~~~ -|bareosWebui| :sinceVersion:`16.2.4: bareos-webui incorporates Zend Framework 2` incorporates the required Zend Framework 2 components, no extra Zend Framework installation is required. For older versions of **bareos-webui**, you must install Zend Framework separately. Unfortunately, not all distributions offer Zend Framework 2 packages. The following list shows where to get the Zend Framework 2 package: +|webui| :sinceVersion:`16.2.4: bareos-webui incorporates Zend Framework 2` incorporates the required Zend Framework 2 components, no extra Zend Framework installation is required. For older versions of **bareos-webui**, you must install Zend Framework separately. Unfortunately, not all distributions offer Zend Framework 2 packages. The following list shows where to get the Zend Framework 2 package: - RHEL, CentOS @@ -92,7 +92,7 @@ Version < 16.2 - http://download.bareos.org/bareos -Also be aware, that older versions of |bareosDir| do not support the :ref:`section-SubdirectoryConfigurationScheme` and therefore Bareos configuration resource files must be included manually. +Also be aware, that older versions of |dir| do not support the :ref:`section-SubdirectoryConfigurationScheme` and therefore Bareos configuration resource files must be included manually. Installation ------------ @@ -109,36 +109,36 @@ After adding the repository simply install the bareos-webui package via your pac - RHEL, CentOS and Fedora - .. code-block:: sh + .. code-block:: shell-session yum install bareos-webui or - .. code-block:: sh + .. code-block:: shell-session dnf install bareos-webui - SUSE Linux Enterprise Server (SLES), openSUSE - .. code-block:: sh + .. code-block:: shell-session zypper install bareos-webui - Debian, Ubuntu - .. code-block:: sh + .. code-block:: shell-session apt-get install bareos-webui Minimal Configuration ~~~~~~~~~~~~~~~~~~~~~ -This assumes, |bareosDir| and |bareosWebui| are installed on the same host. +This assumes, |dir| and |webui| are installed on the same host. #. If you are using SELinux, allow HTTPD scripts and modules make network connections: - .. code-block:: sh + .. code-block:: shell-session setsebool -P httpd_can_network_connect on @@ -169,11 +169,11 @@ Configuration Details Create a restricted consoles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -There is not need, that |bareosWebui| itself provide a user management. Instead it uses so named :config:option:`Dir/Console`\ defined in the |bareosDir|. You can have multiple consoles with different names and passwords, sort of like multiple users, each with different privileges. +There is not need, that |webui| itself provide a user management. Instead it uses so named :config:option:`Dir/Console`\ defined in the |dir|. You can have multiple consoles with different names and passwords, sort of like multiple users, each with different privileges. -At least one :config:option:`Dir/Console`\ is required to use the |bareosWebui|. +At least one :config:option:`Dir/Console`\ is required to use the |webui|. -To allow a user with name **admin** and password **secret** to access the |bareosDir| with permissions defined in the :config:option:`Dir/Profile = webui-admin`\ (see :ref:`section-webui-profile`), either +To allow a user with name **admin** and password **secret** to access the |dir| with permissions defined in the :config:option:`Dir/Profile = webui-admin`\ (see :ref:`section-webui-profile`), either - create a file :file:`/etc/bareos/bareos-dir.d/console/admin.conf` with following content: @@ -186,7 +186,7 @@ To allow a user with name **admin** and password **secret** to access the |bareo Profile = "webui-admin" } - To enable this, reload or restart your |bareosDir|. + To enable this, reload or restart your |dir|. - or use the :command:`bconsole`: @@ -202,11 +202,11 @@ For details, please read :ref:`DirectorResourceConsole`. Configuration of profile resources ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The package **bareos-webui** comes with a predefined profile for |bareosWebui|: :config:option:`Dir/Profile = webui-admin`\ . +The package **bareos-webui** comes with a predefined profile for |webui|: :config:option:`Dir/Profile = webui-admin`\ . -If your |bareosWebui| is installed on another system than the |bareosDir|, you have to copy the profile to the |bareosDir|. +If your |webui| is installed on another system than the |dir|, you have to copy the profile to the |dir|. -This is the default profile, giving access to all Bareos resources and allowing all commands used by the |bareosWebui|: +This is the default profile, giving access to all Bareos resources and allowing all commands used by the |webui|: .. code-block:: bareosconfig :caption: bareos-dir.d/profile/webui-admin.conf @@ -225,7 +225,7 @@ This is the default profile, giving access to all Bareos resources and allowing Plugin Options ACL = *all* } -The :config:option:`Dir/Profile`\ itself does not give any access to the |bareosDir|, but can be used by :config:option:`Dir/Console`\ , which do give access to the |bareosDir|, see :ref:`section-webui-console`. +The :config:option:`Dir/Profile`\ itself does not give any access to the |dir|, but can be used by :config:option:`Dir/Console`\ , which do give access to the |dir|, see :ref:`section-webui-console`. For details, please read :ref:`DirectorResourceProfile`. @@ -234,18 +234,18 @@ For details, please read :ref:`DirectorResourceProfile`. SELinux ^^^^^^^ -:index:`[TAG=SELinux->bareos-webui] ` +:index:`[TAG=SELinux->bareos-webui] ` -To use |bareosDir| on a system with SELinux enabled, permission must be given to HTTPD to make network connections: +To use |dir| on a system with SELinux enabled, permission must be given to HTTPD to make network connections: -.. code-block:: sh +.. code-block:: shell-session setsebool -P httpd_can_network_connect on Configure your Apache Webserver ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Apache->bareos-webui] ` +:index:`[TAG=Apache->bareos-webui] ` .. _section-webui-apache: @@ -258,7 +258,7 @@ The required Apache modules, :strong:`setenv`, :strong:`rewrite` and :strong:`ph Configure your /etc/bareos-webui/directors.ini ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=Configuration->WebUI] ` +:index:`[TAG=Configuration->WebUI] ` .. _section-webui-configuration-files: @@ -352,7 +352,7 @@ You can add as many directors as you want, also the same host with a different n Configure your /etc/bareos-webui/configuration.ini ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Since :sinceVersion:`16.2.2: /etc/bareos-webui/configuration.ini` you are able to configure some parameters of the |bareosWebui| to your needs. +Since :sinceVersion:`16.2.2: /etc/bareos-webui/configuration.ini` you are able to configure some parameters of the |webui| to your needs. .. code-block:: bareosconfig :caption: /etc/bareos-webui/configuration.ini @@ -410,11 +410,11 @@ Upgrade from 15.2 to 16.2 Console/Profile changes ~~~~~~~~~~~~~~~~~~~~~~~ -The |bareosWebui| Director profile shipped with Bareos 15.2 (:config:option:`Dir/Profile = webui`\ in the file :file:`/etc/bareos/bareos-dir.d/webui-profiles.conf`) is not sufficient to use the |bareosWebui| 16.2. This has several reasons: +The |webui| Director profile shipped with Bareos 15.2 (:config:option:`Dir/Profile = webui`\ in the file :file:`/etc/bareos/bareos-dir.d/webui-profiles.conf`) is not sufficient to use the |webui| 16.2. This has several reasons: #. The handling of :strong:`Acl`s is more strict in Bareos 16.2 than it has been in Bareos 15.2. Substring matching is no longer enabled, therefore you need to change :bcommand:`.bvfs_*` to :bcommand:`.bvfs_.*` in your :config:option:`dir/profile/CommandAcl`\ to have a proper regular expression. Otherwise the restore module won’t work any longer, especially the file browser. -#. The |bareosWebui| 16.2 uses following additional commands: +#. The |webui| 16.2 uses following additional commands: - .help @@ -444,7 +444,7 @@ Since :sinceVersion:`16.2.0: Webui offers limited support for multiple catalogs` configuration.ini ~~~~~~~~~~~~~~~~~ -Since 16.2 the |bareosWebui| introduced an additional configuration file besides the directors.ini file named configuration.ini where you are able to adjust some parameters of the webui to your needs. Please see :ref:`section-webui-configuration-files` for more details. +Since 16.2 the |webui| introduced an additional configuration file besides the directors.ini file named configuration.ini where you are able to adjust some parameters of the webui to your needs. Please see :ref:`section-webui-configuration-files` for more details. Additional information ---------------------- @@ -452,9 +452,9 @@ Additional information NGINX ~~~~~ -:index:`[TAG=nginx->bareos-webui] ` +:index:`[TAG=nginx->bareos-webui] ` -If you prefer to use |bareosWebui| on Nginx with php5-fpm instead of Apache, a basic working configuration could look like this: +If you prefer to use |webui| on Nginx with php5-fpm instead of Apache, a basic working configuration could look like this: .. code-block:: bareosconfig :caption: bareos-webui on nginx @@ -491,6 +491,6 @@ If you prefer to use |bareosWebui| on Nginx with php5-fpm instead of Apache, a b } -This will make the |bareosWebui| accessible at http://bareos:9100/ (assuming your DNS resolve the hostname :strong:`bareos` to the NGINX server). +This will make the |webui| accessible at http://bareos:9100/ (assuming your DNS resolve the hostname :strong:`bareos` to the NGINX server). diff --git a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/Tutorial.rst b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/Tutorial.rst index 6824896c42a..461161e2842 100644 --- a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/Tutorial.rst +++ b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/Tutorial.rst @@ -17,7 +17,7 @@ The general flow of running Bareos is: #. Start the Bareos Daemons -#. Start the Console program to interact with the |bareosDir| +#. Start the Console program to interact with the |dir| #. Run a job @@ -30,7 +30,7 @@ Each of these steps is described in more detail below. Starting the Database --------------------- -If you are using |postgresql| or |mysql| as the Bareos database, you should start it before you install Bareos. If you are using |sqlite| you need do nothing. |sqlite| is automatically started by the |bareosDir|. +If you are using |postgresql| or |mysql| as the Bareos database, you should start it before you install Bareos. If you are using |sqlite| you need do nothing. |sqlite| is automatically started by the |dir|. Installing Bareos ----------------- @@ -42,7 +42,7 @@ For installing Bareos, follow the instructions from the :ref:`InstallChapter` ch Starting the Daemons -------------------- -:index:`[TAG=Starting the Daemons] ` :index:`[TAG=Daemon->Start] ` +:index:`[TAG=Starting the Daemons] ` :index:`[TAG=Daemon->Start] ` Assuming you have installed the packages, to start the three daemons, from your installation directory, simply enter: @@ -58,11 +58,11 @@ Assuming you have installed the packages, to start the three daemons, from your Using the Director to Query and Start Jobs ------------------------------------------ -To communicate with the |bareosDir| and to query the state of Bareos or run jobs, the :command:`bconsole` program can be used as a textual interface. Alternatively, for most purposes, also the :ref:`|bareosWebui| ` can be used, but for simplicity, here we will describe only the :command:`bconsole` program. +To communicate with the |dir| and to query the state of Bareos or run jobs, the :command:`bconsole` program can be used as a textual interface. Alternatively, for most purposes, also the :ref:`|webui| ` can be used, but for simplicity, here we will describe only the :command:`bconsole` program. -The :command:`bconsole` runs the Bareos Console program, which connects to the |bareosDir|. Since Bareos is a network program, you can run the Console program anywhere on your network. Most frequently, however, one runs it on the same machine as the |bareosDir|. Normally, the Console program will print something similar to the following: +The :command:`bconsole` runs the Bareos Console program, which connects to the |dir|. Since Bareos is a network program, you can run the Console program anywhere on your network. Most frequently, however, one runs it on the same machine as the |dir|. Normally, the Console program will print something similar to the following: -.. code-block:: sh +.. code-block:: shell-session :caption: bconsole bconsole @@ -134,7 +134,7 @@ Details of the console program’s commands are explained in the :ref:`section-b Running a Job ------------- -:index:`[TAG=Job->Running a] ` :index:`[TAG=Running a Job] ` +:index:`[TAG=Job->Running a] ` :index:`[TAG=Running a Job] ` At this point, we assume you have done the following: @@ -225,9 +225,9 @@ Now enter: No Jobs running. ==== -In this case, the client is named :config:option:`Dir/Client = bareos-fd`\ your name might be different, but the line beginning with :file:`bareos-fd Version` is printed by your |bareosFd|, so we are now sure it is up and running. +In this case, the client is named :config:option:`Dir/Client = bareos-fd`\ your name might be different, but the line beginning with :file:`bareos-fd Version` is printed by your |fd|, so we are now sure it is up and running. -Finally do the same for your |bareosSd| with: +Finally do the same for your |sd| with: .. code-block:: bconsole :caption: status storage @@ -256,7 +256,7 @@ Finally do the same for your |bareosSd| with: ==== -You will notice that the default |bareosSd| device is named :config:option:`Dir/Storage = File`\ and that it will use device :file:`/var/lib/bareos/storage`, which is not currently open. +You will notice that the default |sd| device is named :config:option:`Dir/Storage = File`\ and that it will use device :file:`/var/lib/bareos/storage`, which is not currently open. Now, let’s actually run a job with: @@ -385,7 +385,7 @@ If you would like to try restoring the files that you just backed up, read the f Restoring Your Files -------------------- -:index:`[TAG=Files->Restoring Your] ` :index:`[TAG=Restoring Your Files] ` +:index:`[TAG=Files->Restoring Your] ` :index:`[TAG=Restoring Your Files] ` If you have run the default configuration and run the job as demonstrated above, you can restore the backed up files in the Console program by entering: @@ -559,7 +559,7 @@ If you answer yes your files will be restored to :file:`/tmp/bareos-restores`. I After exiting the Console program, you can examine the files in :file:`/tmp/bareos-restores`, which will contain a small directory tree with all the files. Be sure to clean up at the end with: -.. code-block:: sh +.. code-block:: shell-session :caption: remove restore directory rm -rf /tmp/bareos-restore @@ -567,7 +567,7 @@ After exiting the Console program, you can examine the files in :file:`/tmp/bare Quitting the Console Program ---------------------------- -:index:`[TAG=Program->Quitting the Console] ` :index:`[TAG=Quitting the Console Program] ` +:index:`[TAG=Program->Quitting the Console] ` :index:`[TAG=Quitting the Console Program] ` Simply enter the command :bcommand:`quit`. @@ -580,9 +580,9 @@ Adding a Client .. _section-AddAClient: - :index:`[TAG=Client->Adding a Second] ` :index:`[TAG=Adding a Client] ` + :index:`[TAG=Client->Adding a Second] ` :index:`[TAG=Adding a Client] ` -If you have gotten the example shown above to work on your system, you may be ready to add a second Client (|bareosFd|). That is you have a second machine that you would like backed up. Lets assume, following settings about the machine you want to add to your backup environment: +If you have gotten the example shown above to work on your system, you may be ready to add a second Client (|fd|). That is you have a second machine that you would like backed up. Lets assume, following settings about the machine you want to add to your backup environment: Hostname (FQDN) :strong:`client2.example.com` @@ -593,7 +593,7 @@ IP Address OS Linux (otherwise the paths may differ) -For this you have to make changes on the server side (|bareosDir|) and the client side. +For this you have to make changes on the server side (|dir|) and the client side. Client: install package ~~~~~~~~~~~~~~~~~~~~~~~ @@ -603,7 +603,7 @@ See :ref:`InstallChapter` about how to add the Bareos repository. The only part Director: configure client ~~~~~~~~~~~~~~~~~~~~~~~~~~ -Bareos :sinceVersion:`16.2.4: configure add` offers the :ref:`configure add command ` to add resources to the |bareosDir|. +Bareos :sinceVersion:`16.2.4: configure add` offers the :ref:`configure add command ` to add resources to the |dir|. Start the :command:`bconsole` and use the :bcommand:`configure add client` command. Address must be a DNS resolvable name or an IP address. @@ -626,9 +626,9 @@ This creates two resource configuration files: - :file:`/etc/bareos/bareos-dir-export/client/client2-fd/bareos-fd.d/director/bareos-dir.conf` (assuming your director resource is named **bareos-dir**) -The :file:`/etc/bareos/bareos-dir-export/client/client2-fd/bareos-fd.d/director/bareos-dir.conf` is the required resource needed on the |bareosFd|. You can copy it to the destination: +The :file:`/etc/bareos/bareos-dir-export/client/client2-fd/bareos-fd.d/director/bareos-dir.conf` is the required resource needed on the |fd|. You can copy it to the destination: -.. code-block:: sh +.. code-block:: shell-session :caption: Copy the bareos-fd director resource to the new client scp /etc/bareos/bareos-dir-export/client/client2-fd/bareos-fd.d/director/bareos-dir.conf root@client2.example.com:/etc/bareos/bareos-fd.d/director/ @@ -636,7 +636,7 @@ The :file:`/etc/bareos/bareos-dir-export/client/client2-fd/bareos-fd.d/director/ Manual configuration ^^^^^^^^^^^^^^^^^^^^ -Alternatively you can configure your resources manually. On the |bareosDir| create the file +Alternatively you can configure your resources manually. On the |dir| create the file .. code-block:: bareosconfig :caption: bareos-dir.d/client/client2-fd.conf @@ -647,7 +647,7 @@ Alternatively you can configure your resources manually. On the |bareosDir| crea Password = secret } -Reload or restart your |bareosDir|: +Reload or restart your |dir|: .. code-block:: bconsole :caption: reload the Director configuration @@ -655,7 +655,7 @@ Reload or restart your |bareosDir|: *reload reloaded -The corresponding |bareosFd| director resource can be created directly on the client, see below. +The corresponding |fd| director resource can be created directly on the client, see below. Client: configure ~~~~~~~~~~~~~~~~~ @@ -681,19 +681,19 @@ The package **bareos-filedaemon** :sinceVersion:`16.2.4: Client resource files` In detail: :file:`client/myself.conf` - defines the name of the client. The default is :file:`-fd`. Changes are only required, if you want to use another name or en- or disable special |bareosFd| features. See :ref:`ClientResourceClient`. + defines the name of the client. The default is :file:`-fd`. Changes are only required, if you want to use another name or en- or disable special |fd| features. See :ref:`ClientResourceClient`. :file:`director/bareos-dir.conf` - gives the |bareosDir| **bareos-dir** full access to this |bareosFd|. During installation, the :config:option:`fd/director/Password`\ is set to a random default. Adapt the name and/or the password to your |bareosDir|. (The name **bareos-dir** is the default |bareosDir| name since Bareos :sinceVersion:`16.2.4: bareos-dir is the default |bareosDir| name`.) + gives the |dir| **bareos-dir** full access to this |fd|. During installation, the :config:option:`fd/director/Password`\ is set to a random default. Adapt the name and/or the password to your |dir|. (The name **bareos-dir** is the default |dir| name since Bareos :sinceVersion:`16.2.4: bareos-dir is the default |dir| name`.) :file:`director/bareos-mon.conf` - gives the |bareosDir| **bareos-mon** restricted access to this |bareosFd|. During installation, the :config:option:`fd/director/Password`\ is set to a random value. This resource is intended to be used by the local **bareos-tray-monitor**. + gives the |dir| **bareos-mon** restricted access to this |fd|. During installation, the :config:option:`fd/director/Password`\ is set to a random value. This resource is intended to be used by the local **bareos-tray-monitor**. :file:`messages/Standard.conf` - defines, how messages should be handled. The default sends all relevant messages to the |bareosDir|. + defines, how messages should be handled. The default sends all relevant messages to the |dir|. -If your |bareosDir| is named **bareos-dir**, the :file:`/etc/bareos/bareos-fd.d/director/bareos-dir.conf` may already be overwritten by the file you copied from the |bareosDir|. If your Director has another name, an addition resource file will exists. You can define an arbitrary number of |bareosDir|’s in your |bareosFd| configuration. However, normally you will only have one :config:option:`Fd/Director`\ with -full control of your |bareosFd| and optional one :config:option:`Fd/Director`\ for monitoring (used by the |bareosTrayMonitor|). +If your |dir| is named **bareos-dir**, the :file:`/etc/bareos/bareos-fd.d/director/bareos-dir.conf` may already be overwritten by the file you copied from the |dir|. If your Director has another name, an addition resource file will exists. You can define an arbitrary number of |dir|’s in your |fd| configuration. However, normally you will only have one :config:option:`Fd/Director`\ with +full control of your |fd| and optional one :config:option:`Fd/Director`\ for monitoring (used by the |traymonitor|). Anyhow, the resource will look similar to this: @@ -705,9 +705,9 @@ Anyhow, the resource will look similar to this: Password = "[md5]5ebe2294ecd0e0f08eab7690d2a6ee69" } -After a restart of the |bareosFd| to reload the configuration this resource allows the access for a |bareosDir| with name **bareos-dir** and password **secret** (stored in MD5 format). +After a restart of the |fd| to reload the configuration this resource allows the access for a |dir| with name **bareos-dir** and password **secret** (stored in MD5 format). -.. code-block:: sh +.. code-block:: shell-session :caption: restart bareos-fd service bareos-fd restart @@ -717,7 +717,7 @@ After a restart of the |bareosFd| to reload the configuration this resource allo Manual configuration ^^^^^^^^^^^^^^^^^^^^ -If you have not created the :config:option:`Fd/Director`\ by :bcommand:`configure`, you can create it also manually. If your |bareosDir| is also named **bareos-dir**, modify or create the file :file:`/etc/bareos/bareos-fd.d/director/bareos-dir.conf`: +If you have not created the :config:option:`Fd/Director`\ by :bcommand:`configure`, you can create it also manually. If your |dir| is also named **bareos-dir**, modify or create the file :file:`/etc/bareos/bareos-fd.d/director/bareos-dir.conf`: .. code-block:: bareosconfig :caption: bareos-fd.d/director/bareos-dir.conf @@ -731,16 +731,16 @@ If you have not created the :config:option:`Fd/Director`\ by :bcommand:`configu See the relation between resource names and password of the different Bareos components in :ref:`section-resource-relation`. -If your are not using the :ref:`section-SubdirectoryConfigurationScheme`, make sure that this resource file gets included in your |bareosFd| configuration. You can verify this by +If your are not using the :ref:`section-SubdirectoryConfigurationScheme`, make sure that this resource file gets included in your |fd| configuration. You can verify this by -.. code-block:: sh +.. code-block:: shell-session :caption: show how bareos-fd would read the current configuration files bareos-fd -xc -After modifying the file, you have to restart the |bareosFd|: +After modifying the file, you have to restart the |fd|: -.. code-block:: sh +.. code-block:: shell-session :caption: restart bareos-fd service bareos-fd restart @@ -750,7 +750,7 @@ Director: test client, add a job The following example show how to -- Verify the network connection from |bareosDir| to the |bareosFd|. +- Verify the network connection from |dir| to the |fd|. - Add a job resource. @@ -800,9 +800,9 @@ The same considerations apply if you have just mounted a blank tape in a drive. Pools ----- -:index:`[TAG=Pool->Overview] ` +:index:`[TAG=Pool->Overview] ` -Creating the Pool is automatically done when the |bareosDir| starts, so if you understand Pools, you can skip to the next section. +Creating the Pool is automatically done when the |dir| starts, so if you understand Pools, you can skip to the next section. When you run a backup job, one of the things that Bareos must know is what Volumes to use. Instead of specifying a Volume (tape) directly, you specify which Pool of Volumes you want Bareos to consult when it wants a Volume for writing backups. Bareos will select the first available Volume from the Pool that is appropriate for the :config:option:`dir/job/Storage`\ you have specified for the Job being run. When a volume has filled up with data, Bareos will change its **VolStatus** from **Append** to **Full**, and then Bareos will use the next volume and so on. If no appendable Volume exists in the Pool, the Director will attempt to recycle an old Volume. For details, please read the :ref:`RecyclingChapter` chapter. @@ -829,7 +829,7 @@ When Bareos starts, it ensures that all Pool resource definitions have been reco Other Useful Console Commands ----------------------------- -:index:`[TAG=Console->Commands->Useful] ` +:index:`[TAG=Console->Commands->Useful] ` help Show the list all all available commands. @@ -838,40 +838,40 @@ help list Show detail information about a specific command, in this case the command :bcommand:`list`. status dir - :index:`[TAG=Console->Command->status dir] ` Print a status of all running jobs and jobs scheduled in the next 24 hours. + :index:`[TAG=Console->Command->status dir] ` Print a status of all running jobs and jobs scheduled in the next 24 hours. status - :index:`[TAG=Console->Command->status] ` The console program will prompt you to select a daemon type, then will request the daemon’s status. + :index:`[TAG=Console->Command->status] ` The console program will prompt you to select a daemon type, then will request the daemon’s status. status jobid=nn - :index:`[TAG=Console->Command->status jobid] ` Print a status of JobId nn if it is running. The Storage daemon is contacted and requested to print a current status of the job as well. + :index:`[TAG=Console->Command->status jobid] ` Print a status of JobId nn if it is running. The Storage daemon is contacted and requested to print a current status of the job as well. list pools - :index:`[TAG=Console->Command->list pools] ` List the pools defined in the Catalog (normally only Default is used). + :index:`[TAG=Console->Command->list pools] ` List the pools defined in the Catalog (normally only Default is used). list volumes - :index:`[TAG=Console->Command->list volumes] ` Lists all the media defined in the Catalog. + :index:`[TAG=Console->Command->list volumes] ` Lists all the media defined in the Catalog. list jobs - :index:`[TAG=Console->Command->list jobs] ` Lists all jobs in the Catalog that have run. + :index:`[TAG=Console->Command->list jobs] ` Lists all jobs in the Catalog that have run. list jobid=nn - :index:`[TAG=Console->Command->list jobid] ` Lists JobId nn from the Catalog. + :index:`[TAG=Console->Command->list jobid] ` Lists JobId nn from the Catalog. list jobtotals - :index:`[TAG=Console->Command->list jobtotals] ` Lists totals for all jobs in the Catalog. + :index:`[TAG=Console->Command->list jobtotals] ` Lists totals for all jobs in the Catalog. list files jobid=nn - :index:`[TAG=Console->Command->list files jobid] ` List the files that were saved for JobId nn. + :index:`[TAG=Console->Command->list files jobid] ` List the files that were saved for JobId nn. list jobmedia - :index:`[TAG=Console->Command->list jobmedia] ` List the media information for each Job run. + :index:`[TAG=Console->Command->list jobmedia] ` List the media information for each Job run. messages - :index:`[TAG=Console->Command->messages] ` Prints any messages that have been directed to the console. + :index:`[TAG=Console->Command->messages] ` Prints any messages that have been directed to the console. quit - :index:`[TAG=Console->Command->quit] ` Exit or quit the console program. + :index:`[TAG=Console->Command->quit] ` Exit or quit the console program. Most of the commands given above, with the exception of list, will prompt you for the necessary arguments if you simply enter the command name. diff --git a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/UpdatingBareos.rst b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/UpdatingBareos.rst index 1055f4a7594..9c5c8f5b3f3 100644 --- a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/UpdatingBareos.rst +++ b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/UpdatingBareos.rst @@ -26,8 +26,9 @@ Sometimes improvements in Bareos make it necessary to update the database scheme -.. warning:: - If the Bareos catalog database does not have the current schema, the Bareos Director refuses to start. + .. warning:: + + If the Bareos catalog database does not have the current schema, the Bareos Director refuses to start. Detailed information can then be found in the log file :file:`/var/log/bareos/bareos.log`. @@ -35,8 +36,9 @@ Take a look into the :ref:`Release Notes ` to see which Bareos upd -.. warning:: - Especially the upgrade to Bareos >= 17.2.0 restructures the **File** database table. In larger installations this is very time consuming and temporarily doubles the amount of required database disk space. + .. warning:: + + Especially the upgrade to Bareos >= 17.2.0 restructures the **File** database table. In larger installations this is very time consuming and temporarily doubles the amount of required database disk space. Debian based Linux Distributions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -45,10 +47,11 @@ Since Bareos :sinceVersion:`14.2.0: dbconfig-common (Debian)` the Debian (and Ub -.. warning:: - When using the PostgreSQL backend and updating to Bareos < 14.2.3, it is necessary to manually grant database permissions, normally by using + .. warning:: -.. code-block:: sh + When using the PostgreSQL backend and updating to Bareos < 14.2.3, it is necessary to manually grant database permissions, normally by using + +.. code-block:: shell-session su - postgres -c /usr/lib/bareos/scripts/grant_bareos_privileges @@ -69,15 +72,16 @@ However, this script requires administration access to the database. Depending o -.. warning:: - If you're updating to Bareos <= 13.2.3 and have configured the Bareos database during install using Bareos environment variables (\variable{db_name}, \variable{db_user} or \variable{db_password}, see :ref:`CatMaintenanceChapter`), make sure to have these variables defined in the same way when calling the update and grant scripts. Newer versions of Bareos read these variables from the Director configuration file \configFileDirUnix. However, make sure that the user running the database scripts has read access to this file (or set the environment variables). The **postgres** user normally does not have the required permissions. + .. warning:: + + If you're updating to Bareos <= 13.2.3 and have configured the Bareos database during install using Bareos environment variables (``db_name``\ , ``db_user``\ or ``db_password``\ , see :ref:`CatMaintenanceChapter`), make sure to have these variables defined in the same way when calling the update and grant scripts. Newer versions of Bareos read these variables from the Director configuration file \configFileDirUnix. However, make sure that the user running the database scripts has read access to this file (or set the environment variables). The **postgres** user normally does not have the required permissions. PostgreSQL ^^^^^^^^^^ If your are using PostgreSQL and your PostgreSQL administrator is **postgres** (default), use following commands: -.. code-block:: sh +.. code-block:: shell-session :caption: Update PostgreSQL database schema su postgres -c /usr/lib/bareos/scripts/update_bareos_tables @@ -102,7 +106,7 @@ Make sure, that **root** has direct access to the local MySQL server. Check if t If you are able to connect via the :command:`mysql` to the database, run the following script from the Unix prompt: -.. code-block:: sh +.. code-block:: shell-session :caption: Update MySQL database schema /usr/lib/bareos/scripts/update_bareos_tables diff --git a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/WhatIsBareos.rst b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/WhatIsBareos.rst index a0f41f42ef8..5294e379c0e 100644 --- a/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/WhatIsBareos.rst +++ b/docs/manuals/en/new_main_reference/source/IntroductionAndTutorial/WhatIsBareos.rst @@ -50,27 +50,27 @@ The Director is the central control program for all the other daemons. It schedu Bareos Console ~~~~~~~~~~~~~~ -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 :ref:`section-bconsole`. +The Bareos Console (:command:`bconsole`) is the program that allows the administrator or user to communicate with the |dir|. It runs in a shell window (i.e. TTY interface). Most system administrators will find this completely adequate. For more details see the :ref:`section-bconsole`. .. _FDDef: Bareos File Daemon ~~~~~~~~~~~~~~~~~~ -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|. +The |fd| is a program that must be installed on each (Client) machine that should be backed up. At the request of the |dir|, it finds the files to be backed up and sends them (their data) to the |sd|. -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|. +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 |dir|. -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. +The |fd| 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. .. _SDDef: Bareos Storage Daemon ~~~~~~~~~~~~~~~~~~~~~ -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|. +The |sd| is responsible, at the |dir| request, for accepting data from a |fd| 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 |fd|. -There can be multiple |bareosSd| in your environment, all controlled by the same |bareosDir|. +There can be multiple |sd| in your environment, all controlled by the same |dir|. The Storage services runs as a daemon on the machine that has the backup device (such as a tape drive). @@ -225,11 +225,11 @@ Not all packages are required to run Bareos. - For the Bareos Director, the package **bareos-director** and one of **bareos-database-postgresql**, **bareos-database-mysql** or **bareos-database-sqlite3** are required. It is recommended to use **bareos-database-postgresql**. -- For the |bareosSd|, the package **bareos-storage** is required. If you plan to connect tape drives to the storage director, also install the package **bareos-storage-tape**. This is kept separately, because it has additional dependencies for tape tools. +- For the |sd|, the package **bareos-storage** is required. If you plan to connect tape drives to the storage director, also install the package **bareos-storage-tape**. This is kept separately, because it has additional dependencies for tape tools. - On a client, only the package **bareos-filedaemon** is required. If you run it on a workstation, the packages **bareos-traymonitor** gives the user information about running backups. -- On a Backup Administration system you need to install at least **bareos-bconsole** to have an interactive console to the |bareosDir|. +- On a Backup Administration system you need to install at least **bareos-bconsole** to have an interactive console to the |dir|. Quick Start ----------- @@ -379,7 +379,7 @@ The Current State of Bareos What is Implemented ~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Implementation->What is implemented] ` +:index:`[TAG=Implementation->What is implemented] ` - Job Control @@ -507,7 +507,7 @@ Advantages Over Other Backup Programs Current Implementation Restrictions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Restrictions->Current Implementation] ` +:index:`[TAG=Restrictions->Current Implementation] ` - @@ -522,7 +522,7 @@ Current Implementation Restrictions Design Limitations or Restrictions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Restrictions->Design Limitations] ` :index:`[TAG=Design->Limitations] ` +:index:`[TAG=Restrictions->Design Limitations] ` :index:`[TAG=Design->Limitations] ` - Names (resource names, volume names, and such) defined in Bareos configuration files are limited to a fixed number of characters. Currently the limit is defined as 127 characters. Note, this does not apply to filenames, which may be arbitrarily long. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AlwaysIncrementalBackupScheme.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AlwaysIncrementalBackupScheme.rst index 5bd89fa5d51..b0c0e3c0f88 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AlwaysIncrementalBackupScheme.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AlwaysIncrementalBackupScheme.rst @@ -124,7 +124,7 @@ Consolidate Job JobDefs = "DefaultJob" } -\resourceDirectiveValue{Dir}{Job}{Type}{Consolidate} +:config:option:`dir/job/Type = Consolidate`\ configures a job to be a consolidate job. This type have been introduced with the Always Incremental feature. When used, it automatically trigger the consolidation of incremental jobs that need to be consolidated. :config:option:`dir/job/Accurate = yes`\ @@ -139,11 +139,12 @@ The always incremental jobs need to be executed during the backup window (usuall -.. warning:: - All Bareos job resources have some required directives, e.g. :config:option:`dir/job/Client`\ . - Even so, none other than the mentioned directives are evaluated by a \resourceDirectiveValue{Dir}{Job}{Type}{Consolidate}, + .. warning:: + + All Bareos job resources have some required directives, e.g. :config:option:`dir/job/Client`\ . + Even so, none other than the mentioned directives are evaluated by a :config:option:`dir/job/Type = Consolidate`\ , they still have to be defined. - Normally all required directives are already set in \resourceDirectiveValue{Dir}{Job}{Job Defs}{DefaultJob}. + Normally all required directives are already set in :config:option:`dir/job/JobDefs = DefaultJob`\ . If not, you have to add them. You can use arbitrary, but valid values. Storages and Pools @@ -308,14 +309,14 @@ Depending on the setting of the :config:option:`dir/job/AlwaysIncrementalMaxFull The resulting interval between full consolidations when running daily backups and daily consolidations is :config:option:`dir/job/AlwaysIncrementalMaxFullAge`\ - :config:option:`dir/job/AlwaysIncrementalJobRetention`\ . -\centering + .. figure:: /include/images/always-incremental-jobdata-AlwaysIncrementalMaxFullAge_21_days.* :alt: Data Volume being moved with "Always Incremental Max Full Age" Data Volume being moved with "Always Incremental Max Full Age" -\centering + .. figure:: /include/images/always-incremental-jobs_available-AlwaysIncrementalMaxFullAge_21_days.* :alt: Jobs Available with "Always Incremental Max Full Age" @@ -339,7 +340,7 @@ As can be seen, virtual jobs including the full are triggered for all three clie This is of course not desirable so the directive :config:option:`dir/job/MaxFullConsolidations`\ was introduced. -:config:option:`dir/job/MaxFullConsolidations`\ needs to be configured in the \resourceDirectiveValue{Dir}{Job}{Type}{Consolidate} job: +:config:option:`dir/job/MaxFullConsolidations`\ needs to be configured in the :config:option:`dir/job/Type = Consolidate`\ job: .. code-block:: bareosconfig :caption: bareos-dir.d/job/Consolidate.conf @@ -359,14 +360,14 @@ This leads to a better load balancing of full backup consolidations over differe The number of always incremental jobs, the interval that the jobs are triggered and the setting of :config:option:`dir/job/AlwaysIncrementalMaxFullAge`\ influence the value that makes sense for :config:option:`dir/job/MaxFullConsolidations`\ . -\centering + .. figure:: /include/images/jobdata_multiple_clients_maxfullconsilidate.* :alt: Data Volume being moved with Max Full Consolidations = 1 Data Volume being moved with Max Full Consolidations = 1 -\centering + .. figure:: /include/images/jobs_available_multiple_clients_maxfullconsolidate.* :alt: Jobs Available with Max Full Consolidations = 1 @@ -441,9 +442,9 @@ The alternative to Copy Jobs is creating a virtual Full Backup Job when the data } } -To make sure the longterm \resourceDirectiveValue{Dir}{Job}{Level}{VirtualFull} is not taken as base for the next incrementals, the job type of the copied job is set to \resourceDirectiveValue{Dir}{Job}{Type}{Archive} with the :config:option:`dir/job/RunScript`\ . +To make sure the longterm :config:option:`dir/job/Level = VirtualFull`\ is not taken as base for the next incrementals, the job type of the copied job is set to :config:option:`dir/job/Type = Archive`\ with the :config:option:`dir/job/RunScript`\ . -As can be seen on the plot, the \resourceDirectiveValue{Dir}{Job}{Level}{VirtualFull} archives the current data, i.e. it consolidates the full and all incrementals that are currently available. +As can be seen on the plot, the :config:option:`dir/job/Level = VirtualFull`\ archives the current data, i.e. it consolidates the full and all incrementals that are currently available. .. image:: /include/images/always-incremental-virtualfull-job-archiving.* diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AutochangerSupport.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AutochangerSupport.rst index 32ae3d43ca9..ce75f358fb6 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AutochangerSupport.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AutochangerSupport.rst @@ -3,7 +3,7 @@ Autochanger Support =================== -:index:`[TAG=Support->Autochanger] ` :index:`[TAG=Autochanger->Support] ` +:index:`[TAG=Support->Autochanger] ` :index:`[TAG=Autochanger->Support] ` Bareos provides autochanger support for reading and writing tapes. In order to work with an autochanger, Bareos requires a number of things, each of which is explained in more detail after this list: @@ -15,7 +15,7 @@ Bareos provides autochanger support for reading and writing tapes. In order to w - Modifications to your Storage daemon’s Device configuration resource to identify that the device is a changer, as well as a few other parameters. -- You need to ensure that your Storage daemon has access permissions to both the tape drive and the control device. On Linux, the system user **bareos** is added to the groups \group{disk} and \group{tape}, so that it should have the permission to access the library. +- You need to ensure that your Storage daemon has access permissions to both the tape drive and the control device. On Linux, the system user **bareos** is added to the groups :strong:`disk` and :strong:`tape`, so that it should have the permission to access the library. - Set :config:option:`dir/storage/AutoChanger = yes`\ . @@ -28,7 +28,7 @@ Current Bareos autochanger support does not include cleaning, stackers, or silos In principle, if :command:`mtx` will operate your changer correctly, then it is just a question of adapting the :command:`mtx-changer` script (or selecting one already adapted) for proper interfacing. -If you are having troubles, please use the auto command in the :command:`btape` program to test the functioning of your autochanger with Bareos. Please remember, that on most distributions, the |bareosSd| runs as user **bareos** and not as **root**. You will need to ensure that the Storage daemon has sufficient permissions to access the autochanger. +If you are having troubles, please use the auto command in the :command:`btape` program to test the functioning of your autochanger with Bareos. Please remember, that on most distributions, the |sd| runs as user **bareos** and not as **root**. You will need to ensure that the Storage daemon has sufficient permissions to access the autochanger. Some users have reported that the the Storage daemon blocks under certain circumstances in trying to mount a volume on a drive that has a different volume loaded. As best we can determine, this is simply a matter of waiting a bit. The drive was previously in use writing a Volume, and sometimes the drive will remain BLOCKED for a good deal of time (up to 7 minutes on a slow drive) waiting for the cassette to rewind and to unload before the drive can be used with a different Volume. @@ -37,7 +37,7 @@ Some users have reported that the the Storage daemon blocks under certain circum Knowing What SCSI Devices You Have ---------------------------------- -:index:`[TAG=SCSI devices] ` :index:`[TAG=Devices->SCSI] ` :index:`[TAG=Devices->Detecting] ` +:index:`[TAG=SCSI devices] ` :index:`[TAG=Devices->SCSI] ` :index:`[TAG=Devices->Detecting] ` Linux ~~~~~ @@ -105,7 +105,7 @@ The following tip for FreeBSD users comes from Danny Butroyd: on reboot Bareos w This gives the bareos group permission to write to the nsa0.0 device too just to be on the safe side. To bring these changes into effect just run:- -.. code-block:: sh +.. code-block:: shell-session /etc/rc.d/devfs restart @@ -142,7 +142,7 @@ You can check if the Slot number and InChanger flag by: Multiple Devices ---------------- -:index:`[TAG=Devices->Multiple] ` :index:`[TAG=Multiple Devices] ` +:index:`[TAG=Devices->Multiple] ` :index:`[TAG=Multiple Devices] ` Some autochangers have more than one read/write device (drive). The :ref:`Autochanger resource ` permits you to group Device resources, where each device represents a drive. The Director may still reference the Devices (drives) directly, but doing so, bypasses the proper functioning of the drives together. Instead, the Director (in the Storage resource) should reference the Autochanger resource name. Doing so permits the Storage daemon to ensure that only one drive uses the mtx-changer script at a time, and also that two drives don’t reference the same Volume. @@ -173,7 +173,7 @@ Following records control how Bareos uses the autochanger: Specifying Slots When Labeling ------------------------------ -:index:`[TAG=Specifying Slots When Labeling] ` :index:`[TAG=Label->Specifying Slots When Labeling] ` +:index:`[TAG=Specifying Slots When Labeling] ` :index:`[TAG=Label->Specifying Slots When Labeling] ` .. _SpecifyingSlots: @@ -206,7 +206,7 @@ Any slot containing a barcode of CLNxxxx will be treated as a cleaning tape and Changing Cartridges ------------------- -:index:`[TAG=Cartridges->Changing] ` If you wish to insert or remove cartridges in your autochanger or you manually run the mtx program, you must first tell Bareos to release the autochanger by doing: +:index:`[TAG=Cartridges->Changing] ` If you wish to insert or remove cartridges in your autochanger or you manually run the mtx program, you must first tell Bareos to release the autochanger by doing: @@ -223,7 +223,7 @@ If you do not do the unmount before making such a change, Bareos will become com Dealing with Multiple Magazines ------------------------------- -:index:`[TAG=Magazines->Dealing with Multiple] ` +:index:`[TAG=Magazines->Dealing with Multiple] ` If you have several magazines or if you insert or remove cartridges from a magazine, you should notify Bareos of this. By doing so, Bareos will as a preference, use Volumes that it knows to be in the autochanger before accessing Volumes that are not in the autochanger. This prevents unneeded operator intervention. @@ -265,7 +265,7 @@ If you do not have a barcode reader on your autochanger, you have several altern Update Slots Command -------------------- -:index:`[TAG=Console->Command->update slots] ` +:index:`[TAG=Console->Command->update slots] ` .. _updateslots: @@ -310,7 +310,7 @@ will read the barcoded Volume names for slots 1,2,3 and 6 and make the appropria Using the Autochanger --------------------- -:index:`[TAG=Autochanger->Using the] ` +:index:`[TAG=Autochanger->Using the] ` .. _using: @@ -401,7 +401,7 @@ To "see" how you have labeled your Volumes, simply enter the list volumes comman :: - *{\bf list volumes} + *:strong:`list volumes` Using default Catalog name=BackupDB DB=bareos Defined Pools: 1: Default @@ -421,7 +421,7 @@ To "see" how you have labeled your Volumes, simply enter the list volumes comman Barcode Support --------------- -:index:`[TAG=Support->Barcode] ` :index:`[TAG=Barcode Support] ` +:index:`[TAG=Support->Barcode] ` :index:`[TAG=Barcode Support] ` .. _Barcodes: @@ -459,7 +459,7 @@ If you see a near the slot number, you have to run update slots command to synch Bareos Autochanger Interface ---------------------------- -:index:`[TAG=Autochanger->Interface] ` +:index:`[TAG=Autochanger->Interface] ` .. _autochanger-interface: @@ -480,8 +480,8 @@ Bareos calls the autochanger script that you specify on the Changer Command stat unload -- unloads the device (returns cassette to its slot). list -- returns one line for each cassette in the autochanger in the format :. Where - the {\bf slot} is the non-zero integer representing - the slot number, and {\bf barcode} is the barcode + the :strong:`slot` is the non-zero integer representing + the slot number, and :strong:`barcode` is the barcode associated with the cassette if it exists and if you autoloader supports barcodes. Otherwise the barcode field is blank. @@ -494,7 +494,7 @@ Bareos checks the exit status of the program called, and if it is zero, the data Tapespeed and blocksizes ------------------------ -:index:`[TAG=Tuning->Tape] ` :index:`[TAG=Tuning->blocksize] ` :index:`[TAG=Tape->speed] ` :index:`[TAG=Blocksize->optimize] ` +:index:`[TAG=Tuning->Tape] ` :index:`[TAG=Tuning->blocksize] ` :index:`[TAG=Tape->speed] ` :index:`[TAG=Blocksize->optimize] ` .. _Tapespeed and blocksizes: @@ -504,7 +504,7 @@ Tapespeed and blocksizes -The `Bareos Whitepaper Tape Speed Tuning `_ shows that the two parameters :strong:`Maximum File Size` and :strong:`Maximum Block Size` of the device have significant influence on the tape speed. +The `Bareos Whitepaper Tape Speed Tuning `_ shows that the two parameters :strong:`Maximum File Size`\ and :strong:`Maximum Block Size`\ of the device have significant influence on the tape speed. While it is no problem to change the :config:option:`sd/device/MaximumFileSize`\ parameter, unfortunately it is not possible to change the :config:option:`sd/device/MaximumBlockSize`\ parameter, because the previously written tapes would become unreadable in the new setup. It would require that the :config:option:`sd/device/MaximumBlockSize`\ parameter is switched back to the old value to be able to read the old volumes, but of course then the new volumes would be unreadable. @@ -547,7 +547,7 @@ To solve this problem, the block size handling was changed in Bareos :sinceVersi - The tape label block is always written in the standard 63k (64512) block size. -- The following blocks are then written in the block size configured in the :strong:`Maximum Block Size` directive. +- The following blocks are then written in the block size configured in the :strong:`Maximum Block Size`\ directive. - To be able to change the block size in an existing environment, it is now possible to set the :config:option:`dir/pool/MaximumBlockSize`\ and :config:option:`dir/pool/MinimumBlockSize`\ in the pool resource. This setting is automatically promoted to each medium in that pool as usual (i.e. when a medium is labeled for that pool or if a volume is transferred to that pool from the scratch pool). When a volume is mounted, the volume’s block size is used to write and read the data blocks that follow the header block. @@ -616,15 +616,15 @@ Here, the block was written with 1M block size but we only read 64k. Direct access to Volumes with with non-default block sizes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=bls->block size] ` :index:`[TAG=bextract->block size] ` :index:`[TAG=Command->bls->block size] ` :index:`[TAG=Command->bextract->block size] ` +:index:`[TAG=bls->block size] ` :index:`[TAG=bextract->block size] ` :index:`[TAG=Command->bls->block size] ` :index:`[TAG=Command->bextract->block size] ` :command:`bls` and :command:`bextract` can directly access Bareos volumes without catalog database. This means that these programs don’t have information about the used block size. To be able to read a volume written with an arbitrary block size, you need to set the :config:option:`sd/device/LabelBlockSize`\ (to be able to to read the label block) and the :config:option:`sd/device/MaximumBlockSize`\ (to be able to read the data blocks) setting in the device definition used by those tools to be able to open the medium. -Example using :command:`bls` with a tape that was written with another blocksize than the \variable{DEFAULT_BLOCK_SIZE} (63k), but with the default label block size of 63k: +Example using :command:`bls` with a tape that was written with another blocksize than the ``DEFAULT_BLOCK_SIZE``\ (63k), but with the default label block size of 63k: -.. code-block:: sh +.. code-block:: shell-session :caption: bls with non-default block size bls FC-Drive-1 -V A00007L4 @@ -637,9 +637,9 @@ Example using :command:`bls` with a tape that was written with another blocksize Device status: ONLINE IM_REP_EN file=0 block=2 0 files found. -As can be seen, :command:`bls` manages to read the label block as it knows what volume is mounted (Ready to read from volume ``A00007L4``), but fails to read the data blocks. +As can be seen, :command:`bls` manages to read the label block as it knows what volume is mounted (Ready to read from volume :strong:`A00007L4`), but fails to read the data blocks. -.. code-block:: sh +.. code-block:: shell-session :caption: dmesg dmesg @@ -669,7 +669,7 @@ Now we have to set this block size in the :file:`bareos-sd.conf`, device resourc Now we can call bls again, and everything works as expected: -.. code-block:: sh +.. code-block:: shell-session :caption: bls with non-default block size bls FC-Drive-1 -V A00007L4 diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AutomatedDiskBackup.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AutomatedDiskBackup.rst index 099ad2c58fe..731d5c902f2 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AutomatedDiskBackup.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/AutomatedDiskBackup.rst @@ -3,7 +3,7 @@ Automated Disk Backup ===================== -:index:`[TAG=Volumes->Using Pools to Manage] ` :index:`[TAG=Disk->Automated Backup] ` :index:`[TAG=Automated Disk Backup] ` :index:`[TAG=Pool] ` +:index:`[TAG=Volumes->Using Pools to Manage] ` :index:`[TAG=Disk->Automated Backup] ` :index:`[TAG=Automated Disk Backup] ` :index:`[TAG=Pool] ` If you manage five or ten machines and have a nice tape backup, you don’t need Pools, and you may wonder what they are good for. In this chapter, you will see that Pools can help you optimize disk storage space. The same techniques can be applied to a shop that has multiple tape drives, or that wants to mount various different Volumes to meet their needs. @@ -32,7 +32,7 @@ storage space can be reused. As mentioned, the solution is to have multiple Volumes, or files on the disk. To do so, we need to limit the use and thus the size of a single Volume, by time, by number of jobs, or by size. Any of these would work, but we chose to limit the use of a single Volume by putting a single job in each Volume with the exception of Volumes containing Incremental backup where there will be 6 jobs (a week’s worth of data) per volume. The details of this will be discussed shortly. This is a single client backup, so if you have multiple clients you will need to multiply those numbers by the number of clients, or use a different system for switching volumes, such as limiting the volume size. -.. TODO: This chapter will get rewritten. Instead of limiting a Volume to one job, we will utilize \variable{Max Use Duration = 24 hours}. This prevents problems when adding more clients, because otherwise each job has to run seperat. +.. TODO: This chapter will get rewritten. Instead of limiting a Volume to one job, we will utilize ``Max Use Duration = 24 hours``\ . This prevents problems when adding more clients, because otherwise each job has to run seperat. The next problem to resolve is recycling of Volumes. As you noted from above, the requirements are to be able to restore monthly for 6 months, weekly for a month, and daily for a week. So to simplify things, why not do a Full save once a month, a Differential save once a week, and Incremental saves daily. Now since each of these different kinds of saves needs to remain valid for differing periods, the simplest way to do this (and possibly the only) is to have a separate Pool for each backup type. @@ -48,7 +48,7 @@ The decision was to use three Pools: one for Full saves, one for Differential sa Full Pool ~~~~~~~~~ -:index:`[TAG=Pool->Full] ` :index:`[TAG=Full Pool] ` +:index:`[TAG=Pool->Full] ` :index:`[TAG=Full Pool] ` Putting a single Full backup on each Volume, will require six Full save Volumes, and a retention period of six months. The Pool needed to do that is: @@ -81,7 +81,7 @@ If you have two clients, you would want to set Maximum Volume Jobs to 2 instead Differential Pool ~~~~~~~~~~~~~~~~~ -:index:`[TAG=Pool->Differential] ` :index:`[TAG=Differential Pool] ` +:index:`[TAG=Pool->Differential] ` :index:`[TAG=Differential Pool] ` For the Differential backup Pool, we choose a retention period of a bit longer than a month and ensure that there is at least one Volume for each of the maximum of five weeks in a month. So the following works: @@ -114,7 +114,7 @@ See the discussion above concering the Full pool for how to handle multiple clie Incremental Pool ~~~~~~~~~~~~~~~~ -:index:`[TAG=Incremental Pool] ` :index:`[TAG=Pool->Incremental] ` +:index:`[TAG=Incremental Pool] ` :index:`[TAG=Pool->Incremental] ` Finally, here is the resource for the Incremental Pool: diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/BareosConsole.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/BareosConsole.rst index 7be383dac11..5a308c18ff4 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/BareosConsole.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/BareosConsole.rst @@ -3,7 +3,7 @@ Bareos Console ============== -:index:`[TAG=Bareos Console] ` :index:`[TAG=bconsole] ` :index:`[TAG=Command->bconsole] ` +:index:`[TAG=Bareos Console] ` :index:`[TAG=bconsole] ` :index:`[TAG=Command->bconsole] ` The Bareos Console (:command:`bconsole`) is a program that allows the user or the System Administrator, to interact with the Bareos Director daemon while the daemon is running. @@ -16,7 +16,7 @@ In fact, a certain minimal knowledge of the Console program is needed in order f Console Configuration --------------------- -:index:`[TAG=Configuration->Console] ` :index:`[TAG=Configuration->bconsole] ` +:index:`[TAG=Configuration->Console] ` :index:`[TAG=Configuration->bconsole] ` When the Console starts, it reads a standard Bareos configuration file named bconsole.conf unless you specify the -c command line option (see below). This file allows default configuration of the Console, and at the current time, the only Resource Record defined is the Director resource, which gives the Console the name and address of the Director. For more information on configuration of the Console program, please see the :ref:`Console Configuration ` chapter of this document. @@ -28,9 +28,10 @@ The console program can be run with the following options: :index:`[TAG=Command Line Options] ` -:: +.. code-block:: shell-session + :caption: bconsole command line options - \begin{commandOut}{bconsole command line options}{}{bconsole -?} + root@host:~# bconsole -? Usage: bconsole [-s] [-c config_file] [-d debug_level] -D select a Director -l list Directors defined @@ -45,7 +46,6 @@ The console program can be run with the following options: -xc print configuration and exit -xs print configuration file schema in JSON format and exit -? print this message. - \end{commandOut} After launching the Console program (bconsole), it will prompt you for the next command with an asterisk (*). Generally, for all commands, you can simply enter the command name and the Console program will prompt you for the necessary arguments. Alternatively, in most cases, you may enter the command followed by arguments. The general format is: @@ -86,7 +86,7 @@ The maximum command line length is limited to 511 characters, so if you are scri Exit the Console Program ~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Command->bconsole->exit] ` +:index:`[TAG=Command->bconsole->exit] ` Normally, you simply enter quit or exit and the Console program will terminate. However, it waits until the Director acknowledges the command. If the Director is already doing a lengthy command (e.g. prune), it may take some time. If you want to immediately terminate the Console program, enter the .quit command. @@ -96,7 +96,7 @@ Volume name. In that case, you will most likely be able to cancel at the next pr Running the Console from a Shell Script ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Console->Running from a Shell] ` +:index:`[TAG=Console->Running from a Shell] ` .. _scripting: @@ -173,7 +173,7 @@ The output from the backup is directed to /tmp/log1.out and the output from the Console Keywords ---------------- -:index:`[TAG=Console->Keywords] ` +:index:`[TAG=Console->Keywords] ` Unless otherwise specified, each of the following keywords takes an argument, which is specified after the keyword following an equal sign. For example: @@ -335,7 +335,7 @@ Console Commands The following commands are currently implemented: add - :index:`[TAG=Console->Command->add|textbf] ` This command is used to add Volumes to an existing Pool. That is, it creates the Volume name in the catalog and inserts into the Pool in the catalog, but does not attempt to access the physical Volume. Once added, Bareos expects that Volume to exist and to be labeled. This command is not normally used since Bareos will automatically do the equivalent when Volumes are labeled. However, there may be times when you have removed a Volume + :index:`[TAG=Console->Command->add|textbf] ` This command is used to add Volumes to an existing Pool. That is, it creates the Volume name in the catalog and inserts into the Pool in the catalog, but does not attempt to access the physical Volume. Once added, Bareos expects that Volume to exist and to be labeled. This command is not normally used since Bareos will automatically do the equivalent when Volumes are labeled. However, there may be times when you have removed a Volume from the catalog and want to later add it back. The full form of this command is: @@ -349,15 +349,15 @@ add 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 :bcommand:`label` command for the list of legal characters in a Volume name. autodisplay - :index:`[TAG=Console->Command->autodisplay on/off] ` This command accepts on or off as an argument, and turns auto-display of messages on or off respectively. The default for the console program is off, which means that you will be notified when there are console messages pending, but they will not automatically be displayed. + :index:`[TAG=Console->Command->autodisplay on/off] ` This command accepts on or off as an argument, and turns auto-display of messages on or off respectively. The default for the console program is off, which means that you will be notified when there are console messages pending, but they will not automatically be displayed. When autodisplay is turned off, you must explicitly retrieve the messages with the messages command. When autodisplay is turned on, the messages will be displayed on the console as they are received. automount - :index:`[TAG=Console->Command->automount on/off] ` This command accepts on or off as the argument, and turns auto-mounting of the Volume after a label command on or off respectively. The default is on. If automount is turned off, you must explicitly mount tape Volumes after a label command to use it. + :index:`[TAG=Console->Command->automount on/off] ` This command accepts on or off as the argument, and turns auto-mounting of the Volume after a label command on or off respectively. The default is on. If automount is turned off, you must explicitly mount tape Volumes after a label command to use it. cancel - :index:`[TAG=Console->Command->cancel jobid] ` This command is used to cancel a job and accepts jobid=nnn or job=xxx as an argument where nnn is replaced by the JobId and xxx is replaced by the job name. If you do not specify a keyword, the Console program will prompt you with the names of all the active jobs allowing you to choose one. + :index:`[TAG=Console->Command->cancel jobid] ` This command is used to cancel a job and accepts jobid=nnn or job=xxx as an argument where nnn is replaced by the JobId and xxx is replaced by the job name. If you do not specify a keyword, the Console program will prompt you with the names of all the active jobs allowing you to choose one. The full form of this command is: @@ -400,7 +400,7 @@ cancel This way you can also remove a job that blocks any other jobs from running without the need to restart the whole storage daemon. create - :index:`[TAG=Console->Command->create pool] ` This command is not normally used as the Pool records are automatically created by the Director when it starts based on what it finds in the configuration. If needed, this command can be used, to create a Pool record in the database using the Pool resource record defined in the Director’s configuration file. So in a sense, this command simply transfers the information from the Pool resource in the configuration file into the Catalog. + :index:`[TAG=Console->Command->create pool] ` This command is not normally used as the Pool records are automatically created by the Director when it starts based on what it finds in the configuration. If needed, this command can be used, to create a Pool record in the database using the Pool resource record defined in the Director’s configuration file. So in a sense, this command simply transfers the information from the Pool resource in the configuration file into the Catalog. Normally this command is done automatically for you when the Director starts providing the Pool is referenced within a Job resource. If you use this command on an existing Pool, it will automatically update the Catalog to have the same information as the Pool resource. After creating a Pool, you will most likely use the label command to label one or more volumes and add their names to the Media database. The full form of this command is: @@ -426,7 +426,7 @@ configure .. _section-bcommandConfigureAdd: - :index:`[TAG=Console->Command->configure add] ` + :index:`[TAG=Console->Command->configure add] ` This command allows to add resources during runtime. Usage: @@ -450,7 +450,7 @@ configure This feature requires :ref:`section-ConfigurationSubdirectories`. - All kinds of resources can be added. When adding a client resource, the :ref:`ClientResourceDirector` for the |bareosFd| is also created and stored at: + All kinds of resources can be added. When adding a client resource, the :ref:`ClientResourceDirector` for the |fd| is also created and stored at: :file:`/bareos-dir-export/client//bareos-fd.d/director/.conf` @@ -484,12 +484,13 @@ configure :file:`/etc/bareos/bareos-dir.d/job/client2-job.conf` - The files in :file:`bareos-dir-export/client/` directory are not used by the |bareosDir|. However, they can be copied to new clients to configure these clients for the |bareosDir|. + The files in :file:`bareos-dir-export/client/` directory are not used by the |dir|. However, they can be copied to new clients to configure these clients for the |dir|. -.. warning:: - Don't be confused by the extensive output of :bcommand:`help configure`. As :bcommand:`configure add` allows configuring arbitrary resources, the output of :bcommand:`help configure` lists all the resources, each with all valid directives. The same data is also used for :command:`bconsole` command line completion. + .. warning:: + + Don't be confused by the extensive output of :bcommand:`help configure`. As :bcommand:`configure add` allows configuring arbitrary resources, the output of :bcommand:`help configure` lists all the resources, each with all valid directives. The same data is also used for :command:`bconsole` command line completion. Available since Bareos :sinceVersion:`16.2.4: configure add`. @@ -498,9 +499,9 @@ configure .. _section-bcommandConfigureExport: - :index:`[TAG=Console->Command->configure export] ` + :index:`[TAG=Console->Command->configure export] ` - This command allows to export the :config:option:`Fd/Director`\ resource for clients already configured in the |bareosDir|. + This command allows to export the :config:option:`Fd/Director`\ resource for clients already configured in the |dir|. Usage: @@ -514,12 +515,12 @@ configure Password = "[md5]932d1d3ef3c298047809119510f4bee6" } - To use it, copy the :config:option:`Fd/Director`\ resource file to the client machine (on Linux: to :file:`/etc/bareos/bareos-fd.d/director/`) and restart the |bareosFd|. + To use it, copy the :config:option:`Fd/Director`\ resource file to the client machine (on Linux: to :file:`/etc/bareos/bareos-fd.d/director/`) and restart the |fd|. Available since Bareos :sinceVersion:`16.2.4: configure export`. delete - :index:`[TAG=Console->Command->delete] ` The delete command is used to delete a Volume, Pool or Job record from the Catalog as well as all associated catalog Volume records that were created. This command operates only on the Catalog database and has no effect on the actual data written to a Volume. This command can be dangerous and we strongly recommend that you do not use it unless you know what you are doing. + :index:`[TAG=Console->Command->delete] ` The delete command is used to delete a Volume, Pool or Job record from the Catalog as well as all associated catalog Volume records that were created. This command operates only on the Catalog database and has no effect on the actual data written to a Volume. This command can be dangerous and we strongly recommend that you do not use it unless you know what you are doing. If the keyword Volume appears on the command line, the named Volume will be deleted from the catalog, if the keyword Pool appears on the command line, a Pool will be deleted, and if the keyword Job appears on the command line, a Job and all its associated records (File and JobMedia) will be deleted from the catalog. @@ -536,7 +537,7 @@ delete The first form deletes a Pool record from the catalog database. The second form deletes a Volume record from the specified pool in the catalog database. The third form deletes the specified Job record from the catalog database. The last form deletes JobId records for JobIds n, m, o, p, q, r, and t. Where each one of the n,m,... is, of course, a number. That is a "delete jobid" accepts lists and ranges of jobids. disable - :index:`[TAG=Console->Command->disable] ` This command permits you to disable a Job for automatic scheduling. The job may have been previously enabled with the Job resource Enabled directive or using the console enable command. The next time the Director is reloaded or restarted, the Enable/Disable state will be set to the value in the Job resource (default enabled) as defined in the |bareosDir| configuration. + :index:`[TAG=Console->Command->disable] ` This command permits you to disable a Job for automatic scheduling. The job may have been previously enabled with the Job resource Enabled directive or using the console enable command. The next time the Director is reloaded or restarted, the Enable/Disable state will be set to the value in the Job resource (default enabled) as defined in the |dir| configuration. The full form of this command is: @@ -546,7 +547,7 @@ disable disable job= enable - :index:`[TAG=Console->Command->enable] ` This command permits you to enable a Job for automatic scheduling. The job may have been previously disabled with the Job resource Enabled directive or using the console disable command. The next time the Director is reloaded or restarted, the Enable/Disable state will be set to the value in the Job resource (default enabled) as defined in the |bareosDir| configuration. + :index:`[TAG=Console->Command->enable] ` This command permits you to enable a Job for automatic scheduling. The job may have been previously disabled with the Job resource Enabled directive or using the console disable command. The next time the Director is reloaded or restarted, the Enable/Disable state will be set to the value in the Job resource (default enabled) as defined in the |dir| configuration. The full form of this command is: @@ -562,7 +563,7 @@ enable estimate - :index:`[TAG=Console->Command->estimate] ` Using this command, you can get an idea how many files will be backed up, or if you are unsure about your Include statements in your FileSet, you can test them without doing an actual backup. The default is to assume a Full backup. However, you can override this by specifying a level=Incremental or level=Differential on the command line. A Job name must be specified or you will be prompted for one, and optionally a Client and FileSet may + :index:`[TAG=Console->Command->estimate] ` Using this command, you can get an idea how many files will be backed up, or if you are unsure about your Include statements in your FileSet, you can test them without doing an actual backup. The default is to assume a Full backup. However, you can override this by specifying a level=Incremental or level=Differential on the command line. A Job name must be specified or you will be prompted for one, and optionally a Client and FileSet may be specified on the command line. It then contacts the client which computes the number of files and bytes that would be backed up. Please note that this is an estimate calculated from the number of blocks in the file rather than by reading the actual bytes. As such, the estimated backup size will generally be larger than an actual backup. The ``estimate`` command can use the accurate code to detect changes and give a better estimation. You can set the accurate behavior on command line using ``accurate=yes/no`` or use the Job setting as default value. @@ -591,10 +592,10 @@ estimate the sparse option is not specified in the FileSet. There is currently no way to get an estimate of the real file size that would be found should the sparse option be enabled. exit - :index:`[TAG=Console->Command->exit] ` This command terminates the console program. + :index:`[TAG=Console->Command->exit] ` This command terminates the console program. export - :index:`[TAG=Console->Command->export] ` The export command is used to export tapes from an autochanger. Most Automatic Tapechangers offer special slots for importing new tape cartridges or exporting written tape cartridges. This can happen without having to set the device offline. + :index:`[TAG=Console->Command->export] ` The export command is used to export tapes from an autochanger. Most Automatic Tapechangers offer special slots for importing new tape cartridges or exporting written tape cartridges. This can happen without having to set the device offline. The full form of this command is: @@ -643,13 +644,13 @@ export /usr/sbin/bsmtp -h localhost -f root@localhost -s 'Remove Tape %V' root@localhost \"" gui - :index:`[TAG=Console->Command->gui] ` Invoke the non-interactive gui mode. This command is only used when :command:`bconsole` is commanded by an external program. + :index:`[TAG=Console->Command->gui] ` Invoke the non-interactive gui mode. This command is only used when :command:`bconsole` is commanded by an external program. help - :index:`[TAG=Console->Command->help] ` This command displays the list of commands available. + :index:`[TAG=Console->Command->help] ` This command displays the list of commands available. import - :index:`[TAG=Console->Command->import] ` The import command is used to import tapes into an autochanger. Most Automatic Tapechangers offer special slots for importing new tape cartridges or exporting written tape cartridges. This can happen without having to set the device offline. + :index:`[TAG=Console->Command->import] ` The import command is used to import tapes into an autochanger. Most Automatic Tapechangers offer special slots for importing new tape cartridges or exporting written tape cartridges. This can happen without having to set the device offline. The full form of this command is: @@ -701,7 +702,7 @@ import 3308 Successfully transfered volume from slot 37 to 20. label - :index:`[TAG=Console->Command->label] ` :index:`[TAG=Console->Command->relabel] ` This command is used to label physical volumes. The full form of this command is: + :index:`[TAG=Console->Command->label] ` :index:`[TAG=Console->Command->relabel] ` This command is used to label physical volumes. The full form of this command is: .. code-block:: bconsole :caption: label @@ -769,7 +770,7 @@ label label storage=xxx pool=yyy slots=1-5,10 barcodes list - :index:`[TAG=Console->Command->list] ` The list command lists the requested contents of the Catalog. The various fields of each record are listed on a single line. The various forms of the list command are: + :index:`[TAG=Console->Command->list] ` The list command lists the requested contents of the Catalog. The various fields of each record are listed on a single line. The various forms of the list command are: .. code-block:: bconsole :caption: list @@ -825,7 +826,7 @@ list If you want to see what Client resources you have available in your conf file, you use the Console command show clients. llist - :index:`[TAG=Console->Command->llist] ` The llist or "long list" command takes all the same arguments that the list command described above does. The difference is that the llist command list the full contents of each database record selected. It does so by listing the various fields of the record vertically, with one field per line. It is possible to produce a very large number of output lines with this command. + :index:`[TAG=Console->Command->llist] ` The llist or "long list" command takes all the same arguments that the list command described above does. The difference is that the llist command list the full contents of each database record selected. It does so by listing the various fields of the record vertically, with one field per line. It is possible to produce a very large number of output lines with this command. If instead of the list pools as in the example above, you enter llist pools you might get the following output: @@ -866,13 +867,13 @@ llist LabelFormat: File messages - :index:`[TAG=Console->Command->messages] ` This command causes any pending console messages to be immediately displayed. + :index:`[TAG=Console->Command->messages] ` This command causes any pending console messages to be immediately displayed. memory - :index:`[TAG=Console->Command->memory] ` Print current memory usage. + :index:`[TAG=Console->Command->memory] ` Print current memory usage. mount - :index:`[TAG=Console->Command->mount] ` The mount command is used to get Bareos to read a volume on a physical device. It is a way to tell Bareos that you have mounted a tape and that Bareos should examine the tape. This command is normally used only after there was no Volume in a drive and Bareos requests you to mount a new Volume or when you have specifically unmounted a Volume with the :bcommand:`unmount` console command, which causes Bareos to close the drive. If + :index:`[TAG=Console->Command->mount] ` The mount command is used to get Bareos to read a volume on a physical device. It is a way to tell Bareos that you have mounted a tape and that Bareos should examine the tape. This command is normally used only after there was no Volume in a drive and Bareos requests you to mount a new Volume or when you have specifically unmounted a Volume with the :bcommand:`unmount` console command, which causes Bareos to close the drive. If you have an autoloader, the mount command will not cause Bareos to operate the autoloader unless you specify a slot and possibly a drive. The various forms of the mount command are: .. code-block:: bconsole @@ -884,7 +885,7 @@ mount If you have specified :config:option:`sd/device/AutomaticMount = yes`\ , under most circumstances, Bareos will automatically access the Volume unless you have explicitly unmounted it (in the Console program). move - :index:`[TAG=Console->Command->move] ` The move command allows to move volumes between slots in an autochanger without having to leave the bconsole. + :index:`[TAG=Console->Command->move] ` The move command allows to move volumes between slots in an autochanger without having to leave the bconsole. To move a volume from slot 32 to slots 33, use: @@ -902,7 +903,7 @@ move 3308 Successfully transfered volume from slot 32 to 33. prune - :index:`[TAG=Console->Command->prune] ` + :index:`[TAG=Console->Command->prune] ` .. _ManualPruning: @@ -920,7 +921,7 @@ prune For a Volume to be pruned, the volume status must be **Full**, **Used** or **Append** otherwise the pruning will not take place. purge - :index:`[TAG=Console->Command->purge] ` + :index:`[TAG=Console->Command->purge] ` .. _bcommandPurge: @@ -945,10 +946,10 @@ purge *purge volume action=truncate storage=File pool=Full - However, normally you should use the :bcommand:`purge` command only to purge a volume from the catalog and use the :bcommand:`truncate` command to truncate the volume on the |bareosSd|. + However, normally you should use the :bcommand:`purge` command only to purge a volume from the catalog and use the :bcommand:`truncate` command to truncate the volume on the |sd|. resolve - :index:`[TAG=Console->Command->resolve] ` In the configuration files, Addresses can (and normally should) be specified as DNS names. As the different components of Bareos will establish network connections to other Bareos components, it is important that DNS name resolution works on involved components and delivers the same results. The :bcommand:`resolve` command can be used to test DNS resolution of a given hostname on director, storage daemon or client. + :index:`[TAG=Console->Command->resolve] ` In the configuration files, Addresses can (and normally should) be specified as DNS names. As the different components of Bareos will establish network connections to other Bareos components, it is important that DNS name resolution works on involved components and delivers the same results. The :bcommand:`resolve` command can be used to test DNS resolution of a given hostname on director, storage daemon or client. .. code-block:: bconsole :caption: resolve example @@ -963,7 +964,7 @@ resolve bareos-sd resolves www.bareos.com to host[ipv4:84.44.166.242] query - :index:`[TAG=Console->Command->query] ` + :index:`[TAG=Console->Command->query] ` .. _section-bcommandQuery: @@ -973,7 +974,7 @@ quit :index:`[TAG=quit] ` This command terminates the console program. The console program sends the quit request to the Director and waits for acknowledgment. If the Director is busy doing a previous command for you that has not terminated, it may take some time. You may quit immediately by issuing the .quit command (i.e. quit preceded by a period). relabel - :index:`[TAG=Console->Command->relabel] ` This command is used to label physical volumes. + :index:`[TAG=Console->Command->relabel] ` This command is used to label physical volumes. The full form of this command is: @@ -987,7 +988,7 @@ relabel Once the volume is physically relabeled, the old data previously written on the Volume is lost and cannot be recovered. release - :index:`[TAG=Console->Command->release] ` This command is used to cause the Storage daemon to release (and rewind) the current tape in the drive, and to re-read the Volume label the next time the tape is used. + :index:`[TAG=Console->Command->release] ` This command is used to cause the Storage daemon to release (and rewind) the current tape in the drive, and to re-read the Volume label the next time the tape is used. .. code-block:: bconsole :caption: release @@ -998,14 +999,14 @@ release must use the :bcommand:`unmount` command to cause Bareos to completely release (close) the device. reload - :index:`[TAG=Console->Command->reload] ` The reload command causes the Director to re-read its configuration file and apply the new values. The new values will take effect immediately for all new jobs. However, if you change schedules, be aware that the scheduler pre-schedules jobs up to two hours in advance, so any changes that are to take place during the next two hours may be delayed. Jobs that have already been scheduled to run (i.e. surpassed their requested start time) will + :index:`[TAG=Console->Command->reload] ` The reload command causes the Director to re-read its configuration file and apply the new values. The new values will take effect immediately for all new jobs. However, if you change schedules, be aware that the scheduler pre-schedules jobs up to two hours in advance, so any changes that are to take place during the next two hours may be delayed. Jobs that have already been scheduled to run (i.e. surpassed their requested start time) will continue with the old values. New jobs will use the new values. Each time you issue a reload command while jobs are running, the prior config values will queued until all jobs that were running before issuing the reload terminate, at which time the old config values will be released from memory. The Directory permits keeping up to ten prior set of configurations before it will refuse a reload command. Once at least one old set of config values has been released it will again accept new reload commands. While it is possible to reload the Director’s configuration on the fly, even while jobs are executing, this is a complex operation and not without side effects. Accordingly, if you have to reload the Director’s configuration while Bareos is running, it is advisable to restart the Director at the next convenient opportunity. rerun - :index:`[TAG=Console->Command->rerun] ` The rerun command allows you to re-run a Job with exactly the same setting as the original Job. In Bareos, the job configuration is often altered by job overrides. These overrides alter the configuration of the job just for one job run. If because of any reason, a job with overrides fails, it is not easy to restart a new job that is exactly configured as the job that failed. The whole job configuration is automatically set to the defaults + :index:`[TAG=Console->Command->rerun] ` The rerun command allows you to re-run a Job with exactly the same setting as the original Job. In Bareos, the job configuration is often altered by job overrides. These overrides alter the configuration of the job just for one job run. If because of any reason, a job with overrides fails, it is not easy to restart a new job that is exactly configured as the job that failed. The whole job configuration is automatically set to the defaults and it is hard to configure everything like it was. By using the rerun command, it is much easier to rerun a job exactly as it was configured. You only have to specify the JobId of the failed job. @@ -1018,7 +1019,7 @@ rerun You can select the jobid(s) to rerun by using one of the selection criteria. Using jobid= will automatically select all jobs failed after and including the given jobid for rerunning. By using days= or hours=, you can select all failed jobids in the last number of days or number of hours respectively for rerunning. restore - :index:`[TAG=Restore] ` :index:`[TAG=Console->Command->restore] ` :index:`[TAG=Console->File Selection] ` + :index:`[TAG=Restore] ` :index:`[TAG=Console->Command->restore] ` :index:`[TAG=Console->File Selection] ` .. _bcommandRestore: @@ -1043,7 +1044,7 @@ restore For more details, see the :ref:`Restore chapter `. run - :index:`[TAG=Console->Command->run] ` This command allows you to schedule jobs to be run immediately. + :index:`[TAG=Console->Command->run] ` This command allows you to schedule jobs to be run immediately. The full form of the command is: @@ -1067,7 +1068,7 @@ run The spooldata argument of the run command cannot be modified through the menu and is only accessible by setting its value on the intial command line. If no spooldata flag is set, the job, storage or schedule flag is used. setbandwidth - :index:`[TAG=Console->Command->setbandwidth] ` This command (:sinceVersion:`12.4.1: setbandwidth`) is used to limit the bandwidth of a running job or a client. + :index:`[TAG=Console->Command->setbandwidth] ` This command (:sinceVersion:`12.4.1: setbandwidth`) is used to limit the bandwidth of a running job or a client. .. code-block:: bconsole :caption: setbandwidth @@ -1079,7 +1080,7 @@ setdebug .. _bcommandSetdebug: - :index:`[TAG=Console->Command->setdebug] ` :index:`[TAG=Debug->setdebug] ` :index:`[TAG=Debug->Windows] ` :index:`[TAG=Windows->Debug] ` This command is used to set the debug level in each daemon. The form of this command is: + :index:`[TAG=Console->Command->setdebug] ` :index:`[TAG=Debug->setdebug] ` :index:`[TAG=Debug->Windows] ` :index:`[TAG=Windows->Debug] ` This command is used to set the debug level in each daemon. The form of this command is: .. code-block:: bconsole :caption: setdebug @@ -1105,16 +1106,16 @@ setip .. _bcommandSetIP: - :index:`[TAG=Console->Command->setip] ` Sets new client address – if authorized. + :index:`[TAG=Console->Command->setip] ` Sets new client address – if authorized. A console is authorized to use the SetIP command only if it has a Console resource definition in both the Director and the Console. In addition, if the console name, provided on the Name = directive, must be the same as a Client name, the user of that console is permitted to use the SetIP command to change the Address directive in the Director’s client resource to the IP address of the Console. This permits portables or other machines using DHCP (non-fixed IP addresses) to "notify" the Director of their current IP address. show - :index:`[TAG=Console->Command->show] ` The show command will list the Director’s resource records as defined in the Director’s configuration. This command is used mainly for debugging purposes by developers. The following keywords are accepted on the show command line: catalogs, clients, counters, devices, directors, filesets, jobs, messages, pools, schedules, storages, all, help. Please don’t confuse this command with the list, which displays the contents of the catalog. + :index:`[TAG=Console->Command->show] ` The show command will list the Director’s resource records as defined in the Director’s configuration. This command is used mainly for debugging purposes by developers. The following keywords are accepted on the show command line: catalogs, clients, counters, devices, directors, filesets, jobs, messages, pools, schedules, storages, all, help. Please don’t confuse this command with the list, which displays the contents of the catalog. sqlquery - :index:`[TAG=Console->Command->sqlquery] ` The sqlquery command puts the Console program into SQL query mode where each line you enter is concatenated to the previous line until a semicolon (;) is seen. The semicolon terminates the command, which is then passed directly to the SQL database engine. When the output from the SQL engine is displayed, the formation of a new SQL command begins. To terminate SQL query mode and return to the Console command prompt, you enter a period (.) + :index:`[TAG=Console->Command->sqlquery] ` The sqlquery command puts the Console program into SQL query mode where each line you enter is concatenated to the previous line until a semicolon (;) is seen. The semicolon terminates the command, which is then passed directly to the SQL database engine. When the output from the SQL engine is displayed, the formation of a new SQL command begins. To terminate SQL query mode and return to the Console command prompt, you enter a period (.) in column 1. Using this command, you can query the SQL catalog database directly. Note you should really know what you are doing otherwise you could damage the catalog database. See the query command below for simpler and safer way of entering SQL queries. @@ -1122,7 +1123,7 @@ sqlquery Depending on what database engine you are using (MySQL, PostgreSQL or SQLite), you will have somewhat different SQL commands available. For more detailed information, please refer to the MySQL, PostgreSQL or SQLite documentation. status - :index:`[TAG=Console->Command->status] ` + :index:`[TAG=Console->Command->status] ` This command will display the status of all components. For the director, it will display the next jobs that are scheduled during the next 24 hours as well as the status of currently running jobs. For the Storage Daemon, you will have drive status or autochanger content. The File Daemon will give you information about current jobs like average speed or file accounting. The full form of this command is: @@ -1314,13 +1315,13 @@ status Not configuring the directive at all also disables it, as the default value for the Subscriptions directive is zero. time - :index:`[TAG=Console->Command->time] ` The time command shows the current date, time and weekday. + :index:`[TAG=Console->Command->time] ` The time command shows the current date, time and weekday. trace - :index:`[TAG=Console->Command->trace] ` Turn on/off trace to file. + :index:`[TAG=Console->Command->trace] ` Turn on/off trace to file. truncate - :index:`[TAG=Console->Command->truncate] ` :index:`[TAG=Disk->Freeing disk space] ` :index:`[TAG=Disk->Freeing disk space] ` + :index:`[TAG=Console->Command->truncate] ` :index:`[TAG=Disk->Freeing disk space] ` :index:`[TAG=Disk->Freeing disk space] ` .. _bcommandTruncate: @@ -1333,17 +1334,17 @@ truncate truncate volstatus=Purged [storage=] [pool=] [volume=] [yes] - When using a disk volume (and other volume types also) the volume file still resides on the |bareosSd|. If you want to reclaim disk space, you can use the :bcommand:`truncate volstatus=Purged` command. When used on a volume, it rewrites the header and by this frees the rest of the disk space. + When using a disk volume (and other volume types also) the volume file still resides on the |sd|. If you want to reclaim disk space, you can use the :bcommand:`truncate volstatus=Purged` command. When used on a volume, it rewrites the header and by this frees the rest of the disk space. If the volume you want to get rid of has not the **Purged** status, you first have to use the :bcommand:`prune volume` or even the :bcommand:`purge volume` command to free the volume from all remaining jobs. This command is available since Bareos :sinceVersion:`16.2.5: truncate command`. umount - :index:`[TAG=Console->Command->umount] ` Alias for :bcommand:`unmount`. + :index:`[TAG=Console->Command->umount] ` Alias for :bcommand:`unmount`. unmount - :index:`[TAG=Console->Command->unmount] ` This command causes the indicated Bareos Storage daemon to unmount the specified device. The forms of the command are the same as the mount command: + :index:`[TAG=Console->Command->unmount] ` This command causes the indicated Bareos Storage daemon to unmount the specified device. The forms of the command are the same as the mount command: .. code-block:: bconsole :caption: unmount @@ -1358,7 +1359,7 @@ unmount In most cases, it is preferable to use the :bcommand:`release` instead. update - :index:`[TAG=Console->Command->update] ` + :index:`[TAG=Console->Command->update] ` .. _UpdateCommand: @@ -1402,7 +1403,7 @@ update For slots :bcommand:`update slots`, Bareos will obtain a list of slots and their barcodes from the Storage daemon, and for each barcode found, it will automatically update the slot in the catalog Media record to correspond to the new value. This is very useful if you have moved cassettes in the magazine, or if you have removed the magazine and inserted a different one. As the slot of each Volume is updated, the InChanger flag for that Volume will also be set, and any other Volumes in the Pool that were last mounted on the same Storage device will have their InChanger flag turned off. This permits Bareos to know what magazine (tape holder) is currently in the autochanger. - If you do not have barcodes, you can accomplish the same thing by using the :bcommand:`update slots scan` command. The ``scan`` keyword tells Bareos to physically mount each tape and to read its VolumeName. + If you do not have barcodes, you can accomplish the same thing by using the :bcommand:`update slots scan` command. The :strong:`scan` keyword tells Bareos to physically mount each tape and to read its VolumeName. For Pool :bcommand:`update pool`, Bareos will move the Volume record from its existing pool to the pool specified. @@ -1428,7 +1429,7 @@ update stats [days=] use - :index:`[TAG=Console->Command->use] ` This command allows you to specify which Catalog database to use. Normally, you will be using only one database so this will be done automatically. In the case that you are using more than one database, you can use this command to switch from one to another. + :index:`[TAG=Console->Command->use] ` This command allows you to specify which Catalog database to use. Normally, you will be using only one database so this will be done automatically. In the case that you are using more than one database, you can use this command to switch from one to another. .. code-block:: bconsole :caption: use @@ -1440,14 +1441,14 @@ var .. _var: - :index:`[TAG=Console->Command->var] ` This command takes a string or quoted string and does variable expansion on it mostly the same way variable expansion is done on the :config:option:`dir/pool/LabelFormat`\ string. The difference between the :bcommand:`var` command and the actual :config:option:`dir/pool/LabelFormat`\ process is that during the var command, no job is running so dummy values are + :index:`[TAG=Console->Command->var] ` This command takes a string or quoted string and does variable expansion on it mostly the same way variable expansion is done on the :config:option:`dir/pool/LabelFormat`\ string. The difference between the :bcommand:`var` command and the actual :config:option:`dir/pool/LabelFormat`\ process is that during the var command, no job is running so dummy values are used in place of Job specific variables. version - :index:`[TAG=Console->Command->version] ` The command prints the Director’s version. + :index:`[TAG=Console->Command->version] ` The command prints the Director’s version. wait - :index:`[TAG=Console->Command->wait] ` The wait command causes the Director to pause until there are no jobs running. This command is useful in a batch situation such as regression testing where you wish to start a job and wait until that job completes before continuing. This command now has the following options: + :index:`[TAG=Console->Command->wait] ` The wait command causes the Director to pause until there are no jobs running. This command is useful in a batch situation such as regression testing where you wish to start a job and wait until that job completes before continuing. This command now has the following options: .. code-block:: bconsole :caption: wait @@ -1461,9 +1462,9 @@ wait Special dot (.) Commands ~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Console->Command->. commands] ` +:index:`[TAG=Console->Command->. commands] ` -There is a list of commands that are prefixed with a period (.). These commands are intended to be used either by batch programs or graphical user interface front-ends. They are not normally used by interactive users. For details, see \bareosDeveloperGuideDotCommands. +There is a list of commands that are prefixed with a period (.). These commands are intended to be used either by batch programs or graphical user interface front-ends. They are not normally used by interactive users. For details, see `Bareos Developer Guide (dot-commands) `_. .. _atcommands: @@ -1473,10 +1474,10 @@ Special At (@) Commands Normally, all commands entered to the Console program are immediately forwarded to the Director, which may be on another machine, to be executed. However, there is a small list of at commands, all beginning with an at character (@), that will not be sent to the Director, but rather interpreted by the Console program directly. Note, these commands are implemented only in the TTY console program and not in the Bat Console. These commands are: @input - :index:`[TAG=Console->Command->@input ] >` Read and execute the commands contained in the file specified. + :index:`[TAG=Console->Command->@input ] >` Read and execute the commands contained in the file specified. @output - :index:`[TAG=Console->Command->@output ] >` Send all following output to the filename specified either overwriting the file (w) or appending to the file (a). To redirect the output to the terminal, simply enter @output without a filename specification. WARNING: be careful not to overwrite a valid file. A typical example during a regression test might be: + :index:`[TAG=Console->Command->@output ] >` Send all following output to the filename specified either overwriting the file (w) or appending to the file (a). To redirect the output to the terminal, simply enter @output without a filename specification. WARNING: be careful not to overwrite a valid file. A typical example during a regression test might be: @@ -1489,31 +1490,31 @@ Normally, all commands entered to the Console program are immediately forwarded @tee - :index:`[TAG=Console->Command->@tee ] >` Send all subsequent output to both the specified file and the terminal. It is turned off by specifying @tee or @output without a filename. + :index:`[TAG=Console->Command->@tee ] >` Send all subsequent output to both the specified file and the terminal. It is turned off by specifying @tee or @output without a filename. @sleep - :index:`[TAG=Console->Command->@sleep ] >` Sleep the specified number of seconds. + :index:`[TAG=Console->Command->@sleep ] >` Sleep the specified number of seconds. @time - :index:`[TAG=Console->Command->@time] ` Print the current time and date. + :index:`[TAG=Console->Command->@time] ` Print the current time and date. @version - :index:`[TAG=Console->Command->@version] ` Print the console’s version. + :index:`[TAG=Console->Command->@version] ` Print the console’s version. @quit - :index:`[TAG=Console->Command->@quit] ` quit + :index:`[TAG=Console->Command->@quit] ` quit @exit - :index:`[TAG=Console->Command->@exit] ` quit + :index:`[TAG=Console->Command->@exit] ` quit @# anything - :index:`[TAG=Console->Command->@# anything] ` Comment + :index:`[TAG=Console->Command->@# anything] ` Comment @help - :index:`[TAG=Console->Command->@help] ` Get the list of every special @ commands. + :index:`[TAG=Console->Command->@help] ` Get the list of every special @ commands. @separator - :index:`[TAG=Console->Command->@separator] ` When using bconsole with readline, you can set the command separator to one of those characters to write commands who require multiple input on one line, or to put multiple commands on a single line. + :index:`[TAG=Console->Command->@separator] ` When using bconsole with readline, you can set the command separator to one of those characters to write commands who require multiple input on one line, or to put multiple commands on a single line. :: @@ -1524,7 +1525,7 @@ Normally, all commands entered to the Console program are immediately forwarded Adding Volumes to a Pool ------------------------ -:index:`[TAG=Console->Adding a Volume to a Pool] ` +:index:`[TAG=Console->Adding a Volume to a Pool] ` .. TODO: move to another chapter diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/BareosSecurityIssues.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/BareosSecurityIssues.rst index ba20024c3fb..74c37e12c8c 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/BareosSecurityIssues.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/BareosSecurityIssues.rst @@ -32,7 +32,7 @@ Bareos Security Issues Configuring and Testing TCP Wrappers ------------------------------------ -:index:`[TAG=TCP Wrappers] ` :index:`[TAG=Wrappers->TCP] ` :index:`[TAG=libwrappers] ` +:index:`[TAG=TCP Wrappers] ` :index:`[TAG=Wrappers->TCP] ` :index:`[TAG=libwrappers] ` The TCP wrapper functionality is available on different platforms. Be default, it is activated on Bareos for Linux. With this enabled, you may control who may access your daemons. This control is done by modifying the file: /etc/hosts.allow. The program name that Bareos uses when applying these access restrictions is the name you specify in the daemon configuration file (see below for examples). You must not use the twist option in your /etc/hosts.allow or it will terminate the Bareos daemon when a connection is refused. @@ -55,7 +55,7 @@ Bareos supports the secure erase of files that usually are simply deleted. Bareo This makes it easy to choose a tool that meets the secure erase requirements. -To configure this functionality, a new configuration directive with the name :strong:`Secure Erase Command` has been introduced. +To configure this functionality, a new configuration directive with the name :strong:`Secure Erase Command`\ has been introduced. This directive is optional and can be configured in: @@ -101,10 +101,10 @@ Example: Example for Secure Erase Command Settings: Linux: - :strong:`Secure Erase Command = "/usr/bin/wipe -V"` + :strong:`Secure Erase Command = "/usr/bin/wipe -V"`\ Windows: - :strong:`Secure Erase Command = "C:/cygwin64/bin/shred.exe"` + :strong:`Secure Erase Command = "C:/cygwin64/bin/shred.exe"`\ Our tests with the :command:`sdelete` command was not successful, as :command:`sdelete` seems to stay active in the background. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/CatalogMaintenance.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/CatalogMaintenance.rst index 6197aef31ac..cf5a807ed0b 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/CatalogMaintenance.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/CatalogMaintenance.rst @@ -3,7 +3,7 @@ Catalog Maintenance =================== -:index:`[TAG=Maintenance->Catalog] ` :index:`[TAG=Catalog Maintenance] ` +:index:`[TAG=Maintenance->Catalog] ` :index:`[TAG=Catalog Maintenance] ` Catalog Database ---------------- @@ -16,14 +16,14 @@ Bareos stores its catalog in a database. Different database backends are offered - Sqlite (only for testing) -What database will be used, can be configured in the |bareosDir| configuration, see the :ref:`DirectorResourceCatalog`. +What database will be used, can be configured in the |dir| configuration, see the :ref:`DirectorResourceCatalog`. -The database often runs on the same server as the |bareosDir|. However, it is also possible to run it on a different system. This might require some more manual configuration, a PostgreSQL example can be found in :ref:`catalog-maintenance-remote-psql`. +The database often runs on the same server as the |dir|. However, it is also possible to run it on a different system. This might require some more manual configuration, a PostgreSQL example can be found in :ref:`catalog-maintenance-remote-psql`. dbconfig-common (Debian) ~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Platform->Debian->dbconfig-common] ` :index:`[TAG=Platform->Ubuntu->dbconfig-common] ` +:index:`[TAG=Platform->Debian->dbconfig-common] ` :index:`[TAG=Platform->Ubuntu->dbconfig-common] ` .. _section-dbconfig: @@ -52,10 +52,11 @@ The Bareos database backend will get automatically configured in :file:`/etc/bar -.. warning:: - When using the PostgreSQL backend and updating to Bareos < 14.2.3, it is necessary to manually grant database permissions (:command:`grant_bareos_privileges`), normally by + .. warning:: -.. code-block:: sh + When using the PostgreSQL backend and updating to Bareos < 14.2.3, it is necessary to manually grant database permissions (:command:`grant_bareos_privileges`), normally by + +.. code-block:: shell-session su - postgres -c /usr/lib/bareos/scripts/grant_bareos_privileges @@ -110,73 +111,45 @@ Bareos comes with a number of scripts to prepare and update the databases. All t The database preparation scripts have following configuration options: -:: +db_type + - command line parameter $1 + + - :config:option:`dir/catalog/DbDriver`\ from the configuration + + - installed database backends + + - fallback: postgresql + +db_name + - environment variable ``db_name``\ + + - :config:option:`dir/catalog/DbName`\ from the configuration + + - default: bareos + +db_user + - environment variable ``db_user``\ + + - :config:option:`dir/catalog/DbUser`\ from the configuration + + - default: bareos + +db_password + - environment variable ``db_password``\ + + - :config:option:`dir/catalog/DbPassword`\ from the configuration + + - default: *none* + +Reading the settings from the configuration require read permission for the current user. The normal PostgreSQL administrator user (**postgres**) don’t have these permissions. So if you plan to use non-default database settings, you might add the user **postgres** to the group :strong:`bareos`. + +The database preparation scripts need to have password-less administrator access to the database. Depending on the distribution you’re using, this require additional configuration. See the following section about howto achieve this for the different database systems. + +To view and test the currently configured settings, use following commands: + +.. code-block:: shell-session + :caption: Show current database configuration - \begin{tabular}{| l | l | l |} - % \hline - % :strong:`Parameter` & :strong:`Values` & :strong:`Default` \\ - % \hline - % \hline - % ``db_type`` & parameter, dbdriver from \configFileDirUnix, installed database backends & \\ - % ``db_name`` & environment variable \variable{db_name}, dbdriver from :file:`/etc/bareos/bareos-dir.conf` & bareos \\ - % ``db_user`` & environment variable \variable{db_user} & bareos \\ - % ``db_password`` & environment variable \variable{db_password} & \textit{none} \\ - % \hline - % \end{tabular}\end{verbatim} - - # Tabular converted from LaTeX to RST (or empty, in case of problems): - \begin{tabular}{| l | l | l |} - % \hline - % :strong:`Parameter` & :strong:`Values` & :strong:`Default` \\ - % \hline - % \hline - % ``db_type`` & parameter, dbdriver from \configFileDirUnix, installed database backends & \\ - % ``db_name`` & environment variable \variable{db_name}, dbdriver from :file:`/etc/bareos/bareos-dir.conf` & bareos \\ - % ``db_user`` & environment variable \variable{db_user} & bareos \\ - % ``db_password`` & environment variable \variable{db_password} & \textit{none} \\ - % \hline - % \end{tabular} - % \end{center} - - \begin{description} - \item[db\_type] - \begin{itemize} - \item command line parameter \$1 - \item :config:option:`dir/catalog/DbDriver`\ from the configuration - \item installed database backends - \item fallback: postgresql - \end{itemize} - \item[db\_name] - \begin{itemize} - \item environment variable \variable{db_name} - \item :config:option:`dir/catalog/DbName`\ from the configuration - \item default: bareos - \end{itemize} - \item[db\_user] - \begin{itemize} - \item environment variable \variable{db_user} - \item :config:option:`dir/catalog/DbUser`\ from the configuration - \item default: bareos - \end{itemize} - \item[db\_password] - \begin{itemize} - \item environment variable \variable{db_password} - \item :config:option:`dir/catalog/DbPassword`\ from the configuration - \item default: \textit{none} - \end{itemize} - \end{description} - - Reading the settings from the configuration require read permission for the current user. - The normal PostgreSQL administrator user (**postgres**) don't have these permissions. - So if you plan to use non-default database settings, you might add the user **postgres** to the group \group{bareos}. - - The database preparation scripts need to have password-less administrator access to the database. - Depending on the distribution you're using, this require additional configuration. - See the following section about howto achieve this for the different database systems. - - - To view and test the currently configured settings, use following commands: - \begin{verbatim}\begin{commands}{Show current database configuration} /usr/sbin/bareos-dbcheck -B catalog=MyCatalog db_name=bareos @@ -188,9 +161,8 @@ The database preparation scripts have following configuration options: db_socket= db_type=MySQL working_dir=/var/lib/bareos - \end{commands} -.. code-block:: sh +.. code-block:: shell-session :caption: Test the database connection. Example: wrong password /usr/sbin/bareos-dir -t -f -d 500 @@ -211,13 +183,13 @@ On most distributions, PostgreSQL uses ident to allow access to the database sys If this works on your system can be verified by -.. code-block:: sh +.. code-block:: shell-session :caption: Access the local PostgreSQL database su - postgres psql -If your database is configured to require a password, this must be definied in the file `:file:`~/.pgpass` `_ in the following syntax: ``HOST:PORT:DATABASE:USER:PASSWORD``, e.g. +If your database is configured to require a password, this must be definied in the file `:file:`~/.pgpass` `_ in the following syntax: :strong:`HOST:PORT:DATABASE:USER:PASSWORD`, e.g. .. code-block:: cfg :caption: PostgreSQL access credentials @@ -228,7 +200,7 @@ The permission of this file must be 0600 (:command:`chmod 0600 ~/.pgpass`). Again, verify that you have specified the correct settings by calling the :command:`psql` command. If this connects you to the database, your credentials are good. Exit the PostgreSQL client and run the Bareos database preparation scripts: -.. code-block:: sh +.. code-block:: shell-session :caption: Setup Bareos catalog database su - postgres @@ -236,9 +208,9 @@ Again, verify that you have specified the correct settings by calling the :comma /usr/lib/bareos/scripts/make_bareos_tables /usr/lib/bareos/scripts/grant_bareos_privileges -The encoding of the bareos database must be ``SQL_ASCII``. The command :command:`create_bareos_database` automatically creates the database with this encoding. This can be verified by the command :command:`psql -l`, which shows information about existing databases: +The encoding of the bareos database must be :strong:`SQL_ASCII`. The command :command:`create_bareos_database` automatically creates the database with this encoding. This can be verified by the command :command:`psql -l`, which shows information about existing databases: -.. code-block:: sh +.. code-block:: shell-session :caption: List existing databases psql -l @@ -255,7 +227,7 @@ The owner of the database may vary. The Bareos database maintance scripts don’ By default, using PostgreSQL ident, a Unix user can access a database of the same name. Therefore the user **bareos** can access the database :file:`bareos`. -.. code-block:: sh +.. code-block:: shell-session :caption: Verify Bareos database on PostgreSQL as Unix user bareos (bareos-13.2.3) root@linux:~# su - bareos -s /bin/sh @@ -333,9 +305,9 @@ By default, using PostgreSQL ident, a Unix user can access a database of the sam Remote PostgreSQL Database ^^^^^^^^^^^^^^^^^^^^^^^^^^ -When configuring bareos with a remote database, your first step is to check the connection from the |bareosDir| host into the database. A functional connection can be verified by +When configuring bareos with a remote database, your first step is to check the connection from the |dir| host into the database. A functional connection can be verified by -.. code-block:: sh +.. code-block:: shell-session :caption: Access the remote PostgreSQL database su - postgres @@ -343,14 +315,14 @@ When configuring bareos with a remote database, your first step is to check the With a correct configuration you can access the database, if it fails you need to correct the PostgreSQL servers configuration files. -One way to manually create the database would be calling the bareos database preparation scripts with the ``--host`` option, explained later. How ever, it is advised to use the **dbconfig-common**. Both methods require you to add the database hostname/address as :config:option:`dir/catalog/DbAddress`\ . +One way to manually create the database would be calling the bareos database preparation scripts with the :strong:`--host` option, explained later. How ever, it is advised to use the **dbconfig-common**. Both methods require you to add the database hostname/address as :config:option:`dir/catalog/DbAddress`\ . -If you’re using **dbconfig-common** you should choose ``New Host``, enter the hostname or the local address followed by the password. As **dbconfig-common** uses the ``ident`` authentication by default the first try to connect will fail. Don’t be bothered by that. Choose ``Retry`` when prompted. From there, read carefully and configure the database to your needs. The authentication should be set +If you’re using **dbconfig-common** you should choose :strong:`New Host`, enter the hostname or the local address followed by the password. As **dbconfig-common** uses the :strong:`ident` authentication by default the first try to connect will fail. Don’t be bothered by that. Choose :strong:`Retry` when prompted. From there, read carefully and configure the database to your needs. The authentication should be set to password, as the ident method will not work with a remote server. Set the user and administrator according to your PostgreSQL servers settings. Set the PostgreSQL server IP as :config:option:`dir/catalog/DbAddress`\ in :ref:`DirectorResourceCatalog`. You can also customize other parameters or use the defaults. A quick check should display your recent changes: -.. code-block:: sh +.. code-block:: shell-session :caption: Show current database configuration /usr/sbin/bareos-dbcheck -B @@ -367,7 +339,7 @@ Set the PostgreSQL server IP as :config:option:`dir/catalog/DbAddress`\ in :ref If **dbconfig-common** did not succeed or you choosed not to use it, run the Bareos database preparation scripts with: -.. code-block:: sh +.. code-block:: shell-session :caption: Setup Bareos catalog database su - postgres @@ -416,9 +388,9 @@ For the Bareos database connection, you should specify a database password. Othe } ... -After this, run the Bareos database preparation scripts. For Bareos <= 13.2.2, the database password must be specified as environment variable \variable{db_password}. From :sinceVersion:`13.2.3: MySQL password from configuration file` the database password is read from the configuration, if no environment variable is given. +After this, run the Bareos database preparation scripts. For Bareos <= 13.2.2, the database password must be specified as environment variable ``db_password``\ . From :sinceVersion:`13.2.3: MySQL password from configuration file` the database password is read from the configuration, if no environment variable is given. -.. code-block:: sh +.. code-block:: shell-session :caption: Setup Bareos catalog database export db_password=YourSecretPassword @@ -428,7 +400,7 @@ After this, run the Bareos database preparation scripts. For Bareos <= 13.2.2, t After this, you can use the :command:`mysql` command to verify that your database setup is okay and works with your the Bareos database user. The result should look similar as this (here Bareos 13.2 is used on SLES11): -.. code-block:: sh +.. code-block:: shell-session :caption: Verify Bareos database on MySQL root@linux:~# mysql --user=bareos --password=YourSecretPassword bareos @@ -554,7 +526,7 @@ Modify the configuration, set a new password: Rerun the Bareos grant script :command:`grant_bareos_privileges` ... -.. code-block:: sh +.. code-block:: shell-session :caption: Modify database privileges export db_password=MyNewSecretPassword @@ -575,7 +547,7 @@ Sqlite does not offer access permissions. The only permissions that do apply are The database is accessable by following command: -.. code-block:: sh +.. code-block:: shell-session :caption: Verify Bareos database on Sqlite3 (bareos-13.2.3) sqlite3 /var/lib/bareos/bareos.db @@ -601,7 +573,7 @@ Retention Periods Database Size ~~~~~~~~~~~~~ -:index:`[TAG=Size->Database] ` :index:`[TAG=Database Size] ` +:index:`[TAG=Size->Database] ` :index:`[TAG=Database Size] ` As mentioned above, if you do not do automatic pruning, your Catalog will grow each time you run a Job. Normally, you should decide how long you want File records to be maintained in the Catalog and set the File Retention period to that time. Then you can either wait and see how big your Catalog gets or make a calculation assuming approximately 154 bytes for each File saved and knowing the number of Files that are saved during each backup and the number of Clients you backup. @@ -637,14 +609,14 @@ database size will remain constant. Setting Retention Periods ~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Setting Retention Periods] ` :index:`[TAG=Periods->Setting Retention] ` +:index:`[TAG=Setting Retention Periods] ` :index:`[TAG=Periods->Setting Retention] ` Bareos uses three Retention periods: the File Retention period, the Job Retention period, and the Volume Retention period. Of these three, the File Retention period is by far the most important in determining how large your database will become. The File Retention and the Job Retention are specified in each Client resource as is shown below. The Volume Retention period is specified in the Pool resource, and the details are given in the next chapter of this manual. File Retention = - :index:`[TAG=File Retention] ` :index:`[TAG=Retention->File] ` The File Retention record defines the length of time that Bareos will keep File records in the Catalog database. When this time period expires, and if AutoPrune is set to yes, Bareos will prune (remove) File records that are older than the specified File Retention period. The pruning will occur at the end of a backup Job for the given Client. Note that the Client database record contains a copy of the + :index:`[TAG=File Retention] ` :index:`[TAG=Retention->File] ` The File Retention record defines the length of time that Bareos will keep File records in the Catalog database. When this time period expires, and if AutoPrune is set to yes, Bareos will prune (remove) File records that are older than the specified File Retention period. The pruning will occur at the end of a backup Job for the given Client. Note that the Client database record contains a copy of the File and Job retention periods, but Bareos uses the current values found in the Director’s Client resource to do the pruning. Since File records in the database account for probably 80 percent of the size of the database, you should carefully determine exactly what File Retention period you need. Once the File records have been removed from the database, you will no longer be able to restore individual files in a Job. However, as long as the Job record still exists, you will be able to restore all files in the job. @@ -654,7 +626,7 @@ File Retention = The default File retention period is 60 days. Job Retention = - :index:`[TAG=Job->Retention] ` :index:`[TAG=Retention->Job] ` The Job Retention record defines the length of time that Bareos will keep Job records in the Catalog database. When this time period expires, and if AutoPrune is set to yes Bareos will prune (remove) Job records that are older than the specified Job Retention period. Note, if a Job record is selected for pruning, all associated File and JobMedia records will also be pruned regardless of the File Retention + :index:`[TAG=Job->Retention] ` :index:`[TAG=Retention->Job] ` The Job Retention record defines the length of time that Bareos will keep Job records in the Catalog database. When this time period expires, and if AutoPrune is set to yes Bareos will prune (remove) Job records that are older than the specified Job Retention period. Note, if a Job record is selected for pruning, all associated File and JobMedia records will also be pruned regardless of the File Retention period set. As a consequence, you normally will set the File retention period to be less than the Job retention period. As mentioned above, once the File records are removed from the database, you will no longer be able to restore individual files from the Job. However, as long as the Job record remains in the database, you will be able to restore all the files backuped for the Job. As a consequence, it is generally a good idea to retain the Job records much longer than the File records. @@ -664,14 +636,14 @@ Job Retention = The default Job Retention period is 180 days. :config:option:`dir/client/AutoPrune`\ - :index:`[TAG=AutoPrune] ` :index:`[TAG=Job->Retention->AutoPrune] ` If set to yes, Bareos will automatically apply the File retention period and the Job retention period for the Client at the end of the Job. If you turn this off by setting it to no, your Catalog will grow each time you run a Job. + :index:`[TAG=AutoPrune] ` :index:`[TAG=Job->Retention->AutoPrune] ` If set to yes, Bareos will automatically apply the File retention period and the Job retention period for the Client at the end of the Job. If you turn this off by setting it to no, your Catalog will grow each time you run a Job. .. _section-JobStatistics: Job Statistics ^^^^^^^^^^^^^^ -:index:`[TAG=Statistics] ` :index:`[TAG=Job->Statistics] ` +:index:`[TAG=Statistics] ` :index:`[TAG=Job->Statistics] ` Bareos catalog contains lot of information about your IT infrastructure, how many files, their size, the number of video or music files etc. Using Bareos catalog during the day to get them permit to save resources on your servers. @@ -690,7 +662,7 @@ If you want to have statistics on your backups to provide some Service Level Agr However, these statistics are accurate only if your job retention is greater than your statistics period. Ie, if jobs are purged from the catalog, you won’t be able to use them. Now, you can use the :bcommand:`update stats [days=num]` console command to fill the JobHistory table with new Job records. If you want to be sure to take in account only good jobs, ie if one of your important job has failed but you have fixed the problem and restarted it on time, you probably want to delete the first bad job record and keep only the successful one. For that simply let your staff do the job, and update JobHistory table after two or three days depending on your -organization using the ``[days=num]`` option. +organization using the :strong:`[days=num]` option. These statistics records aren’t used for restoring, but mainly for capacity planning, billings, etc. @@ -717,12 +689,12 @@ You can use the following Job resource in your nightly :config:option:`dir/job = PostgreSQL ---------- -:index:`[TAG=Database->PostgreSQL] ` :index:`[TAG=PostgreSQL] ` +:index:`[TAG=Database->PostgreSQL] ` :index:`[TAG=PostgreSQL] ` Compacting Your PostgreSQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Database->PostgreSQL->Compacting] ` +:index:`[TAG=Database->PostgreSQL->Compacting] ` .. _CompactingPostgres: @@ -739,7 +711,7 @@ All database programs have some means of writing the database out in ASCII forma For a PostgreSQL database, you could write the Bareos database as an ASCII file (:file:`bareos.sql`) then reload it by doing the following: -.. code-block:: sh +.. code-block:: shell-session pg_dump -c bareos > bareos.sql cat bareos.sql | psql bareos @@ -760,7 +732,7 @@ Especially when a high number of files are beeing backed up or when working with The reason for autovacuuming not beeing triggered is then probably the default setting of ``autovacuum_vacuum_scale_factor = 0.2``, the current value can be shown with the following query or looked up in ``postgresql.conf``: -.. code-block:: sh +.. code-block:: shell-session :caption: SQL statement to show the autovacuum\_vacuum\_scale\_factor parameter bareos=# show autovacuum_vacuum_scale_factor; @@ -777,7 +749,7 @@ The following example shows how to configure running VACUUM on the file table by First step is to check the amount of dead tuples and if autovacuum triggers VACUUM: -.. code-block:: sh +.. code-block:: shell-session :caption: Check dead tuples and vacuuming on PostgreSQL bareos=# SELECT relname, n_dead_tup, last_vacuum, last_autovacuum, last_analyze, last_autoanalyze @@ -815,7 +787,7 @@ To setup a scheduled admin job for vacuuming the file table, the following must | ``/usr/local/lib/bareos/scripts/postgresql_file_table_maintenance.sql`` | with the following content: - .. code-block:: sh + .. code-block:: shell-session :caption: SQL Script for vacuuming the file table on PostgreSQL \t \x @@ -838,7 +810,7 @@ To setup a scheduled admin job for vacuuming the file table, the following must | ``/usr/local/lib/bareos/scripts/postgresql_file_table_maintenance.sh`` | with the following content: - .. code-block:: sh + .. code-block:: shell-session :caption: SQL Script for vacuuming the file table on PostgreSQL #!/bin/sh @@ -846,7 +818,7 @@ To setup a scheduled admin job for vacuuming the file table, the following must #. As in PostgreSQL only the database owner or a database superuser is allowed to run VACUUM, the script will be run as the ``postgres`` user. To permit the ``bareos`` user to run the script via ``sudo``, write the following sudo rule to a file by executing ``visudo -f /etc/sudoers.d/bareos_postgres_vacuum``: - .. code-block:: sh + .. code-block:: shell-session :caption: sudo rule for allowing bareos to run a script as postgres bareos ALL = (postgres) NOPASSWD: /usr/local/lib/bareos/scripts/postgresql_file_table_maintenance.sh @@ -861,7 +833,7 @@ To setup a scheduled admin job for vacuuming the file table, the following must #. Create the following admin job in the director configuration - .. code-block:: sh + .. code-block:: shell-session :caption: SQL Script for vacuuming the file table on PostgreSQL # PostgreSQL file table maintenance job @@ -887,7 +859,7 @@ To setup a scheduled admin job for vacuuming the file table, the following must Repairing Your PostgreSQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Database->Repairing Your PostgreSQL] ` :index:`[TAG=Repairing Your PostgreSQL Database] ` +:index:`[TAG=Database->Repairing Your PostgreSQL] ` :index:`[TAG=Repairing Your PostgreSQL Database] ` The same considerations apply as for :ref:`RepairingMySQL`. Consult the PostgreSQL documents for how to repair the database. @@ -896,7 +868,7 @@ For Bareos specific problems, consider using :ref:`bareos-dbcheck` program. MySQL/MariaDB ------------- -:index:`[TAG=Database->MySQL] ` :index:`[TAG=MySQL] ` +:index:`[TAG=Database->MySQL] ` :index:`[TAG=MySQL] ` MySQL/MariaDB Support ~~~~~~~~~~~~~~~~~~~~~ @@ -914,7 +886,7 @@ As MariaDB is a fork of MySQL, we use MySQL as synonym for MariaDB and fully sup Compacting Your MySQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Database->MySQL->Compacting] ` +:index:`[TAG=Database->MySQL->Compacting] ` .. _CompactingMySQL: @@ -941,7 +913,7 @@ Please note that the database files are never shrunk by MySQL. If you really nee Repairing Your MySQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Database->Repairing Your MySQL] ` :index:`[TAG=Repairing Your MySQL Database] ` +:index:`[TAG=Database->Repairing Your MySQL] ` :index:`[TAG=Repairing Your MySQL Database] ` .. _RepairingMySQL: @@ -964,7 +936,7 @@ A typical cause of MySQL database problems is if your partition fills. In such a MySQL Table is Full ~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Database->MySQL Table is Full] ` :index:`[TAG=MySQL Table is Full] ` +:index:`[TAG=Database->MySQL Table is Full] ` :index:`[TAG=MySQL Table is Full] ` If you are running into the error The table ’File’ is full ..., it is probably because on version 4.x MySQL, the table is limited by default to a maximum size of 4 GB and you have probably run into the limit. The solution can be found at: `http://dev.mysql.com/doc/refman/5.0/en/full-table.html `_ @@ -993,7 +965,7 @@ If the column labeled "Max_data_length" is around 4Gb, this is likely to be the MySQL Server Has Gone Away ~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Database->MySQL Server Has Gone Away] ` :index:`[TAG=MySQL Server Has Gone Away] ` If you are having problems with the MySQL server disconnecting or with messages saying that your MySQL server has gone away, then please read the MySQL documentation, which can be found at: +:index:`[TAG=Database->MySQL Server Has Gone Away] ` :index:`[TAG=MySQL Server Has Gone Away] ` If you are having problems with the MySQL server disconnecting or with messages saying that your MySQL server has gone away, then please read the MySQL documentation, which can be found at: `http://dev.mysql.com/doc/refman/5.0/en/gone-away.html `_ @@ -1050,7 +1022,7 @@ In this case the |mysql| ``innodb_lock_wait_timeout`` must be increased. A value Backing Up Your Bareos Database ------------------------------- -:index:`[TAG=Backup->Bareos database] ` :index:`[TAG=Backup->Catalog] ` :index:`[TAG=Database->Backup Bareos database] ` +:index:`[TAG=Backup->Bareos database] ` :index:`[TAG=Backup->Catalog] ` :index:`[TAG=Database->Backup Bareos database] ` .. _BackingUpBareos: diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/DataEncryption.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/DataEncryption.rst index 3df92d6da83..5af8e80b4b5 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/DataEncryption.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/DataEncryption.rst @@ -3,14 +3,15 @@ Data Encryption =============== -:index:`[TAG=Data Encryption] ` :index:`[TAG=Encryption->Data] ` +:index:`[TAG=Data Encryption] ` :index:`[TAG=Encryption->Data] ` Bareos permits file data encryption and signing within the File Daemon (or Client) prior to sending data to the Storage Daemon. Upon restoration, file signatures are validated and any mismatches are reported. At no time does the Director or the Storage Daemon have access to unencrypted file contents. -.. warning:: - These feature is only available, if Bareos is build 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 do: @@ -26,9 +27,10 @@ While less critical than the Master Keys, File Daemon Keys are also a prime cand -.. warning:: - If you lose your encryption keys, backups will be unrecoverable. - {\bf always} store a copy of your master keys in a secure, off-site location. + .. warning:: + + If you lose your encryption keys, backups will be unrecoverable. + :strong:`always` store a copy of your master keys in a secure, off-site location. The basic algorithm used for each backup session (Job) is: @@ -41,7 +43,7 @@ The basic algorithm used for each backup session (Job) is: Encryption Technical Details ---------------------------- -:index:`[TAG=Encryption->Technical Details] ` +:index:`[TAG=Encryption->Technical Details] ` The implementation uses 128bit AES-CBC, with RSA encrypted symmetric session keys. The RSA key is user supplied. If you are running OpenSSL >= 0.9.8, the signed file hash uses SHA-256, otherwise SHA-1 is used. @@ -67,7 +69,7 @@ The various algorithms are exposed via an entirely re-usable, OpenSSL-agnostic A Generating Private/Public Encryption Keys ----------------------------------------- -:index:`[TAG=Encryption->Generating Private/Public Encryption Keypairs] ` +:index:`[TAG=Encryption->Generating Private/Public Encryption Keypairs] ` Generate a Master Key Pair with: @@ -100,7 +102,7 @@ Above we have used the .cert extension to refer to X509 certificate encoding tha Example Data Encryption Configurations (bareos-fd.conf) ------------------------------------------------------- -:index:`[TAG=Example->Data Encryption Configuration File] ` +:index:`[TAG=Example->Data Encryption Configuration File] ` @@ -112,7 +114,7 @@ Example Data Encryption Configurations (bareos-fd.conf) Decrypting with a Master Key ---------------------------- -:index:`[TAG=Decrypting with a Master Key] ` :index:`[TAG=Encryption->Decrypting with a Master Key] ` +:index:`[TAG=Decrypting with a Master Key] ` :index:`[TAG=Encryption->Decrypting with a Master Key] ` It is preferable to retain a secure, non-encrypted copy of the client’s own encryption keypair. However, should you lose the client’s keypair, recovery with the master keypair is possible. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/DataSpooling.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/DataSpooling.rst index 693955bc76d..936cb7903dd 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/DataSpooling.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/DataSpooling.rst @@ -11,7 +11,7 @@ Data Spooling .. _section-DataSpooling: - :index:`[TAG=Data Spooling] ` :index:`[TAG=Spooling->Data] ` + :index:`[TAG=Data Spooling] ` :index:`[TAG=Spooling->Data] ` Bareos allows you to specify that you want the Storage daemon to initially write your data to disk and then subsequently to tape. This serves several important purposes. @@ -30,15 +30,15 @@ The remainder of this chapter explains the various directives that you can use i Data Spooling Directives ------------------------ -:index:`[TAG=Data Spooling->Directives] ` +:index:`[TAG=Data Spooling->Directives] ` The following directives can be used to control data spooling. - Turn data spooling on/off at the Job level: :config:option:`dir/job/SpoolData`\ = :strong:`Yes|No` -- This setting can be overwritten in a Schedule :config:option:`dir/schedule/Run`\ directive: ``SpoolData=``:strong:`Yes|No` +- This setting can be overwritten in a Schedule :config:option:`dir/schedule/Run`\ directive: :strong:`SpoolData=`:strong:`Yes|No` -- To override the Job specification in a bconsole session using the :bcommand:`run` command: ``SpoolData=``:strong:`Yes|No` +- To override the Job specification in a bconsole session using the :bcommand:`run` command: :strong:`SpoolData=`:strong:`Yes|No` Please note that this does not refer to a configuration statement, but to an argument for the run command. @@ -57,8 +57,9 @@ Additional Notes - .. warning:: - Exclude your the spool directory from any backup, + .. warning:: + + Exclude your the spool directory from any backup, otherwise, your job will write enormous amounts of data to the Volume, and most probably terminate in error. This is because in attempting to backup the spool file, the backup data will be written a second time to the spool file, diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/FileDeduplicationUsingBaseJobs.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/FileDeduplicationUsingBaseJobs.rst index 640d143b235..9515214b856 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/FileDeduplicationUsingBaseJobs.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/FileDeduplicationUsingBaseJobs.rst @@ -10,7 +10,7 @@ necessary. Imagine having 100 nearly identical Windows or Linux machine containing the OS and user files. Now for the OS part, a Base job will be backed up once, and rather than making 100 copies of the OS, there will be only one. If one or more of the systems have some files updated, no problem, they will be automatically backuped. -A new Job directive :strong:`Base=JobX,JobY,...` permits to specify the list of files that will be used during Full backup as base. +A new Job directive :strong:`Base=JobX,JobY,...`\ permits to specify the list of files that will be used during Full backup as base. :: @@ -27,9 +27,9 @@ A new Job directive :strong:`Base=JobX,JobY,...` permits to specify the list of ... } -In this example, the job ``BackupZog4`` will use the most recent version of all files contained in ``BackupZog4`` and ``BackupLinux`` jobs. Base jobs should have run with :strong:`Level=Base` to be used. +In this example, the job ``BackupZog4`` will use the most recent version of all files contained in ``BackupZog4`` and ``BackupLinux`` jobs. Base jobs should have run with :strong:`Level=Base`\ to be used. -By default, Bareos will compare permissions bits, user and group fields, modification time, size and the checksum of the file to choose between the current backup and the BaseJob file list. You can change this behavior with the ``BaseJob`` FileSet option. This option works like the :strong:`Verify`, that is described in the :ref:`FileSet ` chapter. +By default, Bareos will compare permissions bits, user and group fields, modification time, size and the checksum of the file to choose between the current backup and the BaseJob file list. You can change this behavior with the ``BaseJob`` FileSet option. This option works like the :strong:`Verify`\ , that is described in the :ref:`FileSet ` chapter. :: @@ -47,8 +47,9 @@ By default, Bareos will compare permissions bits, user and group fields, modific -.. warning:: - The current implementation doesn't permit to scan + .. warning:: + + The current implementation doesn't permit to scan volume with :command:`bscan`. The result wouldn't permit to restore files easily. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/HowToManuallyTransferDataVolumes.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/HowToManuallyTransferDataVolumes.rst index 86d2a898f0b..ba5de9b9d10 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/HowToManuallyTransferDataVolumes.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/HowToManuallyTransferDataVolumes.rst @@ -78,9 +78,9 @@ The next incremental run will take the previously taken full backup as reference Import Data from a Independent Remote Full Bareos Installation -------------------------------------------------------------- -If a network connection between the local director and the remote storage daemon is not possible, it is also an option to setup a fully functional Bareos installation remotely and then to import the created volumes. Of course the network connection between the |bareosDir| and the |bareosFd| is needed in any case to make the incremental backups possible. +If a network connection between the local director and the remote storage daemon is not possible, it is also an option to setup a fully functional Bareos installation remotely and then to import the created volumes. Of course the network connection between the |dir| and the |fd| is needed in any case to make the incremental backups possible. -- Configure the connection from local |bareosDir| to remote |bareosFd|, give the remote client the same name as it was when the data was backed up. +- Configure the connection from local |dir| to remote |fd|, give the remote client the same name as it was when the data was backed up. - Add the Fileset created on remote machine to local machine. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/MigrationAndCopy.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/MigrationAndCopy.rst index 5623df11aab..d90b88af212 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/MigrationAndCopy.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/MigrationAndCopy.rst @@ -50,7 +50,7 @@ If the Migration control Job finds more than one existing Job to migrate, it cre Important Migration Considerations ---------------------------------- -:index:`[TAG=Migration->Important Migration Considerations] ` +:index:`[TAG=Migration->Important Migration Considerations] ` - Each Pool into which you migrate Jobs or Volumes must contain Volumes of only one :config:option:`dir/storage/MediaType`\ . @@ -120,7 +120,7 @@ Pool Resource Example Migration Jobs ~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Example->Migration Jobs] ` +:index:`[TAG=Example->Migration Jobs] ` Assume a simple configuration with a single backup job as described below. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/NdmpBackupsWithBareos.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/NdmpBackupsWithBareos.rst index 1da0a8edde0..53bfd4b11b6 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/NdmpBackupsWithBareos.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/NdmpBackupsWithBareos.rst @@ -1,7 +1,7 @@ NDMP Backups with Bareos ======================== -:index:`[TAG=NDMP->Overview] ` +:index:`[TAG=NDMP->Overview] ` NDMP Basics ----------- @@ -22,7 +22,7 @@ NDMP The Bareos NDMP implementation is based on the NDMJOB NDMP reference implementation of Traakan, Inc., Los Altos, CA which has a BSD style license (2 clause one) with some enhancements. -In NDMP, there are different components (called ''agents'') involved in doing backups. The most important agents are: +In NDMP, there are different components (called "agents") involved in doing backups. The most important agents are: Data Management Agent (DMA) is the part that controls the NDMP backup or recover operation. @@ -38,11 +38,11 @@ Robot Agent All elements involved talk to each other via the NDMP protocol which is usually transported via TCP/IP port 10000. -The |DataManagementAgent| is part of the Backup Application. +The Data Management Agent is part of the Backup Application. -The |DataAgent| is part of the (NAS)-System being backed up and recovered. +The Data Agent is part of the (NAS)-System being backed up and recovered. -The |TapeAgent| and |RobotAgent| can +The Tape Agent and Robot Agent can - run on the system being backed up @@ -55,19 +55,19 @@ This flexibility leads to different topologies how NDMP backups can be done. NDMP Topologies ~~~~~~~~~~~~~~~ -When looking at the different topologies, the location of the |RobotAgent| is not specially considered, as the data needed to control the robot is minimal compared to the backup data. +When looking at the different topologies, the location of the Robot Agent is not specially considered, as the data needed to control the robot is minimal compared to the backup data. So the parts considered are -- the |DataManagementAgent| controlling the operation +- the Data Management Agent controlling the operation -- the |DataAgent| as source of the backup data and +- the Data Agent as source of the backup data and -- the |TapeAgent| as destination of the backup data +- the Tape Agent as destination of the backup data -The |DataManagementAgent| always controls both |DataAgent| and |TapeAgent| over the Network via NDMP. +The Data Management Agent always controls both Data Agent and Tape Agent over the Network via NDMP. -The |TapeAgent| can either +The Tape Agent can either - run on a separate system @@ -117,7 +117,7 @@ NDMP 2-way Backup: Data Agent and Tape Agent running on the same system | Agent |====>TAPE DRIVE \----------/ -|DataAgent| and |TapeAgent| are both part of the same process on the system, so the data path consists of two ways: +Data Agent and Tape Agent are both part of the same process on the system, so the data path consists of two ways: - From Disk to Data Agent (1) @@ -154,15 +154,15 @@ NDMP_BAREOS In both cases, -- |bareosDir| acts as |DataManagementAgent|. +- |dir| acts as Data Management Agent. -- The |DataAgent| is part of the storage system and must be provided by the storage vendor. +- The Data Agent is part of the storage system and must be provided by the storage vendor. -The main difference is which |TapeAgent| is used. +The main difference is which Tape Agent is used. -When using NDMP_BAREOS, the |bareosSd| acts as |TapeAgent|. +When using NDMP_BAREOS, the |sd| acts as Tape Agent. -When using NDMP_NATIVE, the |TapeAgent| must be provided by some other systems. Some storage vendors provide it with there storages, or offer it as an option, e.g. Isilon with their ''Isilon Backup Accelerator''. +When using NDMP_NATIVE, the Tape Agent must be provided by some other systems. Some storage vendors provide it with there storages, or offer it as an option, e.g. Isilon with their "Isilon Backup Accelerator". # Tabular in LaTex format (original) @@ -170,44 +170,44 @@ When using NDMP_NATIVE, the |TapeAgent| must be provided by some other systems. \begin{tabular}{l | c | c} \hline - & |ndmpBareos| & |ndmpNative| \\ + & |ndmpbareos| & |ndmpnative| \\ \hline - |DataManagementAgent| & |bareosDir| & |bareosDir| \\ - |TapeAgent| & |bareosSd| & external \\ - requires external |TapeAgent| & & x \\ - backup to tape (and VTL) & x & x \\ - backup to other :config:option:`sd/device/DeviceType`\ & x & \\ - 2-way backup & & x \\ - 3-way backup & x & untested \\ - Full Backups & x & x \\ - Differential Backups & x & x \\ - Incremental Backups & :ref:`x ` (8) & :ref:`x ` (8)\\ - Single File Restore & x & x \\ - DAR & & x \\ - DDAR & & x \\ - :ref:`Copy and Migration jobs ` & x & \\ + Data Management Agent & |dir| & |dir| \\ + Tape Agent & |sd| & external \\ + requires external Tape Agent & & |checkmark| \\ + backup to tape (and VTL) & |checkmark| & |checkmark| \\ + backup to other :config:option:`sd/device/DeviceType`\ & |checkmark| & \\ + 2-way backup & & |checkmark| \\ + 3-way backup & |checkmark| & untested \\ + Full Backups & |checkmark| & |checkmark| \\ + Differential Backups & |checkmark| & |checkmark| \\ + Incremental Backups & :ref:`|checkmark| ` (8) & :ref:`|checkmark| ` (8)\\ + Single File Restore & |checkmark| & |checkmark| \\ + DAR & & |checkmark| \\ + DDAR & & |checkmark| \\ + :ref:`Copy and Migration jobs ` & |checkmark| & \\ \hline \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): ============================================================================= ================================================== ================================================= -\ |ndmpBareos| |ndmpNative| +\ |ndmpbareos| |ndmpnative| ============================================================================= ================================================== ================================================= -|DataManagementAgent| |bareosDir| |bareosDir| -|TapeAgent| |bareosSd| external -requires external |TapeAgent| x -backup to tape (and VTL) x x -backup to other :config:option:`sd/device/DeviceType`\ x -2-way backup x -3-way backup x untested -Full Backups x x -Differential Backups x x -Incremental Backups :ref:`x ` (8) :ref:`x ` (8) -Single File Restore x x -DAR x -DDAR x -:ref:`Copy and Migration jobs ` x +Data Management Agent |dir| |dir| +Tape Agent |sd| external +requires external Tape Agent |checkmark| +backup to tape (and VTL) |checkmark| |checkmark| +backup to other :config:option:`sd/device/DeviceType`\ |checkmark| +2-way backup |checkmark| +3-way backup |checkmark| untested +Full Backups |checkmark| |checkmark| +Differential Backups |checkmark| |checkmark| +Incremental Backups :ref:`|checkmark| ` (8) :ref:`|checkmark| ` (8) +Single File Restore |checkmark| |checkmark| +DAR |checkmark| +DDAR |checkmark| +:ref:`Copy and Migration jobs ` |checkmark| ============================================================================= ================================================== ================================================= .. _section-NdmpBareos: @@ -215,9 +215,9 @@ DDAR NDMP_BAREOS ----------- -Bareos implements the |DataManagementAgent| inside of the |bareosDir| and a |TapeAgent| in the |bareosSd|. +Bareos implements the Data Management Agent inside of the |dir| and a Tape Agent in the |sd|. -The |TapeAgent| in the |bareosSd| emulates a NDMP tape drive that has an infinite tape. Because of the infinite tape, no |RobotAgent| is required and therefore not implemented. The blocks being written to the NDMP tape are wrapped into a normal Bareos backup stream and then stored into the volumes managed by Bareos. +The Tape Agent in the |sd| emulates a NDMP tape drive that has an infinite tape. Because of the infinite tape, no Robot Agent is required and therefore not implemented. The blocks being written to the NDMP tape are wrapped into a normal Bareos backup stream and then stored into the volumes managed by Bareos. There is always a pair of storage resource definitions: @@ -225,11 +225,11 @@ There is always a pair of storage resource definitions: - a NDMP storage resource -These two are linked together. Data that is received by the |TapeAgent| inside of the |bareosSd| is then stored as Bareos backup stream inside of the paired conventional Bareos storage resource. +These two are linked together. Data that is received by the Tape Agent inside of the |sd| is then stored as Bareos backup stream inside of the paired conventional Bareos storage resource. On restore, the data is read by the conventional resource, and then recovered as NDMP stream from the NDMP resource. -\centering + .. figure:: /include/images/ndmp-backup.* :alt: Relationship between Bareos and NDMP components @@ -239,7 +239,7 @@ On restore, the data is read by the conventional resource, and then recovered as Example Setup for NDMP_BAREOS backup ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=NDMP->Example->NDMP\_BAREOS] ` +:index:`[TAG=NDMP->Example->NDMP\_BAREOS] ` This example starts from a clean default Bareos installation. @@ -251,7 +251,7 @@ The storage appliance needs to be configured to allow NDMP connections. Therefor Bareos Director: Configure NDMP Client Resource ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Add a Client resource to the |bareosDir| configuration and configure it to access your NDMP storage system (Primary Storage System/|DataAgent|). +Add a Client resource to the |dir| configuration and configure it to access your NDMP storage system (Primary Storage System/Data Agent). - :config:option:`dir/client/Protocol`\ must be either NDMPv2, NDMPv3 or NDMPv4. @@ -354,10 +354,10 @@ Bareos Storage Daemon: Configure NDMP Enabling NDMP ''''''''''''' -To enable the NDMP |TapeAgent| inside of the |bareosSd|, set :config:option:`sd/storage/NdmpEnable`\ =yes: +To enable the NDMP Tape Agent inside of the |sd|, set :config:option:`sd/storage/NdmpEnable`\ =yes: .. code-block:: bareosconfig - :caption: enable NDMP in |bareosSd| + :caption: enable NDMP in |sd| # # Default SD config block: enable the NDMP protocol, @@ -391,11 +391,11 @@ These are configured by adding a NDMP resource to :file:`bareos-sd.conf`: AuthType = Clear } -Username and Password can be anything, but they will have to match the settings in the |bareosDir| NDMP Storage resource we configure next. +Username and Password can be anything, but they will have to match the settings in the |dir| NDMP Storage resource we configure next. -Now restart the |bareosSd|. If everything is correct, the |bareosSd| starts and listens now on the usual port (9103) and additionally on port 10000 (ndmp). +Now restart the |sd|. If everything is correct, the |sd| starts and listens now on the usual port (9103) and additionally on port 10000 (ndmp). -.. code-block:: sh +.. code-block:: shell-session netstat -lntp | grep bareos-sd tcp 0 0 0.0.0.0:9103 0.0.0.0:* LISTEN 10661/bareos-sd @@ -438,12 +438,12 @@ We now add a paired storage to the already existing :config:option:`Dir/ = File` PairedStorage = File } -The settings of Username and Password need to match the settings of the |bareosSd|’s NDMP resource we added before. The address will be used by the storage appliance’s NDMP Daemon to connect to the |bareosSd| via NDMP. Make sure that the Storage appliance can resolve the name or use an IP address. +The settings of Username and Password need to match the settings of the |sd|’s NDMP resource we added before. The address will be used by the storage appliance’s NDMP Daemon to connect to the |sd| via NDMP. Make sure that the Storage appliance can resolve the name or use an IP address. -Now save the director resource and restart the |bareosDir|. Verify that the configuration is correct: +Now save the director resource and restart the |dir|. Verify that the configuration is correct: .. code-block:: bconsole - :caption: verify connection to the |bareosSd| + :caption: verify connection to the |sd| *status storage=NDMPFile Connecting to Storage daemon File at bareos:9103 @@ -487,7 +487,7 @@ To specify what files and directories from the storage appliance should be backe The specified directory needs to be a filesystem or a subdirectory of a filesystem which can be accessed by NDMP. Which filesystems are available is showed in the :bcommand:`status client` output of the NDMP client. -:index:`[TAG=NDMP->Environment variables] ` Additionally, NDMP can be configured via NDMP environment variables. These can be specified in the Options Block of the Fileset with the :strong:`Meta` keyword. Which variables are available is partly depending on the NDMP implementation of the Storage Appliance. +:index:`[TAG=NDMP->Environment variables] ` Additionally, NDMP can be configured via NDMP environment variables. These can be specified in the Options Block of the Fileset with the :strong:`Meta`\ keyword. Which variables are available is partly depending on the NDMP implementation of the Storage Appliance. .. code-block:: bareosconfig :caption: NDMP Fileset @@ -507,20 +507,22 @@ The specified directory needs to be a filesystem or a subdirectory of a filesyst -.. warning:: - Normally (:config:option:`dir/client/Protocol`\ =Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (:config:option:`dir/client/Protocol`\ =NDMP*), no |bareosFd| is involved and therefore most Fileset options can't be used. Instead, parameters are handled via :strong:`Options - Meta` from :config:option:`dir/fileset/Include`\ . + .. warning:: + + Normally (:config:option:`dir/client/Protocol`\ =Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (:config:option:`dir/client/Protocol`\ =NDMP*), no |fd| is involved and therefore most Fileset options can't be used. Instead, parameters are handled via :strong:`Options - Meta`\ from :config:option:`dir/fileset/Include`\ . + + .. warning:: -.. warning:: - Avoid using multiple :config:option:`dir/fileset/Include`\ :strong:`File` directives. - The |bareosDir| would try to handle them by running multiple NDMP jobs in a single Bareos job. + Avoid using multiple :config:option:`dir/fileset/Include`\ :strong:`File`\ directives. + The |dir| would try to handle them by running multiple NDMP jobs in a single Bareos job. Even if this is working fine during backup, restore jobs will cause trouble. -Some NDMP environment variables are set automatically by the DMA in the |bareosDir|. The following environment variables are currently set automatically: +Some NDMP environment variables are set automatically by the DMA in the |dir|. The following environment variables are currently set automatically: FILESYSTEM - is set to the :config:option:`dir/fileset/Include`\ :strong:`File` directive. + is set to the :config:option:`dir/fileset/Include`\ :strong:`File`\ directive. HIST | = Y @@ -545,7 +547,7 @@ LEVEL PREFIX TYPE - is set accordingly to BUTYPE. Default ''DUMP''. + is set accordingly to BUTYPE. Default "DUMP". UPDATE = Y @@ -618,7 +620,7 @@ To do NDMP backups and restores, some special settings need to be configured. We - :config:option:`dir/job/BackupFormat`\ =dump is used in our example. Other Backup Formats have other advantages/disadvantages. -\centering + .. figure:: /include/images/ndmp-cfg.* :alt: NDMP configuration overview @@ -760,7 +762,7 @@ Let us have a look what files are in our backup: /ifs/home/admin/ /ifs/home/admin/.zshrc -The real backup data is stored in the file :file:`/@NDMP/ifs/home%0` (we will refer to it as ''NDMP main backup file'' or ''main backup file'' later on). One NDMP main backup file is created for every directory specified in the used Fileset. The other files show the file history and are hardlinks to the backup file. +The real backup data is stored in the file :file:`/@NDMP/ifs/home%0` (we will refer to it as "NDMP main backup file" or "main backup file" later on). One NDMP main backup file is created for every directory specified in the used Fileset. The other files show the file history and are hardlinks to the backup file. Run NDMP Restore ~~~~~~~~~~~~~~~~ @@ -907,7 +909,7 @@ Restore files to original path Restore files to different path ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The restore location is determined by the :config:option:`dir/job/Where`\ setting of the restore job. In NDMP, this parameter works in a special manner, the prefix can be either ''relative'' to the filesystem or ''absolute''. If a prefix is set in form of a directory (like :file:`/bareos-restores`), it will be a relative prefix and will be added between the filesystem and the filename. This is needed to make sure that the +The restore location is determined by the :config:option:`dir/job/Where`\ setting of the restore job. In NDMP, this parameter works in a special manner, the prefix can be either "relative" to the filesystem or "absolute". If a prefix is set in form of a directory (like :file:`/bareos-restores`), it will be a relative prefix and will be added between the filesystem and the filename. This is needed to make sure that the data is restored in a different directory, but into the same filesystem. If the prefix is set with a leading caret (^), it will be an absolute prefix and will be put at the front of the restore path. This is needed if the restored data should be stored into a different filesystem. Example: @@ -937,11 +939,11 @@ original file name where restored f NDMP Copy Jobs ~~~~~~~~~~~~~~ -:index:`[TAG=Copy->NDMP] ` :index:`[TAG=NDMP->Copy jobs] ` +:index:`[TAG=Copy->NDMP] ` :index:`[TAG=NDMP->Copy jobs] ` -To be able to do copy jobs, we need to have a second storage resource where we can copy the data to. Depending on your requirements, this resource can be added to the existing |bareosSd| (e.g. :config:option:`Sd/Storage = autochanger-0`\ for tape based backups) or to an additional |bareosSd|. +To be able to do copy jobs, we need to have a second storage resource where we can copy the data to. Depending on your requirements, this resource can be added to the existing |sd| (e.g. :config:option:`Sd/Storage = autochanger-0`\ for tape based backups) or to an additional |sd|. -We set up an additional |bareosSd| on a host named :strong:`bareos-sd2.example.com` with the default :config:option:`Sd/Storage = FileStorage`\ device. +We set up an additional |sd| on a host named :strong:`bareos-sd2.example.com` with the default :config:option:`Sd/Storage = FileStorage`\ device. When this is done, add a second storage resource :config:option:`Dir/Storage = File2`\ to the :file:`bareos-dir.conf`: @@ -1093,8 +1095,9 @@ Now we successfully copied over the NDMP job. -.. warning:: - :bcommand:`list jobs` will only show the number of main backup files as JobFiles. However, with :bcommand:`list files jobid=...` all files are visible. + .. warning:: + + :bcommand:`list jobs` will only show the number of main backup files as JobFiles. However, with :bcommand:`list files jobid=...` all files are visible. Restore to NDMP Primary Storage System ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -1123,7 +1126,7 @@ To be able to do NDMP operations from the storage that was used to store the cop PairedStorage = File2 } -Also we have to configure NDMP on the |bareosSd| :strong:`bareos-sd2.example.com`. For this follow the instruction from :ref:`section-ndmp-sd-configure`. +Also we have to configure NDMP on the |sd| :strong:`bareos-sd2.example.com`. For this follow the instruction from :ref:`section-ndmp-sd-configure`. After this, a restore from :strong:`bareos-sd2.example.com` directly to the NDMP Primary Storage System is possible. @@ -1137,7 +1140,7 @@ This list the specific limitiations of the NDMP_BAREOS protocol. For limitation NDMP Job limitations when scanning in volumes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=NDMP->File History] ` +:index:`[TAG=NDMP->File History] ` For NDMP jobs, all data is stored into a single big file. The file and directory information (File History in NDMP Terms) is stored as hardlinks to this big file. @@ -1155,7 +1158,7 @@ For NDMP jobs, all data is stored into a single big file. The file and directory Restore always transfers the full main backup file to the Primary Storage System ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Contrary to |ndmpNative|, the |ndmpBareos| implementation do not support NDMP ''Direct Access Restore'' (DAR). +Contrary to |ndmpnative|, the |ndmpbareos| implementation do not support NDMP "Direct Access Restore" (DAR). On restore, the full main backup file (:file:`@NDMP/...%.`) is always transfered back to the Primary Storage System, together with a description, what files to restore. @@ -1168,14 +1171,14 @@ NDMP_NATIVE The NDMP_NATIVE protocol is implemented since Bareos :sinceVersion:`17.2.3: NDMP NATIVE`. -Bareos implements the |DataManagementAgent| inside of the |bareosDir| and is the only Bareos Daemon involved in the backups. +Bareos implements the Data Management Agent inside of the |dir| and is the only Bareos Daemon involved in the backups. -When using NDMP_NATIVE, the |TapeAgent| must be provided by some other systems. Some storage vendors provide it with there storages, or offer it as an option, e.g. Isilon with there ''Isilon Backup Accelerator''. +When using NDMP_NATIVE, the Tape Agent must be provided by some other systems. Some storage vendors provide it with there storages, or offer it as an option, e.g. Isilon with there "Isilon Backup Accelerator". Example Setup for NDMP_NATIVE backup ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=NDMP->Example->NDMP\_NATIVE] ` +:index:`[TAG=NDMP->Example->NDMP\_NATIVE] ` Configure a NDMP Client ^^^^^^^^^^^^^^^^^^^^^^^ @@ -1196,7 +1199,7 @@ This defines the connection to the NDMP Data Agent. Maximum Concurrent Jobs = 1 } -Verify, that you can access your Primary Storage System (|TapeAgent|) via Bareos: +Verify, that you can access your Primary Storage System (Tape Agent) via Bareos: .. code-block:: bconsole :caption: status ndmp client @@ -1318,7 +1321,7 @@ As we do not yet now the device names, we can put a placeholder string in :confi Verify that the connection to the NDMP Tape Agent and Robot Agent work, by running the :bcommand:`status storage` command. -The |TapeAgent| will return information about the available tape drives. The |RobotAgent| will return information about the available tape changer device. +The Tape Agent will return information about the available tape drives. The Robot Agent will return information about the available tape changer device. .. code-block:: bconsole :caption: status ndmp storage (Tape Agent and Robot Agent) @@ -1369,7 +1372,7 @@ The |TapeAgent| will return information about the available tape drives. The |Ro device mc001 set SERIAL_NUMBER=VL002CX1252BVE01177 -The interesting parts of the output is the device information both of the |TapeAgent| and |RobotAgent|. +The interesting parts of the output is the device information both of the Tape Agent and Robot Agent. As each NDMP backup or recovery operation always involves exactly one tape and at one robot agent. @@ -1928,7 +1931,7 @@ This section contains additional information about the Bareos NDMP implementatio NDMP Backup Level ~~~~~~~~~~~~~~~~~ -:index:`[TAG=NDMP->Level] ` +:index:`[TAG=NDMP->Level] ` The trailing number in the main backup file (after the :file:`%` character) indicates the NDMP backup level: @@ -2007,11 +2010,11 @@ NDMP Fileset limitations .. limitation:: NDMP: A NDMP fileset should only contain a single File directive and Meta options. - Using multiple :config:option:`dir/fileset/Include`\ :strong:`File` directives should be avoided. - The |bareosDir| would try to handle them by running multiple NDMP jobs in a single Bareos job. + Using multiple :config:option:`dir/fileset/Include`\ :strong:`File`\ directives should be avoided. + The |dir| would try to handle them by running multiple NDMP jobs in a single Bareos job. Even if this is working fine during backup, restore jobs will cause trouble. - Normally (:config:option:`dir/client/Protocol`\ =Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (:config:option:`dir/client/Protocol`\ =NDMP*), no |bareosFd| is involved and therefore most Fileset options can't be used. Instead, parameters are handled via :strong:`Options - Meta` from :config:option:`dir/fileset/Include`\ . + Normally (:config:option:`dir/client/Protocol`\ =Native) Filesets get handled by the \bareosFd. When connecting directly to a NDMP Clients (:config:option:`dir/client/Protocol`\ =NDMP*), no |fd| is involved and therefore most Fileset options can't be used. Instead, parameters are handled via :strong:`Options - Meta`\ from :config:option:`dir/fileset/Include`\ . @@ -2032,10 +2035,10 @@ Temporary memory mapped database .. limitation:: NDMP: 64-bit system recommended. - The |bareosDir| uses a memory mapped database (LMBD) to temporarily store NDMP file information. + The |dir| uses a memory mapped database (LMBD) to temporarily store NDMP file information. On some 32-bit systems the default :config:option:`dir/job/FileHistorySize`\ requires a larger memory area than available. In this case, you either have to lower the :config:option:`dir/job/FileHistorySize`\ - or preferably run the |bareosDir| on a 64-bit system. + or preferably run the |dir| on a 64-bit system. @@ -2051,27 +2054,27 @@ Bareos NDMP support have been tested against: \begin{tabular}{l | l | l | l | l | l | l} \hline - Vendor & Product & NDMP Subsystem & Bareos version & |TapeAgent| & Features & Remarks \\ + Vendor & Product & NDMP Subsystem & Bareos version & Tape Agent & Features & Remarks \\ \hline Isilon & Isilon OneFS v7.2.1.4 & Isilon NDMP 2.2.1 & bareos-17.2.3 & Isilon Backup Accelerator & & Protocol: \NdmpNative\\ - Isilon & Isilon OneFS v7.2.0.1 & Isilon NDMP 2.2 & bareos-16.2.6 & |bareosSd| & & \\ - Isilon & Isilon OneFS v7.1.1.5 & Isilon NDMP 2.2 & bareos-15.2.2 & |bareosSd| & & \\ - NetApp & & Release 8.2.3 7-Mode & bareos-15.2.2 & |bareosSd| & & \\ - Oracle/Sun & ZFS Storage Appliance, OS 8.3 & & bareos-15.2.2 & |bareosSd| & & \\ + Isilon & Isilon OneFS v7.2.0.1 & Isilon NDMP 2.2 & bareos-16.2.6 & |sd| & & \\ + Isilon & Isilon OneFS v7.1.1.5 & Isilon NDMP 2.2 & bareos-15.2.2 & |sd| & & \\ + NetApp & & Release 8.2.3 7-Mode & bareos-15.2.2 & |sd| & & \\ + Oracle/Sun & ZFS Storage Appliance, OS 8.3 & & bareos-15.2.2 & |sd| & & \\ \hline \end{tabular} # Tabular converted from LaTeX to RST (or empty, in case of problems): ========== ============================= ==================== ============== ============================ ======== ================================== -Vendor Product NDMP Subsystem Bareos version |TapeAgent| Features Remarks +Vendor Product NDMP Subsystem Bareos version Tape Agent Features Remarks ========== ============================= ==================== ============== ============================ ======== ================================== -Isilon Isilon OneFS v7.2.1.4 Isilon NDMP 2.2.1 bareos-17.2.3 Isilon Backup Accelerator Protocol: |ndmpNative| -Isilon Isilon OneFS v7.2.0.1 Isilon NDMP 2.2 bareos-16.2.6 |bareosSd| -Isilon Isilon OneFS v7.1.1.5 Isilon NDMP 2.2 bareos-15.2.2 |bareosSd| -NetApp Release 8.2.3 7-Mode bareos-15.2.2 |bareosSd| -Oracle/Sun ZFS Storage Appliance, OS 8.3 bareos-15.2.2 |bareosSd| +Isilon Isilon OneFS v7.2.1.4 Isilon NDMP 2.2.1 bareos-17.2.3 Isilon Backup Accelerator Protocol: |ndmpnative| +Isilon Isilon OneFS v7.2.0.1 Isilon NDMP 2.2 bareos-16.2.6 |sd| +Isilon Isilon OneFS v7.1.1.5 Isilon NDMP 2.2 bareos-15.2.2 |sd| +NetApp Release 8.2.3 7-Mode bareos-15.2.2 |sd| +Oracle/Sun ZFS Storage Appliance, OS 8.3 bareos-15.2.2 |sd| ========== ============================= ==================== ============== ============================ ======== ================================== diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/NetworkSetup.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/NetworkSetup.rst index 9dc2e3d636b..88587f8f92f 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/NetworkSetup.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/NetworkSetup.rst @@ -6,17 +6,17 @@ Network setup Client Initiated Connection --------------------------- -The |bareosDir| knows, when it is required to talk to a client (|bareosFd|). Therefore, by defaults, the |bareosDir| connects to the clients. +The |dir| knows, when it is required to talk to a client (|fd|). Therefore, by defaults, the |dir| connects to the clients. However, there are setups where this can cause problems, as this means that: - The client must be reachable by its configured :config:option:`dir/client/Address`\ . Address can be the DNS name or the IP address. (For completeness: there are potential workarounds by using the :ref:`setip ` command.) -- The |bareosDir| must be able to connect to the |bareosFd| over the network. +- The |dir| must be able to connect to the |fd| over the network. -To circumvent these problems, since Bareos :sinceVersion:`16.2.2: Client Initiated Connection` it is possible to let the |bareosFd| initiate the network connection to the |bareosDir|. +To circumvent these problems, since Bareos :sinceVersion:`16.2.2: Client Initiated Connection` it is possible to let the |fd| initiate the network connection to the |dir|. -Which address the client connects to reach the |bareosDir| is configured in the :config:option:`fd/director/Address`\ directive. +Which address the client connects to reach the |dir| is configured in the :config:option:`fd/director/Address`\ directive. To additional allow this connection direction use: @@ -38,7 +38,7 @@ To only allow Connection From the Client to the Director use: - :config:option:`fd/director/ConnectionFromClientToDirector`\ = yes -Using Client Initiated Connections has disadvantages. Without Client Initiated Connections the |bareosDir| only establishes a network connection when this is required. With Client Initiated Connections, the |bareosFd| connects to the |bareosDir| and the |bareosDir| keeps these connections open. The command :bcommand:`status dir` will show all waiting connections: +Using Client Initiated Connections has disadvantages. Without Client Initiated Connections the |dir| only establishes a network connection when this is required. With Client Initiated Connections, the |fd| connects to the |dir| and the |dir| keeps these connections open. The command :bcommand:`status dir` will show all waiting connections: .. code-block:: bconsole :caption: show waiting client connections @@ -52,7 +52,7 @@ Using Client Initiated Connections has disadvantages. Without Client Initiated C ... ==== -When both connection directions are allowed, the |bareosDir| +When both connection directions are allowed, the |dir| #. checks, if there is a waiting connection from this client. @@ -62,9 +62,9 @@ When both connection directions are allowed, the |bareosDir| If none of this worked, the job fails. -When a waiting connection is used for a job, the |bareosFd| will detect this and creates an additional connection. This is required, to keep the client responsive for additional commands, like :bcommand:`cancel`. +When a waiting connection is used for a job, the |fd| will detect this and creates an additional connection. This is required, to keep the client responsive for additional commands, like :bcommand:`cancel`. -To get feedback in case the |bareosFd| fails to connect to the |bareosDir|, consider configuring |bareosFd| to log in a local file. This can be archived by adding the line +To get feedback in case the |fd| fails to connect to the |dir|, consider configuring |fd| to log in a local file. This can be archived by adding the line ``Append = "/var/log/bareos/bareos-fd.log" = all, !skipped, !restored`` @@ -84,19 +84,19 @@ to the default message resource :config:option:`Fd/Messages = Standard`\ : Passive Clients --------------- -The normal way of initializing the data channel (the channel where the backup data itself is transported) is done by the |bareosFd| (client) that connects to the |bareosSd|. +The normal way of initializing the data channel (the channel where the backup data itself is transported) is done by the |fd| (client) that connects to the |sd|. In many setups, this can cause problems, as this means that: -- The client must be able to resolve the name of the |bareosSd| (often not true, you have to do tricks with the hosts file) +- The client must be able to resolve the name of the |sd| (often not true, you have to do tricks with the hosts file) - The client must be allowed to create a new connection. -- The client must be able to connect to the |bareosSd| over the network (often difficult over NAT or Firewall) +- The client must be able to connect to the |sd| over the network (often difficult over NAT or Firewall) -By using Passive Client, the initialization of the datachannel is reversed, so that the storage daemon connects to the |bareosFd|. This solves almost every problem created by firewalls, NAT-gateways and resolving issues, as +By using Passive Client, the initialization of the datachannel is reversed, so that the storage daemon connects to the |fd|. This solves almost every problem created by firewalls, NAT-gateways and resolving issues, as -- The |bareosSd| initiates the connection, and thus can pass through the same or similar firewall rules that the director already has to access the |bareosFd|. +- The |sd| initiates the connection, and thus can pass through the same or similar firewall rules that the director already has to access the |fd|. - The client never initiates any connection, thus can be completely firewalled. @@ -111,7 +111,7 @@ By using Passive Client, the initialization of the datachannel is reversed, so t Usage ~~~~~ -To use this new feature, just configure :config:option:`dir/client/Passive`\ =yes in the client definition of the |bareosDir|: +To use this new feature, just configure :config:option:`dir/client/Passive`\ =yes in the client definition of the |dir|: .. code-block:: bareosconfig :caption: Enable passive mode in bareos-dir.conf @@ -126,7 +126,7 @@ To use this new feature, just configure :config:option:`dir/client/Passive`\ =ye Also, prior to bareos version 15, you need to set :config:option:`fd/client/Compatible`\ =no in the :file:`bareos-fd.conf` configuration file. Since Bareos Version 15, the compatible option is set to no per default and does not need to be specified anymore. .. code-block:: bareosconfig - :caption: Disable compatible mode for the |bareosFd| in bareos-fd.conf + :caption: Disable compatible mode for the |fd| in bareos-fd.conf Director { Name = bareos-dir @@ -146,11 +146,11 @@ Using different IP Adresses for SD – FD Communication :index:`[TAG=Lan Address] ` -Bareos supports network topologies where the |bareosFd| and |bareosSd| are situated inside of a LAN, but the |bareosDir| is outside of that LAN in the Internet and accesses the |bareosFd| and |bareosSd| via SNAT / port forwarding. +Bareos supports network topologies where the |fd| and |sd| are situated inside of a LAN, but the |dir| is outside of that LAN in the Internet and accesses the |fd| and |sd| via SNAT / port forwarding. Consider the following scheme: -.. code-block:: sh +.. code-block:: shell-session /-------------------\ | | LAN 10.0.0.1/24 @@ -174,15 +174,15 @@ Consider the following scheme: | .30 .40 | \___________________/ -The |bareosDir| can access the :strong:`FD_LAN` via the IP 8.8.8.10, which is forwarded to the IP 10.0.0.10 inside of the LAN. +The |dir| can access the :strong:`FD_LAN` via the IP 8.8.8.10, which is forwarded to the IP 10.0.0.10 inside of the LAN. -The |bareosDir| can access the :strong:`SD_LAN` via the IP 8.8.8.20 which is forwarded to the IP 10.0.0.20 inside of the LAN. +The |dir| can access the :strong:`SD_LAN` via the IP 8.8.8.20 which is forwarded to the IP 10.0.0.20 inside of the LAN. -There is also a |bareosFd| and a |bareosSd| outside of the LAN, which have the IPs 8.8.8.30 and 8.8.8.40 +There is also a |fd| and a |sd| outside of the LAN, which have the IPs 8.8.8.30 and 8.8.8.40 -All resources are configured so that the :strong:`Address` directive gets the address where the |bareosDir| can reach the daemons. +All resources are configured so that the :strong:`Address`\ directive gets the address where the |dir| can reach the daemons. -Additionally, devices being in the LAN get the LAN address configured in the :strong:`Lan Address` directive. The configuration looks as follows: +Additionally, devices being in the LAN get the LAN address configured in the :strong:`Lan Address`\ directive. The configuration looks as follows: .. code-block:: bareosconfig :caption: bareos-dir.d/client/FD\_LAN.conf @@ -222,13 +222,13 @@ Additionally, devices being in the LAN get the LAN address configured in the :st ... } -This way, backups and restores from each |bareosFd| using each |bareosSd| are possible as long as the firewall allows the needed network connections. +This way, backups and restores from each |fd| using each |sd| are possible as long as the firewall allows the needed network connections. -The |bareosDir| simply checks if both the involved |bareosFd| and |bareosSd| both have a :strong:`Lan Address` (:config:option:`dir/client/LanAddress`\ and :config:option:`dir/storage/LanAddress`\ ) configured. +The |dir| simply checks if both the involved |fd| and |sd| both have a :strong:`Lan Address`\ (:config:option:`dir/client/LanAddress`\ and :config:option:`dir/storage/LanAddress`\ ) configured. -In that case, the initiating daemon is ordered to connect to the :strong:`Lan Address` instead of the :strong:`Address`. In active client mode, the |bareosFd| connects to the |bareosSd|, in passive client mode (see :ref:`PassiveClient`) the |bareosSd| connects to the |bareosFd|. +In that case, the initiating daemon is ordered to connect to the :strong:`Lan Address`\ instead of the :strong:`Address`\ . In active client mode, the |fd| connects to the |sd|, in passive client mode (see :ref:`PassiveClient`) the |sd| connects to the |fd|. -If only one or none of the involved |bareosFd| and |bareosSd| have a :strong:`Lan Address` configured, the :strong:`Address` is used as connection target for the initiating daemon. +If only one or none of the involved |fd| and |sd| have a :strong:`Lan Address`\ configured, the :strong:`Address`\ is used as connection target for the initiating daemon. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/Plugins.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/Plugins.rst index 03789542522..a6710b6b198 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/Plugins.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/Plugins.rst @@ -7,30 +7,31 @@ Plugins The functionality of Bareos can be extended by plugins. They do exists plugins for the different daemons (Director, Storage- and File-Daemon). -To use plugins, they must be enabled in the configuration (:strong:`Plugin Directory` and optionally :strong:`Plugin Names`). +To use plugins, they must be enabled in the configuration (:strong:`Plugin Directory`\ and optionally :strong:`Plugin Names`\ ). -If a :strong:`Plugin Directory` is specified :strong:`Plugin Names` defines, which plugins get loaded. +If a :strong:`Plugin Directory`\ is specified :strong:`Plugin Names`\ defines, which plugins get loaded. -If :strong:`Plugin Names` is not defined, all plugins get loaded. +If :strong:`Plugin Names`\ is not defined, all plugins get loaded. .. _fdPlugins: File Daemon Plugins ------------------- -File Daemon plugins are configured by the :strong:`Plugin` directive of a :ref:`File Set `. +File Daemon plugins are configured by the :strong:`Plugin`\ directive of a :ref:`File Set `. -.. warning:: - Currently the plugin command is being stored as part of the backup. The restore command in your directive should be flexible enough if things might change in future, otherwise you could run into trouble. + .. warning:: + + Currently the plugin command is being stored as part of the backup. The restore command in your directive should be flexible enough if things might change in future, otherwise you could run into trouble. .. _bpipe: bpipe Plugin ~~~~~~~~~~~~ -:index:`[TAG=Plugin->bpipe] ` +:index:`[TAG=Plugin->bpipe] ` The bpipe plugin is a generic pipe program, that simply transmits the data from a specified program to Bareos for backup, and from Bareos to a specified program for restore. The purpose of the plugin is to provide an interface to any system program for backup and restore. That allows you, for example, to do database backups without a local dump. By using different command lines to bpipe, you can backup any kind of data (ASCII or binary) depending on the program called. @@ -65,7 +66,7 @@ plugin is the name of the plugin with the trailing -fd.so stripped off, so in this case, we would put bpipe in the field. filepath - specifies the namespace, which for bpipe is the pseudo path and filename under which the backup will be saved. This pseudo path and filename will be seen by the user in the restore file tree. For example, if the value is :strong:`/MySQL/mydump.sql`, the data backed up by the plugin will be put under that ''pseudo'' path and filename. You must be careful to choose a naming convention that is unique to avoid a conflict with a path and filename that actually + specifies the namespace, which for bpipe is the pseudo path and filename under which the backup will be saved. This pseudo path and filename will be seen by the user in the restore file tree. For example, if the value is :strong:`/MySQL/mydump.sql`, the data backed up by the plugin will be put under that "pseudo" path and filename. You must be careful to choose a naming convention that is unique to avoid a conflict with a path and filename that actually exists on your system. readprogram @@ -97,35 +98,35 @@ See chapter :ref:`MSSQL`. LDAP Plugin ~~~~~~~~~~~ -:index:`[TAG=Plugin->ldap] ` +:index:`[TAG=Plugin->ldap] ` This plugin is intended to backup (and restore) the contents of a LDAP server. It uses normal LDAP operation for this. The package **bareos-filedaemon-ldap-python-plugin** (:sinceVersion:`15.2.0: LDAP Plugin`) contains an example configuration file, that must be adapted to your envirnoment. Cephfs Plugin ~~~~~~~~~~~~~ -:index:`[TAG=Plugin->ceph->cephfs] ` :index:`[TAG=Ceph->Cephfs Plugin] ` +:index:`[TAG=Plugin->ceph->cephfs] ` :index:`[TAG=Ceph->Cephfs Plugin] ` Opposite to the :ref:`Rados Backend ` that is used to store data on a CEPH Object Store, this plugin is intended to backup a CEPH Object Store via the Cephfs interface to other media. The package **bareos-filedaemon-ceph-plugin** (:sinceVersion:`15.2.0: Cephfs Plugin`) contains an example configuration file, that must be adapted to your envirnoment. Rados Plugin ~~~~~~~~~~~~ -:index:`[TAG=Plugin->ceph->rados] ` :index:`[TAG=Ceph->Rados Plugin] ` +:index:`[TAG=Plugin->ceph->rados] ` :index:`[TAG=Ceph->Rados Plugin] ` Opposite to the :ref:`Rados Backend ` that is used to store data on a CEPH Object Store, this plugin is intended to backup a CEPH Object Store via the Rados interface to other media. The package **bareos-filedaemon-ceph-plugin** (:sinceVersion:`15.2.0: CEPH Rados Plugin`) contains an example configuration file, that must be adapted to your envirnoment. GlusterFS Plugin ~~~~~~~~~~~~~~~~ -:index:`[TAG=Plugin->glusterfs] ` :index:`[TAG=GlusterFS->Plugin] ` +:index:`[TAG=Plugin->glusterfs] ` :index:`[TAG=GlusterFS->Plugin] ` Opposite to the :ref:`GFAPI Backend ` that is used to store data on a Gluster system, this plugin is intended to backup data from a Gluster system to other media. The package **bareos-filedaemon-glusterfs-plugin** (:sinceVersion:`15.2.0: GlusterFS Plugin`) contains an example configuration file, that must be adapted to your envirnoment. python-fd Plugin ~~~~~~~~~~~~~~~~ -:index:`[TAG=Plugin->Python->File Daemon] ` +:index:`[TAG=Plugin->Python->File Daemon] ` The **python-fd** plugin behaves similar to the :ref:`director-python-plugin`. Base plugins and an example get installed via the package bareos-filedaemon-python-plugin. Configuration is done in the :ref:`DirectorResourceFileSet` on the director. @@ -150,7 +151,7 @@ Command plugins are used to replace or extend the FileSet definition in the File } } -:index:`[TAG=MySQL->Backup] ` This example uses the :ref:`MySQL plugin ` to backup MySQL dumps in addition to :file:`/etc`. +:index:`[TAG=MySQL->Backup] ` This example uses the :ref:`MySQL plugin ` to backup MySQL dumps in addition to :file:`/etc`. Option Plugins ^^^^^^^^^^^^^^ @@ -181,7 +182,7 @@ This plugin bareos-fd-file-interact from https://github.com/bareos/bareos-contri VMware Plugin ~~~~~~~~~~~~~ -:index:`[TAG=Plugin->VMware] ` :index:`[TAG=VMware Plugin] ` +:index:`[TAG=Plugin->VMware] ` :index:`[TAG=VMware Plugin] ` The |vmware| Plugin can be used for agentless backups of virtual machines running on |vsphere|. It makes use of CBT (Changed Block Tracking) to do space efficient full and incremental backups, see below for mandatory requirements. @@ -227,7 +228,7 @@ Current limitations amongst others are: Requirements ^^^^^^^^^^^^ -As the Plugin is based on the |vsphere| Storage APIs for Data Protection, which requires at least a |vsphere| Essentials License. It is tested against |vsphere| Storage APIs for Data Protection of |vmware| 5.x. It does not work with standalone unlicensed |vmware| ESXi\ :sup:`(TM)`. +As the Plugin is based on the |vsphere| Storage APIs for Data Protection, which requires at least a |vsphere| Essentials License. It is tested against |vsphere| Storage APIs for Data Protection of |vmware| 5.x. It does not work with standalone unlicensed |vmware| ESXi\ |trade|. Since Bareos :sinceVersion:`17.2.4: VMware Plugin: VDDK 6.5.2` the plugin is using the Virtual Disk Development Kit (VDDK) 6.5.2, as of the VDDK 6.5 release notes, it should be compatible with vSphere 6.5 and the next major release (except new features) and backward compatible with vSphere 5.5 and 6.0, see VDDK release notes at https://code.vmware.com/web/sdk/65/vddk for details. @@ -251,7 +252,7 @@ For more details regarding users and permissions in vSphere see - http://pubs.vmware.com/vsphere-55/topic/com.vmware.vsphere.security.doc/GUID-5372F580-5C23-4E9C-8A4E-EF1B4DD9033E.html -Make sure to add or enable the following settings in your |bareosFd| configuration: +Make sure to add or enable the following settings in your |fd| configuration: .. code-block:: bareosconfig :caption: bareos-fd.d/client/myself.conf @@ -308,14 +309,14 @@ or install the **bareos-vmware-plugin-compat** package which includes compatibil Since :sinceVersion:`17.2.4: VMware Plugin: vcthumbprint`: as the Plugin is using the Virtual Disk Development Kit (VDDK) 6.5, it is required to pass the thumbprint of the vCenter SSL Certificate, which is the SHA1 checksum of the SSL Certificate. The thumbprint can be retrieved like this: -.. code-block:: sh +.. code-block:: shell-session :caption: Example Retrieving vCenter SSL Certificate Thumbprint echo -n | openssl s_client -connect vcenter.example.org:443 2>/dev/null | openssl x509 -noout -fingerprint -sha1 The result would look like this: -.. code-block:: sh +.. code-block:: shell-session :caption: Example Result Thumbprint SHA1 Fingerprint=CC:81:81:84:A3:CF:53:ED:63:B1:46:EF:97:13:4A:DF:A5:9F:37:89 @@ -378,7 +379,7 @@ Since :sinceVersion:`17.2.8: VMware Plugin: non-ascii characters` it is possible } } -However, it is important to know that it is not possible to use non-ascii characters as an argument for the :strong:`Name` of a job or fileset resource. +However, it is important to know that it is not possible to use non-ascii characters as an argument for the :strong:`Name`\ of a job or fileset resource. Before this, it was only possible specify VMs contained in vApps by using the instance UUID with the :strong:`uuid` instead of :strong:`folder` and :strong:`vmname` like this: @@ -402,7 +403,7 @@ Before running the first backup, CBT (Changed Block Tracking) must be enabled fo As of http://kb.vmware.com/kb/2075984 manually enabling CBT is currently not working properly. The API however works properly. To enable CBT use the Script :command:`vmware_cbt_tool.py`, it is packaged in the bareos-vmware-plugin package: -.. code-block:: sh +.. code-block:: shell-session :caption: usage of vmware\_cbt\_tool.py # vmware_cbt_tool.py --help @@ -440,7 +441,7 @@ in a tabular output including instance UUID and containing Folder/vApp name. For the above configuration example, the command to enable CBT would be -.. code-block:: sh +.. code-block:: shell-session :caption: Example using vmware\_cbt\_tool.py # vmware_cbt_tool.py -s vcenter.example.org -u bakadm@vsphere.local -p Bak.Adm-1234 -d mydc1 -f /webservers -v websrv1 --enablecbt @@ -459,14 +460,14 @@ For restore, the VM must be powered off and no snapshot must exist. In :command: Restore to local VMDK File ^^^^^^^^^^^^^^^^^^^^^^^^^^ -:index:`[TAG=VMware Plugin->VMDK files] ` +:index:`[TAG=VMware Plugin->VMDK files] ` -Since :sinceVersion:`15.2.3: VMware Plugin: restore to VMDK files` it is possible to restore to local VMDK files. That means, instead of directly restoring a disk that belongs to the VM, the restore creates VMDK disk image files on the filesystem of the system that runs the |bareosFd|. As the VM that the backup was taken from is not affected by this, it can remain switched on while restoring to local VMDK. Such a restored VMDK file can then be uploaded to a +Since :sinceVersion:`15.2.3: VMware Plugin: restore to VMDK files` it is possible to restore to local VMDK files. That means, instead of directly restoring a disk that belongs to the VM, the restore creates VMDK disk image files on the filesystem of the system that runs the |fd|. As the VM that the backup was taken from is not affected by this, it can remain switched on while restoring to local VMDK. Such a restored VMDK file can then be uploaded to a |vsphere| datastore or accessed by tools like `guestfish `_ to extract single files. For restoring to local VMDK, the plugin option :strong:`localvmdk=yes` must be passed. The following example shows how to perform such a restore using :command:`bconsole`: -.. code-block:: sh +.. code-block:: shell-session :caption: Example restore to local VMDK *restore @@ -573,7 +574,7 @@ Before, all Python plugin must be repeated and the additional be added, like: :f After the restore process has finished, the restored VMDK files can be found under \path{/tmp/bareos-restores/}: -.. code-block:: sh +.. code-block:: shell-session :caption: Example result of restore to local VMDK # ls -laR /tmp/bareos-restores @@ -600,7 +601,7 @@ Storage Daemon Plugins autoxflate-sd ~~~~~~~~~~~~~ -:index:`[TAG=Plugin->autoxflate-sd] ` +:index:`[TAG=Plugin->autoxflate-sd] ` This plugin is part of the **bareos-storage** package. @@ -630,7 +631,7 @@ Szenarios where this plugin can be used are for example: - client computers with weak cpus can do backups without compression and let the sd do the compression when writing to disk -- compressed backups can be recompressed to a different compression format (e.g. gzip -> lzo) using migration jobs +- compressed backups can be recompressed to a different compression format (e.g. gzip |rarr| lzo) using migration jobs - client backups can be compressed with compression algorithms that the client itself does not support @@ -658,7 +659,7 @@ Additional :config:option:`sd/storage/AutoXflateOnReplication`\ can be configur scsicrypto-sd ~~~~~~~~~~~~~ -:index:`[TAG=Plugin->scsicrypto-sd] ` +:index:`[TAG=Plugin->scsicrypto-sd] ` This plugin is part of the **bareos-storage-tape** package. @@ -721,7 +722,7 @@ The initial setup of SCSI crypto looks something like this: - Generate a Key Encryption Key e.g. - .. code-block:: sh + .. code-block:: shell-session bscrypto -g - @@ -737,44 +738,44 @@ The following additional security is needed for the following operating systems: Linux (SG_IO ioctl interface): -The user running the storage daemon needs the following additional capabilities: :index:`[TAG=Platform->Linux->Privileges] ` +The user running the storage daemon needs the following additional capabilities: :index:`[TAG=Platform->Linux->Privileges] ` -- ``CAP_SYS_RAWIO`` (see capabilities(7)) +- :strong:`CAP_SYS_RAWIO` (see capabilities(7)) - - On older kernels you might need ``CAP_SYS_ADMIN``. Try ``CAP_SYS_RAWIO`` first and if that doesn’t work try ``CAP_SYS_ADMIN`` + - On older kernels you might need :strong:`CAP_SYS_ADMIN`. Try :strong:`CAP_SYS_RAWIO` first and if that doesn’t work try :strong:`CAP_SYS_ADMIN` -- If you are running the storage daemon as another user than root (which has the ``CAP_SYS_RAWIO`` capability), you need to add it to the current set of capabilities. +- If you are running the storage daemon as another user than root (which has the :strong:`CAP_SYS_RAWIO` capability), you need to add it to the current set of capabilities. - If you are using systemd, you could add this additional capability to the CapabilityBoundingSet parameter. - - For systemd add the following to the bareos-sd.service: ``Capabilities=cap_sys_rawio+ep`` + - For systemd add the following to the bareos-sd.service: :strong:`Capabilities=cap_sys_rawio+ep` You can also set up the extra capability on :command:`bscrypto` and :command:`bareos-sd` by running the following commands: -.. code-block:: sh +.. code-block:: shell-session setcap cap_sys_rawio=ep bscrypto setcap cap_sys_rawio=ep bareos-sd Check the setting with -.. code-block:: sh +.. code-block:: shell-session getcap -v bscrypto getcap -v bareos-sd :command:`getcap` and :command:`setcap` are part of libcap-progs. -If :command:`bareos-sd` does not have the appropriate capabilities, all other tape operations may still work correctly, but you will get ''Unable to perform SG\_IO ioctl'' errors. +If :command:`bareos-sd` does not have the appropriate capabilities, all other tape operations may still work correctly, but you will get "Unable to perform SG\_IO ioctl" errors. Solaris (USCSI ioctl interface): -The user running the storage daemon needs the following additional privileges: :index:`[TAG=Platform->Solaris->Privileges] ` +The user running the storage daemon needs the following additional privileges: :index:`[TAG=Platform->Solaris->Privileges] ` -- ``PRIV_SYS_DEVICES`` (see privileges(5)) +- :strong:`PRIV_SYS_DEVICES` (see privileges(5)) -If you are running the storage daemon as another user than root (which has the ``PRIV_SYS_DEVICES`` privilege), you need to add it to the current set of privileges. This can be set up by setting this either as a project for the user, or as a set of extra privileges in the SMF definition starting the storage daemon. The SMF setup is the cleanest one. +If you are running the storage daemon as another user than root (which has the :strong:`PRIV_SYS_DEVICES` privilege), you need to add it to the current set of privileges. This can be set up by setting this either as a project for the user, or as a set of extra privileges in the SMF definition starting the storage daemon. The SMF setup is the cleanest one. For SMF make sure you have something like this in the instance block: @@ -828,10 +829,10 @@ For Disaster Recovery (DR) you need the following information: This data needs to be availabe as a so called crypto cache file which is used by the plugin when no connection to the director can be made to do a lookup (most likely on DR). -Most of the times the needed information, e.g. the bootstrap info, is available on recently written volumes and most of the time the encryption cache will contain the most recent data, so a recent copy of the :file:`bareos-sd..cryptoc` file in the working directory is enough most of the time. You can also save the info from database in a safe place and use bscrypto to populate this info (VolumeName -> EncryptKey) into the crypto cache file used by +Most of the times the needed information, e.g. the bootstrap info, is available on recently written volumes and most of the time the encryption cache will contain the most recent data, so a recent copy of the :file:`bareos-sd..cryptoc` file in the working directory is enough most of the time. You can also save the info from database in a safe place and use bscrypto to populate this info (VolumeName |rarr| EncryptKey) into the crypto cache file used by :command:`bextract` and :command:`bscan`. You can use :command:`bscrypto` with the following flags to create a new or update an existing crypto cache file e.g.: -.. code-block:: sh +.. code-block:: shell-session bscrypto -p /var/lib/bareos/bareos-sd..cryptoc @@ -839,7 +840,7 @@ Most of the times the needed information, e.g. the bootstrap info, is available - Recover the database in the normal way e.g. for postgresql: - .. code-block:: sh + .. code-block:: shell-session bextract -D -c bareos-sd.conf -V \ /dev/nst0 /tmp -b bootstrap.bsr /usr/lib64/bareos/create_bareos_database @@ -848,20 +849,20 @@ Most of the times the needed information, e.g. the bootstrap info, is available Or something similar (change paths to follow where you installed the software or where the package put it). -**Note:** As described at the beginning of this chapter, there are different types of key management, AME, LME and KMA. If the Library is set up for LME or KMA, it probably won’t allow our AME setup and the scsi-crypto plugin will fail to set/clear the encryption key. To be able to use AME you need to ''Modify Encryption Method'' and set it to something like ''Application Managed''. If you decide to use LME or KMA you don’t have to bother with the whole setup +**Note:** As described at the beginning of this chapter, there are different types of key management, AME, LME and KMA. If the Library is set up for LME or KMA, it probably won’t allow our AME setup and the scsi-crypto plugin will fail to set/clear the encryption key. To be able to use AME you need to "Modify Encryption Method" and set it to something like "Application Managed". If you decide to use LME or KMA you don’t have to bother with the whole setup of AME which may for big libraries be easier, although the overhead of using AME even for very big libraries should be minimal. scsitapealert-sd ~~~~~~~~~~~~~~~~ -:index:`[TAG=Plugin->scsitapealert-sd] ` +:index:`[TAG=Plugin->scsitapealert-sd] ` This plugin is part of the **bareos-storage-tape** package. python-sd Plugin ~~~~~~~~~~~~~~~~ -:index:`[TAG=Plugin->Python->Storage Daemon] ` +:index:`[TAG=Plugin->Python->Storage Daemon] ` The **python-sd** plugin behaves similar to the :ref:`director-python-plugin`. @@ -875,7 +876,7 @@ Director Plugins python-dir Plugin ~~~~~~~~~~~~~~~~~ -:index:`[TAG=Plugin->Python->Director] ` +:index:`[TAG=Plugin->Python->Director] ` The **python-dir** plugin is intended to extend the functionality of the Bareos Director by Python code. A working example is included. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/StorageBackends.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/StorageBackends.rst index 73c4c972078..a4201d7c61f 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/StorageBackends.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/StorageBackends.rst @@ -26,9 +26,9 @@ A Bareos Storage Daemon can use various storage backends: Droplet Storage Backend ----------------------- -:index:`[TAG=Backend->Droplet] ` :index:`[TAG=Backend->Droplet->S3] ` :index:`[TAG=Backend->S3|see {Backend->Droplet}] ` +:index:`[TAG=Backend->Droplet] ` :index:`[TAG=Backend->Droplet->S3] ` :index:`[TAG=Backend->S3|see {Backend->Droplet}] ` -The **bareos-storage-droplet** backend (:sinceVersion:`17.2.7: Droplet`) can be used to access Object Storage through **libdroplet**. Droplet support a number of backends, most notably S3. For details about Droplet itself see ``_. +The **bareos-storage-droplet** backend (:sinceVersion:`17.2.7: Droplet`) can be used to access Object Storage through **libdroplet**. Droplet support a number of backends, most notably S3. For details about Droplet itself see https://github.com/scality/Droplet. Requirements ~~~~~~~~~~~~ @@ -47,7 +47,7 @@ Install the package **bareos-storage-droplet** by using an appropriate package m Configuration ~~~~~~~~~~~~~ -The droplet backend requires a |bareosDir| :ref:`DirectorResourceStorage`, a |bareosSd| :ref:`StorageResourceDevice` as well as a Droplet profile file where your access– and secret–keys and other parameters for the connection to your object storage are stored. +The droplet backend requires a |dir| :ref:`DirectorResourceStorage`, a |sd| :ref:`StorageResourceDevice` as well as a Droplet profile file where your access– and secret–keys and other parameters for the connection to your object storage are stored. .. _section-DropletAwsS3: @@ -57,15 +57,15 @@ AWS S3 Director '''''''' -First, we will create the new |bareosDir| :ref:`DirectorResourceStorage`. +First, we will create the new |dir| :ref:`DirectorResourceStorage`. For the following example, we - choose the name :config:option:`Dir/Storage = S3_Object`\ . -- choose \resourceDirectiveValue{Dir}{Storage}{Media Type}{S3_Object1}. We name it this way, in case we later add more separated Object Storages that don’t have access to the same volumes. +- choose :config:option:`dir/storage/MediaType = S3_Object1`\ . We name it this way, in case we later add more separated Object Storages that don’t have access to the same volumes. -- assume the |bareosSd| is located on the host :strong:`bareos-sd.example.com` and will offers the :ref:`StorageResourceDevice` :config:option:`Sd/Device = S3_ObjectStorage`\ (to be configured in the next section). +- assume the |sd| is located on the host :strong:`bareos-sd.example.com` and will offers the :ref:`StorageResourceDevice` :config:option:`Sd/Device = S3_ObjectStorage`\ (to be configured in the next section). .. code-block:: bareosconfig :caption: bareos-dir.d/storage/S3\_Object.conf @@ -78,14 +78,14 @@ For the following example, we Media Type = "S3_Object1" } -These credentials are only used to connect to the |bareosSd|. The credentials to access the object store (e.g. S3) are stored in the |bareosSd| Droplet Profile. +These credentials are only used to connect to the |sd|. The credentials to access the object store (e.g. S3) are stored in the |sd| Droplet Profile. Storage Daemon '''''''''''''' -As of your |bareosSd| configuration, we need to setup a new device that acts as a link to Object Storage backend. +As of your |sd| configuration, we need to setup a new device that acts as a link to Object Storage backend. -The name and media type must correspond to those settings in the |bareosDir| :ref:`DirectorResourceStorage`: +The name and media type must correspond to those settings in the |dir| :ref:`DirectorResourceStorage`: - :config:option:`sd/device/Name`\ = :config:option:`dir/storage/Device`\ @@ -110,7 +110,7 @@ A device for the usage of AWS S3 object storage with a bucket named :file:`backu Maximum Concurrent Jobs = 1 } -In these examples all the backup data is placed in the :file:`bareos-backup` bucket on the defined S3 storage. In contrast to other |bareosSd| backends, a Bareos volume is not represented by a single file. Instead a volume is a sub-directory in the defined bucket and every chunk is placed in the volume directory with the filename 0000-9999 and a size defined in the chunksize option. It is implemented this way, as S3 does not allow to append to a file. Instead it always writes full +In these examples all the backup data is placed in the :file:`bareos-backup` bucket on the defined S3 storage. In contrast to other |sd| backends, a Bareos volume is not represented by a single file. Instead a volume is a sub-directory in the defined bucket and every chunk is placed in the volume directory with the filename 0000-9999 and a size defined in the chunksize option. It is implemented this way, as S3 does not allow to append to a file. Instead it always writes full files, so every append operation could result in reading and writing the full volume file. Following :config:option:`sd/device/DeviceOptions`\ settings are possible: @@ -227,10 +227,10 @@ For testing following :config:option:`sd/device/DeviceOptions`\ should be used: - :file:`retries=1` -If the S3 backend is or becomes unreachable, the |bareosSd| will behave depending on :strong:`iothreads` and :strong:`retries`. When the |bareosSd| is using cached writing (:strong:`iothreads`\ :math:`>=1`) and :strong:`retries` is set to zero (unlimited tries), the job will continue running until the backend becomes available again. The job cannot be canceled in this case, as the |bareosSd| will +If the S3 backend is or becomes unreachable, the |sd| will behave depending on :strong:`iothreads` and :strong:`retries`. When the |sd| is using cached writing (:strong:`iothreads`\ :math:`>=1`) and :strong:`retries` is set to zero (unlimited tries), the job will continue running until the backend becomes available again. The job cannot be canceled in this case, as the |sd| will continuously try to write the cached files. -Great caution should be used when using :strong:`retries` :math:`>=0` combined with cached writing. If the backend becomes unavailable and the |bareosSd| reaches the predefined tries, the job will be discarded silently yet marked as :file:`OK` in the |bareosDir|. +Great caution should be used when using :strong:`retries` :math:`>=0` combined with cached writing. If the backend becomes unavailable and the |sd| reaches the predefined tries, the job will be discarded silently yet marked as :file:`OK` in the |dir|. You can always check the status of the writing process by using :bcommand:`status storage=...`. The current writing status will be displayed then: diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TheRestoreCommand.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TheRestoreCommand.rst index 4d4629b047d..4c71b79bc3e 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TheRestoreCommand.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TheRestoreCommand.rst @@ -22,7 +22,7 @@ well, if so desired. By default, Bareos will restore data to the same Client tha The Restore Command ------------------- -:index:`[TAG=Console->Command->restore] ` +:index:`[TAG=Console->Command->restore] ` Since Bareos maintains a catalog of your files and on which Volumes (disk or tape), they are stored, it can do most of the bookkeeping work, allowing you simply to specify what kind of restore you want (current, before a particular date), and what files to restore. Bareos will then do the rest. @@ -153,7 +153,7 @@ At this point, Bareos has all the information it needs to find the most recent s -Depending on the number of JobFiles for each JobId, the ''Building directory tree ...'' can take a bit of time. If you notice ath all the JobFiles are zero, your Files have probably been pruned and you will not be able to select any individual files – it will be restore everything or nothing. +Depending on the number of JobFiles for each JobId, the "Building directory tree ..." can take a bit of time. If you notice ath all the JobFiles are zero, your Files have probably been pruned and you will not be able to select any individual files – it will be restore everything or nothing. In our example, Bareos found four Jobs that comprise the most recent backup of the specified Client and FileSet. Two of the Jobs have the same JobId because that Job wrote on two different Volumes. The third Job was an incremental backup to the previous Full backup, and it only saved 254 Files compared to 128,374 for the Full backup. The fourth Job was also an incremental backup that saved 15 files. @@ -250,7 +250,7 @@ If you now enter yes, Bareos will run the restore Job. Selecting Files by Filename --------------------------- -:index:`[TAG=Restore->by filename] ` +:index:`[TAG=Restore->by filename] ` If you have a small number of files to restore, and you know the filenames, you can either put the list of filenames in a file to be read by Bareos, or you can enter the names one at a time. The filenames must include the full path and filename. No wild cards are used. @@ -413,7 +413,7 @@ The full list of possible command line arguments are: Using File Relocation --------------------- -:index:`[TAG=File Relocation->using] ` +:index:`[TAG=File Relocation->using] ` .. _filerelocation: @@ -514,7 +514,7 @@ Orignal filename New filename RegexWhere Com Restoring Directory Attributes ------------------------------ -:index:`[TAG=Attributes->Restoring Directory] ` :index:`[TAG=Restoring Directory Attributes] ` +:index:`[TAG=Attributes->Restoring Directory] ` :index:`[TAG=Restoring Directory Attributes] ` Depending how you do the restore, you may or may not get the directory entries back to their original state. Here are a few of the problems you can encounter, and for same machine restores, how to avoid them. @@ -533,7 +533,7 @@ Depending how you do the restore, you may or may not get the directory entries b Restoring on Windows -------------------- -:index:`[TAG=Restoring on Windows] ` :index:`[TAG=Windows->Restoring on] ` +:index:`[TAG=Restoring on Windows] ` :index:`[TAG=Windows->Restoring on] ` If you are restoring on Windows systems, Bareos will restore the files with the original ownerships and permissions as would be expected. This is also true if you are restoring those files to an alternate directory (using the Where option in restore). However, if the alternate directory does not already exist, the Bareos File daemon (Client) will try to create it. In some cases, it may not create the directories, and if it does since the File daemon runs under the SYSTEM account, the directory will be created with SYSTEM ownership and permissions. In this case, you may have problems accessing the newly restored files. @@ -547,7 +547,7 @@ Some users have experienced problems restoring files that participate in the Act Restore Errors -------------- -:index:`[TAG=Errors->Restore] ` :index:`[TAG=Restore Errors] ` +:index:`[TAG=Errors->Restore] ` :index:`[TAG=Restore Errors] ` There are a number of reasons why there may be restore errors or warning messages. Some of the more common ones are: @@ -566,7 +566,7 @@ file size error Example Restore Job Resource ---------------------------- -:index:`[TAG=Resource->Example Restore Job] ` +:index:`[TAG=Resource->Example Restore Job] ` @@ -594,35 +594,35 @@ If Where is not specified, the default location for restoring files will be thei File Selection Commands ----------------------- -:index:`[TAG=Console->File Selection] ` :index:`[TAG=File Selection Commands] ` +:index:`[TAG=Console->File Selection] ` :index:`[TAG=File Selection Commands] ` After you have selected the Jobs to be restored and Bareos has created the in-memory directory tree, you will enter file selection mode as indicated by the dollar sign ($) prompt. While in this mode, you may use the commands listed above. The basic idea is to move up and down the in memory directory structure with the cd command much as you normally do on the system. Once you are in a directory, you may select the files that you want restored. As a default no files are marked to be restored. If you wish to start with all files, simply enter: cd / and mark \*. Otherwise proceed to select the files you wish to restore by marking them with the mark command. The available commands are: cd - :index:`[TAG=Console->File Selection->cd] ` The cd command changes the current directory to the argument specified. It operates much like the Unix cd command. Wildcard specifications are not permitted. + :index:`[TAG=Console->File Selection->cd] ` The cd command changes the current directory to the argument specified. It operates much like the Unix cd command. Wildcard specifications are not permitted. Note, on Windows systems, the various drives (c:, d:, ...) are treated like a directory within the file tree while in the file selection mode. As a consequence, you must do a cd c: or possibly in some cases a cd C: (note upper case) to get down to the first directory. dir - :index:`[TAG=Console->File Selection->dir] ` The dir command is similar to the ls command, except that it prints it in long format (all details). This command can be a bit slower than the ls command because it must access the catalog database for the detailed information for each file. + :index:`[TAG=Console->File Selection->dir] ` The dir command is similar to the ls command, except that it prints it in long format (all details). This command can be a bit slower than the ls command because it must access the catalog database for the detailed information for each file. estimate - :index:`[TAG=Console->File Selection->estimate] ` The estimate command prints a summary of the total files in the tree, how many are marked to be restored, and an estimate of the number of bytes to be restored. This can be useful if you are short on disk space on the machine where the files will be restored. + :index:`[TAG=Console->File Selection->estimate] ` The estimate command prints a summary of the total files in the tree, how many are marked to be restored, and an estimate of the number of bytes to be restored. This can be useful if you are short on disk space on the machine where the files will be restored. find - :index:`[TAG=Console->File Selection->find] ` The find command accepts one or more arguments and displays all files in the tree that match that argument. The argument may have wildcards. It is somewhat similar to the Unix command find / -name arg. + :index:`[TAG=Console->File Selection->find] ` The find command accepts one or more arguments and displays all files in the tree that match that argument. The argument may have wildcards. It is somewhat similar to the Unix command find / -name arg. ls - :index:`[TAG=Console->File Selection->ls] ` The ls command produces a listing of all the files contained in the current directory much like the Unix ls command. You may specify an argument containing wildcards, in which case only those files will be listed. + :index:`[TAG=Console->File Selection->ls] ` The ls command produces a listing of all the files contained in the current directory much like the Unix ls command. You may specify an argument containing wildcards, in which case only those files will be listed. Any file that is marked to be restored will have its name preceded by an asterisk (). Directory names will be terminated with a forward slash (/) to distinguish them from filenames. lsmark - :index:`[TAG=Console->File Selection->lsmark] ` The lsmark command is the same as the ls except that it will print only those files marked for extraction. The other distinction is that it will recursively descend into any directory selected. + :index:`[TAG=Console->File Selection->lsmark] ` The lsmark command is the same as the ls except that it will print only those files marked for extraction. The other distinction is that it will recursively descend into any directory selected. mark - :index:`[TAG=Console->File Selection->mark] ` The mark command allows you to mark files to be restored. It takes a single argument which is the filename or directory name in the current directory to be marked for extraction. The argument may be a wildcard specification, in which case all files that match in the current directory are marked to be restored. If the argument matches a directory rather than a file, then the directory and all the files contained in that directory + :index:`[TAG=Console->File Selection->mark] ` The mark command allows you to mark files to be restored. It takes a single argument which is the filename or directory name in the current directory to be marked for extraction. The argument may be a wildcard specification, in which case all files that match in the current directory are marked to be restored. If the argument matches a directory rather than a file, then the directory and all the files contained in that directory (recursively) are marked to be restored. Any marked file will have its name preceded with an asterisk () in the output produced by the ls or dir commands. Note, supplying a full path on the mark command does not work as expected to select a file or directory in the current directory. Also, the mark command works on the current and lower directories but does not touch higher level directories. After executing the mark command, it will print a brief summary: @@ -648,28 +648,28 @@ mark if some files are marked. unmark - :index:`[TAG=Console->File Selection->unmark] ` The unmark is identical to the mark command, except that it unmarks the specified file or files so that they will not be restored. Note: the unmark command works from the current directory, so it does not unmark any files at a higher level. First do a cd / before the unmark \* command if you want to unmark everything. + :index:`[TAG=Console->File Selection->unmark] ` The unmark is identical to the mark command, except that it unmarks the specified file or files so that they will not be restored. Note: the unmark command works from the current directory, so it does not unmark any files at a higher level. First do a cd / before the unmark \* command if you want to unmark everything. pwd - :index:`[TAG=Console->File Selection->pwd] ` The pwd command prints the current working directory. It accepts no arguments. + :index:`[TAG=Console->File Selection->pwd] ` The pwd command prints the current working directory. It accepts no arguments. count - :index:`[TAG=Console->File Selection->count] ` The count command prints the total files in the directory tree and the number of files marked to be restored. + :index:`[TAG=Console->File Selection->count] ` The count command prints the total files in the directory tree and the number of files marked to be restored. done - :index:`[TAG=Console->File Selection->done] ` This command terminates file selection mode. + :index:`[TAG=Console->File Selection->done] ` This command terminates file selection mode. exit - :index:`[TAG=Console->File Selection->exit] ` This command terminates file selection mode (the same as done). + :index:`[TAG=Console->File Selection->exit] ` This command terminates file selection mode (the same as done). quit - :index:`[TAG=Console->File Selection->quit] ` This command terminates the file selection and does not run the restore job. + :index:`[TAG=Console->File Selection->quit] ` This command terminates the file selection and does not run the restore job. help - :index:`[TAG=Console->File Selection->help] ` This command prints a summary of the commands available. + :index:`[TAG=Console->File Selection->help] ` This command prints a summary of the commands available. ? - :index:`[TAG=Console->File Selection->?] ` This command is the same as the help command. + :index:`[TAG=Console->File Selection->?] ` This command is the same as the help command. If your filename contains some weird caracters, you can use ``?``, ``*`` or \\\. For example, if your filename contains a \\, you can use \\\\\. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TheWindowsVersionOfBareos.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TheWindowsVersionOfBareos.rst index 982e0d9d541..3fcc7e6fdb8 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TheWindowsVersionOfBareos.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TheWindowsVersionOfBareos.rst @@ -7,7 +7,7 @@ The Windows Version of Bareos .. _section-windows: - :index:`[TAG=Platform->Windows] ` :index:`[TAG=Windows] ` + :index:`[TAG=Platform->Windows] ` :index:`[TAG=Windows] ` The Windows version of Bareos is a native Win32 port, but there are very few source code changes to the Unix code, which means that the Windows version is for the most part running code that has long proved stable on Unix systems. @@ -26,7 +26,7 @@ Windows Installation .. _Windows:Configuration:Files: - :index:`[TAG=Installation->Windows] ` :index:`[TAG=Windows->File Daemon->Installation] ` + :index:`[TAG=Installation->Windows] ` :index:`[TAG=Windows->File Daemon->Installation] ` Normally, you will install the Windows version of Bareos from the binaries. The **winbareos** binary packages are provided under http://download.bareos.org/bareos/release/latest/windows. Additionally, there are `OPSI `_ packages available under http://download.bareos.org/bareos/release/latest/windows/opsi. @@ -37,31 +37,31 @@ In addition, the Start\->All Programs\->Bareos menu item will be created during During installation you can decide, what Bareos components you want to install. -Typically, you only want to install the Bareos Client (|bareosFd|) and optionally some interface tools on a Windows system. Normally, we recommend to let the server components run on a Linux or other Unix system. However, it is possible, to run the |bareosDir|, |bareosSd| and |bareosWebui| on a Windows systems. You should be aware about following limitations: +Typically, you only want to install the Bareos Client (|fd|) and optionally some interface tools on a Windows system. Normally, we recommend to let the server components run on a Linux or other Unix system. However, it is possible, to run the |dir|, |sd| and |webui| on a Windows systems. You should be aware about following limitations: -.. limitation:: Windows: |bareosDir| does not support MySQL database backend. +.. limitation:: Windows: |dir| does not support MySQL database backend. - When running the |bareosDir| on Windows, only PostgreSQL (and SQLite) database backends are supported. + When running the |dir| on Windows, only PostgreSQL (and SQLite) database backends are supported. SQLite is best suited for test environments. -.. limitation:: Windows: |bareosSd| only support backup to disk, not to tape. +.. limitation:: Windows: |sd| only support backup to disk, not to tape. -.. limitation:: Windows: The default installation of |bareosWebui| is only suitable for local access. +.. limitation:: Windows: The default installation of |webui| is only suitable for local access. - Normally the |bareosWebui| is running on a Apache server on Linux. - While it is possible, to run the |bareosWebui| under Apache or another Webserver which supports PHP under Windows, + Normally the |webui| is running on a Apache server on Linux. + While it is possible, to run the |webui| under Apache or another Webserver which supports PHP under Windows, the configuration shipped the the **winbareos** package uses the PHP internal webserver. This is okay for local access, but not suitable for being accessed via the network. - To guarantee this, it is configured to only listen locally (``_). + To guarantee this, it is configured to only listen locally (http://localhost:9100). @@ -166,12 +166,12 @@ DBADMINUSER and DBADMINPASSWORD are used to create the bareos databases. If logi Dealing with Windows Problems ----------------------------- -:index:`[TAG=Problem->Windows] ` :index:`[TAG=Windows->Dealing with Problems] ` +:index:`[TAG=Problem->Windows] ` :index:`[TAG=Windows->Dealing with Problems] ` Antivirus Program ~~~~~~~~~~~~~~~~~ -If you are not using the portable option, and you have :config:option:`dir/fileset/EnableVss`\ (Volume Shadow Copy) enabled in the |bareosDir| and you experience problems with Bareos not being able to open files, it is most likely that you are running an antivirus program that blocks Bareos from doing certain operations. In this case, disable the antivirus program and try another backup. If it succeeds, either get a different (better) antivirus program or use +If you are not using the portable option, and you have :config:option:`dir/fileset/EnableVss`\ (Volume Shadow Copy) enabled in the |dir| and you experience problems with Bareos not being able to open files, it is most likely that you are running an antivirus program that blocks Bareos from doing certain operations. In this case, disable the antivirus program and try another backup. If it succeeds, either get a different (better) antivirus program or use something like :config:option:`dir/job/ClientRunBeforeJob`\ /:config:option:`dir/job/ClientRunBeforeJob`\ to turn off the antivirus program while the backup is running. If turning off anti-virus software does not resolve your VSS problems, you might have to turn on VSS debugging. The following link describes how to do this: http://support.microsoft.com/kb/887013/en-us. @@ -193,7 +193,7 @@ In case of problems, you can enable the creation of log files. For this you have Windows Compatibility Considerations ------------------------------------ -:index:`[TAG=Windows->Compatibility Considerations] ` +:index:`[TAG=Windows->Compatibility Considerations] ` Exclusively Opened Files ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -211,7 +211,7 @@ Windows Reparse Points :sinceVersion:`12.4.5: Windows: Reparse points` -:index:`[TAG=Windows->Symbolic links] ` :index:`[TAG=Windows->Junction points] ` :index:`[TAG=Windows->Volume Mount Points (VMP)] ` +:index:`[TAG=Windows->Symbolic links] ` :index:`[TAG=Windows->Junction points] ` :index:`[TAG=Windows->Volume Mount Points (VMP)] ` Besides normal files and directories, Windows filesystems also support special files, called "Reparse Points". Bareos can handle the following types of Reparse points: @@ -231,7 +231,7 @@ Symbolic Links and Junction Points can be created with the Windows commandline c When doing a directory listing in the commandline (cmd) in Windows, it shows the filetypes JUNCTION, SYMLINK or SYMLINKD and the target between the square brackets: -.. code-block:: sh +.. code-block:: shell-session :caption: special files C:\linktest>dir @@ -255,14 +255,14 @@ Volume Mount Points are different. They allow to mount a harddisk partition as a When backing up a Volume Mount Point, it is backed up as directory. -If :strong:`OneFS` is set to yes (default), the Volume Mount Point (VMP) is backed up as directory but the content of the VMP will not be backed up. Also, the Joblog will contain a message like this: +If :strong:`OneFS`\ is set to yes (default), the Volume Mount Point (VMP) is backed up as directory but the content of the VMP will not be backed up. Also, the Joblog will contain a message like this: .. code-block:: bareosmessage :caption: Warning on Volume Moint Point and OneFS=yes C:/linktest/vmp is a different filesystem. Will not descend from C:/linktest into it. -This is the normal behavior of the :strong:`OneFS` option. +This is the normal behavior of the :strong:`OneFS`\ option. If OneFS is set to no, the filedaemon will change into the VMP as if it was a normal directory and will backup all files found inside of the VMP. @@ -301,7 +301,7 @@ FilesNotToBackup Registry Key :sinceVersion:`14.2.0: Windows: FilesNotToBackup` -:index:`[TAG=Windows->Exclude Files from Backup] ` +:index:`[TAG=Windows->Exclude Files from Backup] ` Windows supports a special Registry Key that specifies the names of the files and directories that backup applications should not backup or restore. @@ -338,7 +338,7 @@ More details can be found if the filedaemon is run in debug mode inside of the : client-win-fd: win32.c:482-0 "C:\Windows\system32\MSDtc\trace\dtctrace.log" client-win-fd: win32.c:527-0 -> "C:/Windows/system32/MSDtc/trace/dtctrace.log" -It is possible to disable this functionality by setting the FileSet option :strong:`AutoExclude` to no. +It is possible to disable this functionality by setting the FileSet option :strong:`AutoExclude`\ to no. The JobLog will then show the following informational line: @@ -373,7 +373,7 @@ Windows has support for a so called EFS filesystem. This is an encrypted filesys Volume Shadow Copy Service (VSS) -------------------------------- -:index:`[TAG=Windows->Volume Shadow Copy Service] ` :index:`[TAG=Windows->VSS] ` +:index:`[TAG=Windows->Volume Shadow Copy Service] ` :index:`[TAG=Windows->VSS] ` .. _VSS: @@ -388,7 +388,7 @@ Technically Bareos creates a shadow copy as soon as the backup process starts. I VSS can be turned on by placing an -:index:`[TAG=Enable VSS] ` :index:`[TAG=VSS->Enable] ` +:index:`[TAG=Enable VSS] ` :index:`[TAG=VSS->Enable] ` :: @@ -438,7 +438,7 @@ In the above Job Report listing, you see that the VSS snapshot was generated for VSS Problems ~~~~~~~~~~~~ -:index:`[TAG=Windows->Problem->VSS] ` :index:`[TAG=Windows->VSS->Problem] ` :index:`[TAG=Windows->Problem->VSS] ` :index:`[TAG=Problem->Windows->VSS] ` +:index:`[TAG=Windows->Problem->VSS] ` :index:`[TAG=Windows->VSS->Problem] ` :index:`[TAG=Windows->Problem->VSS] ` :index:`[TAG=Problem->Windows->VSS] ` If you are experiencing problems such as VSS hanging on MSDE, first try running vssadmin to check for problems, then try running ntbackup which also uses VSS to see if it has similar problems. If so, you know that the problem is in your Windows machine and not with Bareos. @@ -451,30 +451,30 @@ The FD hang problems were reported with MSDEwriter when: Windows Firewalls ----------------- -:index:`[TAG=Firewall->Windows] ` :index:`[TAG=Windows->Firewall] ` +:index:`[TAG=Firewall->Windows] ` :index:`[TAG=Windows->Firewall] ` -The Windows buildin Firewall is enabled since Windows version WinXP SP2. The Bareos installer opens the required network ports for Bareos. However, if you are using another Firewall, you might need to manually open the Bareos network ports. The |bareosFd| listens on 9102/TCP. +The Windows buildin Firewall is enabled since Windows version WinXP SP2. The Bareos installer opens the required network ports for Bareos. However, if you are using another Firewall, you might need to manually open the Bareos network ports. The |fd| listens on 9102/TCP. Network TCP Port ~~~~~~~~~~~~~~~~ If you want to see if the File daemon has properly opened the port and is listening, you can enter the following command in a shell window: -.. code-block:: sh +.. code-block:: shell-session netstat -an | findstr 910[123] Windows Restore Problems ------------------------ -:index:`[TAG=Problem->Windows Restore] ` :index:`[TAG=Windows->Restore Problem] ` +:index:`[TAG=Problem->Windows Restore] ` :index:`[TAG=Windows->Restore Problem] ` Please see the :ref:`section-RestoreOnWindows` chapter for problems that you might encounter doing a restore. Windows Backup Problems ----------------------- -:index:`[TAG=Problem->Windows Backup] ` :index:`[TAG=Windows->Backup Problems] ` +:index:`[TAG=Problem->Windows Backup] ` :index:`[TAG=Windows->Backup Problems] ` If during a Backup, you get the message: ERR=Access is denied and you are using the portable option, you should try both adding both the non-portable (backup API) and the Volume Shadow Copy options to your Director’s conf file. @@ -505,7 +505,7 @@ Thanks to Georger Araujo for the above information. Windows Ownership and Permissions Problems ------------------------------------------ -:index:`[TAG=Problem->Windows Ownership and Permissions] ` :index:`[TAG=Windows->Ownership and Permissions Problems] ` +:index:`[TAG=Problem->Windows Ownership and Permissions] ` :index:`[TAG=Windows->Ownership and Permissions Problems] ` If you restore files backed up from Windows to an alternate directory, Bareos may need to create some higher level directories that were not saved (or restored). In this case, the File daemon will create them under the SYSTEM account because that is the account that Bareos runs under as a service and with full access permission. However, there may be cases where you have problems accessing those files even if you run as administrator. In principle, Microsoft supplies you with the way to cease the ownership of those files and thus change the permissions. However, a much better solution to working with and changing Win32 permissions is the program SetACL, which can be found at `http://setacl.sourceforge.net/ `_. @@ -522,7 +522,7 @@ Advanced Windows Configuration Windows Service ~~~~~~~~~~~~~~~ -The |bareosFd| (and also the |bareosDir| and |bareosSd|) is started as a Windows service. +The |fd| (and also the |dir| and |sd|) is started as a Windows service. This is configured in the Registry at @@ -553,35 +553,35 @@ After restarting the service, you will find a file called :file:`C:\bareos-fd.tr Installing multiple Windows filedaemon services ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -It is possible to run multiple |bareosFd| instances on Windows. To achieve this, you need to create a service for each instance, and a configuration file that at least has a individual fd port for each instance. +It is possible to run multiple |fd| instances on Windows. To achieve this, you need to create a service for each instance, and a configuration file that at least has a individual fd port for each instance. To create two bareos-fd services, you can call the following service create calls on the commandline on windows as administrator: -.. code-block:: sh +.. code-block:: shell-session sc create bareosfd2 binpath="\"C:\Program Files\Bareos\bareos-fd.exe\" /service -c \"C:\ProgramData\Bareos\bareos-fd2.conf\"" depend= "tcpip/afd" sc create bareosfd3 binpath="\"C:\Program Files\Bareos\bareos-fd.exe\" /service -c \"C:\ProgramData\Bareos\bareos-fd3.conf\"" depend= "tcpip/afd" -This will create two |bareosFd| services, one with the name bareosfd2 and the second with the name bareosfd3. +This will create two |fd| services, one with the name bareosfd2 and the second with the name bareosfd3. The configuration files for the two services are :file:`bareos-fd.conf` and :file:`bareos-fd2.conf`, and need to have different network settings. The services can be started by calling -.. code-block:: sh +.. code-block:: shell-session sc start bareosfd2 and -.. code-block:: sh +.. code-block:: shell-session sc start bareosfd3 Windows Specific Command Line Options ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Windows->File Daemon->Command Line Options] ` +:index:`[TAG=Windows->File Daemon->Command Line Options] ` These options are not normally seen or used by the user, and are documented here only for information purposes. At the current time, to change the default options, you must either manually run Bareos or you must manually edit the system registry and modify the appropriate entries. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TransportEncryption.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TransportEncryption.rst index 86d54baa22d..afe92e7c495 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TransportEncryption.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/TransportEncryption.rst @@ -7,7 +7,7 @@ Transport Encryption .. _section-TransportEncryption: - :index:`[TAG=Communications Encryption] ` :index:`[TAG=Encryption->Communication] ` :index:`[TAG=Encryption->Transport] ` :index:`[TAG=Transport Encryption] ` :index:`[TAG=TLS] ` :index:`[TAG=SSL] ` + :index:`[TAG=Communications Encryption] ` :index:`[TAG=Encryption->Communication] ` :index:`[TAG=Encryption->Transport] ` :index:`[TAG=Transport Encryption] ` :index:`[TAG=TLS] ` :index:`[TAG=SSL] ` Bareos TLS (Transport Layer Security) is built-in network encryption code to provide secure network transport similar to that offered by :command:`stunnel` or :command:`ssh`. The data written to Volumes by the Storage daemon is not encrypted by this code. For data encryption, please see the :ref:`DataEncryption` chapter. @@ -21,7 +21,7 @@ Supported features of this code include: - Forward Secrecy Support via Diffie-Hellman Ephemeral Keying -This document will refer to both ''server'' and ''client'' contexts. These terms refer to the accepting and initiating peer, respectively. +This document will refer to both "server" and "client" contexts. These terms refer to the accepting and initiating peer, respectively. Diffie-Hellman anonymous ciphers are not supported by this code. The use of DH anonymous ciphers increases the code complexity and places explicit trust upon the two-way CRAM-MD5 implementation. CRAM-MD5 is subject to known plaintext attacks, and it should be considered considerably less secure than PKI certificate-based authentication. @@ -33,42 +33,42 @@ TLS Configuration Directives Additional configuration directives have been added to all the daemons (Director, File daemon, and Storage daemon) as well as the various different Console programs. These directives are defined as follows: :config:option:`dir/director/TlsEnable`\ - Enable TLS support. Without setting :strong:`TLS Require`=yes, the connection can fall back to unencrypted connection, if the other side does not support TLS. + Enable TLS support. Without setting :strong:`TLS Require`\ =yes, the connection can fall back to unencrypted connection, if the other side does not support TLS. :config:option:`dir/director/TlsRequire`\ - Require TLS connections. If TLS is not required, then Bareos will connect with other daemons either with or without TLS depending on what the other daemon requests. If TLS is required, then Bareos will refuse any connection that does not use TLS. :strong:`TLS Require`=yes implicitly sets :strong:`TLS Enable`=yes. + Require TLS connections. If TLS is not required, then Bareos will connect with other daemons either with or without TLS depending on what the other daemon requests. If TLS is required, then Bareos will refuse any connection that does not use TLS. :strong:`TLS Require`\ =yes implicitly sets :strong:`TLS Enable`\ =yes. :config:option:`dir/director/TlsCertificate`\ The full path and filename of a PEM encoded TLS certificate. It can be used as either a client or server certificate. It is used because PEM files are base64 encoded and hence ASCII text based rather than binary. They may also contain encrypted information. :config:option:`dir/director/TlsKey`\ - The full path and filename of a PEM encoded TLS private key. It must correspond to the certificate specified in the :strong:`TLS Certificate` configuration directive. + The full path and filename of a PEM encoded TLS private key. It must correspond to the certificate specified in the :strong:`TLS Certificate`\ configuration directive. :config:option:`dir/director/TlsVerifyPeer`\ Request and verify the peers certificate. - In server context, unless the :strong:`TLS Allowed CN` configuration directive is specified, any client certificate signed by a known-CA will be accepted. + In server context, unless the :strong:`TLS Allowed CN`\ configuration directive is specified, any client certificate signed by a known-CA will be accepted. - In client context, the server certificate CommonName attribute is checked against the :strong:`Address` and :strong:`TLS Allowed CN` configuration directives. + In client context, the server certificate CommonName attribute is checked against the :strong:`Address`\ and :strong:`TLS Allowed CN`\ configuration directives. :config:option:`dir/director/TlsAllowedCn`\ - Common name attribute of allowed peer certificates. If :strong:`TLS Verify Peer`=yes, all connection request certificates will be checked against this list. + Common name attribute of allowed peer certificates. If :strong:`TLS Verify Peer`\ =yes, all connection request certificates will be checked against this list. This directive may be specified more than once. :config:option:`dir/director/TlsCaCertificateFile`\ The full path and filename specifying a PEM encoded TLS CA certificate(s). Multiple certificates are permitted in the file. - In a client context, one of :strong:`TLS CA Certificate File` or :strong:`TLS CA Certificate Dir` is required. + In a client context, one of :strong:`TLS CA Certificate File`\ or :strong:`TLS CA Certificate Dir`\ is required. - In a server context, it is only required if :strong:`TLS Verify Peer` is used. + In a server context, it is only required if :strong:`TLS Verify Peer`\ is used. :config:option:`dir/director/TlsCaCertificateDir`\ Full path to TLS CA certificate directory. In the current implementation, certificates must be stored PEM encoded with OpenSSL-compatible hashes, which is the subject name’s hash and an extension of .0. - In a client context, one of :strong:`TLS CA Certificate File` or :strong:`TLS CA Certificate Dir` is required. + In a client context, one of :strong:`TLS CA Certificate File`\ or :strong:`TLS CA Certificate Dir`\ is required. - In a server context, it is only required if :strong:`TLS Verify Peer` is used. + In a server context, it is only required if :strong:`TLS Verify Peer`\ is used. :config:option:`dir/director/TlsDhFile`\ Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. DH key exchange adds an additional level of security because the key used for encryption/decryption by the server and the client is computed on each end and thus is never passed over the network if Diffie-Hellman key exchange is used. Even if DH key exchange is not used, the encryption/decryption key is always @@ -76,7 +76,7 @@ Additional configuration directives have been added to all the daemons (Director To generate the parameter file, you may use openssl: - .. code-block:: sh + .. code-block:: shell-session :caption: create DH key openssl dhparam -out dh1024.pem -5 1024 @@ -93,11 +93,11 @@ You can use programs like `xca `_ or TinyCA to easi Example TLS Configuration Files ------------------------------- -:index:`[TAG=Example->TLS Configuration Files] ` :index:`[TAG=TLS Configuration Files] ` +:index:`[TAG=Example->TLS Configuration Files] ` :index:`[TAG=TLS Configuration Files] ` An example of the TLS portions of the configuration files are listed below. -Another example can be found at `Bareos Regression Testing Base Configuration `_. +Another example can be found at `Bareos Regression Testing Base Configuration `_. Bareos Director ~~~~~~~~~~~~~~~ diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/UsingTapeDrivesWithoutAutochanger.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/UsingTapeDrivesWithoutAutochanger.rst index 5fde7231e3d..fdecff9930f 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/UsingTapeDrivesWithoutAutochanger.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/UsingTapeDrivesWithoutAutochanger.rst @@ -3,7 +3,7 @@ Using Tape Drives without Autochanger ===================================== -:index:`[TAG=Strategy->Backup] ` :index:`[TAG=Backup Strategies] ` +:index:`[TAG=Strategy->Backup] ` :index:`[TAG=Backup Strategies] ` Although Recycling and Backing Up to Disk Volume have been discussed in previous chapters, this chapter is meant to give you an overall view of possible backup strategies and to explain their advantages and disadvantages. @@ -14,7 +14,7 @@ Although Recycling and Backing Up to Disk Volume have been discussed in previous Simple One Tape Backup ---------------------- -:index:`[TAG=Backup->One Tape] ` :index:`[TAG=One Tape Backup] ` +:index:`[TAG=Backup->One Tape] ` :index:`[TAG=One Tape Backup] ` Probably the simplest strategy is to back everything up to a single tape and insert a new (or recycled) tape when it fills and Bareos requests a new one. @@ -50,13 +50,13 @@ Using this strategy, one typically does a Full backup once a week followed by da Manually Changing Tapes ----------------------- -:index:`[TAG=Tape->Manually Changing] ` +:index:`[TAG=Tape->Manually Changing] ` If you use the strategy presented above, Bareos will ask you to change the tape, and you will unmount it and then remount it when you have inserted the new tape. If you do not wish to interact with Bareos to change each tape, there are several ways to get Bareos to release the tape: -- In your Storage daemon’s Device resource, set :strong:`AlwaysOpen = no`. In this case, Bareos will release the tape after every job. If you run several jobs, the tape will be rewound and repositioned to the end at the beginning of every job. This is not very efficient, but does let you change the tape whenever you want. +- In your Storage daemon’s Device resource, set :strong:`AlwaysOpen = no`\ . In this case, Bareos will release the tape after every job. If you run several jobs, the tape will be rewound and repositioned to the end at the beginning of every job. This is not very efficient, but does let you change the tape whenever you want. - Use a RunAfterJob statement to run a script after your last job. This could also be an Admin job that runs after all your backup jobs. The script could be something like: @@ -102,7 +102,7 @@ If you do not wish to interact with Bareos to change each tape, there are severa Daily Tape Rotation ------------------- -:index:`[TAG=Rotation->Daily Tape] ` :index:`[TAG=Daily Tape Rotation] ` +:index:`[TAG=Rotation->Daily Tape] ` :index:`[TAG=Daily Tape Rotation] ` This scheme is quite different from the one mentioned above in that a Full backup is done to a different tape every day of the week. Generally, the backup will cycle continuously through five or six tapes each week. Variations are to use a different tape each Friday, and possibly at the beginning of the month. Thus if backups are done Monday through Friday only, you need only five tapes, and by having two Friday tapes, you need a total of six tapes. Many sites run this way, or using modifications of it based on two week cycles or longer. diff --git a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/VolumeManagement.rst b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/VolumeManagement.rst index 4f5d0a806ab..e6e0ea7a1e9 100644 --- a/docs/manuals/en/new_main_reference/source/TasksAndConcepts/VolumeManagement.rst +++ b/docs/manuals/en/new_main_reference/source/TasksAndConcepts/VolumeManagement.rst @@ -3,7 +3,7 @@ Volume Management ================= -:index:`[TAG=Volume->Management] ` :index:`[TAG=Disk Volumes] ` +:index:`[TAG=Volume->Management] ` :index:`[TAG=Disk Volumes] ` This chapter presents most all the features needed to do Volume management. Most of the concepts apply equally well to both tape and disk Volumes. However, the chapter was originally written to explain backing up to disk, so you will see it is slanted in that direction, but all the directives presented here apply equally well whether your volume is disk or tape. @@ -12,7 +12,7 @@ If you have a lot of hard disk storage or you absolutely must have your backups Key Concepts and Resource Records --------------------------------- -:index:`[TAG=Volume->Management->Key Concepts and Resource Records] ` +:index:`[TAG=Volume->Management->Key Concepts and Resource Records] ` Getting Bareos to write to disk rather than tape in the simplest case is rather easy. In the Storage daemon’s configuration file, you simply define an :config:option:`sd/device/ArchiveDevice`\ to be a directory. The default directory to store backups on disk is :file:`/var/lib/bareos/storage`: @@ -32,7 +32,7 @@ Getting Bareos to write to disk rather than tape in the simplest case is rather -Assuming you have the appropriate :strong:`Storage` resource in your Director’s configuration file that references the above Device resource, +Assuming you have the appropriate :config:option:`Dir/Storage`\ resource in your Director’s configuration file that references the above Device resource, @@ -58,7 +58,7 @@ In addition, if you want to use concurrent jobs that write to several different Pool Options to Limit the Volume Usage ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Pool->Options to Limit the Volume Usage] ` +:index:`[TAG=Pool->Options to Limit the Volume Usage] ` Some of the options you have, all of which are specified in the Pool record, are: @@ -91,7 +91,7 @@ then if you run a backup once a day (every 24 hours), Bareos will use a new Volu Automatic Volume Labeling ~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Label->Automatic Volume Labeling] ` :index:`[TAG=Volume->Labeling->Automatic] ` +:index:`[TAG=Label->Automatic Volume Labeling] ` :index:`[TAG=Volume->Labeling->Automatic] ` Use of the above records brings up another problem – that of labeling your Volumes. For automated disk backup, you can either manually label each of your Volumes, or you can have Bareos automatically label new Volumes when they are needed. @@ -112,7 +112,7 @@ contains. Thus if you modify your Pool resource to be: Bareos will create Volume names Vol0001, Vol0002, and so on when new Volumes are needed. Much more complex and elaborate labels can be created using variable expansion defined in the :ref:`Variable Expansion ` chapter of this manual. -The second change that is necessary to make automatic labeling work is to give the Storage daemon permission to automatically label Volumes. Do so by adding :config:option:`sd/device/LabelMedia`\ = yes to the :strong:`Device` resource as follows: +The second change that is necessary to make automatic labeling work is to give the Storage daemon permission to automatically label Volumes. Do so by adding :config:option:`sd/device/LabelMedia`\ = yes to the :config:option:`Sd/Device`\ resource as follows: .. code-block:: bareosconfig :caption: Label Media = yes @@ -133,7 +133,7 @@ See :config:option:`dir/pool/LabelFormat`\ for details about the labeling forma Restricting the Number of Volumes and Recycling ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Recycling->Restricting the Number of Volumes and Recycling] ` :index:`[TAG=Restricting the Number of Volumes and Recycling] ` +:index:`[TAG=Recycling->Restricting the Number of Volumes and Recycling] ` :index:`[TAG=Restricting the Number of Volumes and Recycling] ` Automatic labeling discussed above brings up the problem of Volume management. With the above scheme, a new Volume will be created every day. If you have not specified Retention periods, your Catalog will continue to fill keeping track of all the files Bareos has backed up, and this procedure will create one new archive file (Volume) every day. @@ -160,8 +160,9 @@ The tools Bareos gives you to help automatically manage these problems are the f - | :config:option:`dir/pool/PurgeOldestVolume`\ = yes: permits a forced recycling of the oldest Volume when a new one is needed. | - .. warning:: - This record ignores retention periods! We highly +.. warning:: + + This record ignores retention periods! We highly recommend not to use this record, but instead use :config:option:`dir/pool/RecycleOldestVolume`\ . - :config:option:`dir/pool/MaximumVolumes`\ : limit the number of Volumes that can be created. @@ -183,11 +184,11 @@ Concurrent Disk Jobs Above, we discussed how you could have a single device named :config:option:`Sd/Device = FileBackup`\ that writes to volumes in :file:`/var/lib/bareos/storage/`. You can, in fact, run multiple concurrent jobs using the Storage definition given with this example, and all the jobs will simultaneously write into the Volume that is being written. Now suppose you want to use multiple Pools, which means multiple Volumes, or suppose you want each client to have its own Volume and perhaps its own directory such as /home/bareos/client1 and /home/bareos/client2 ... . With the single Storage and Device definition above, neither of these two is possible. Why? Because Bareos disk storage follows the same rules as tape devices. Only one Volume can be mounted on any Device at any time. If you want to simultaneously write multiple Volumes, you will -need multiple Device resources in your |bareosSd| configuration and thus multiple Storage resources in your |bareosDir| configuration. +need multiple Device resources in your |sd| configuration and thus multiple Storage resources in your |dir| configuration. Okay, so now you should understand that you need multiple Device definitions in the case of different directories or different Pools, but you also need to know that the catalog data that Bareos keeps contains only the Media Type and not the specific storage device. This permits a tape for example to be re-read on any compatible tape drive. The compatibility being determined by the Media Type (:config:option:`dir/storage/MediaType`\ and :config:option:`sd/device/MediaType`\ ). The same applies to disk storage. Since a volume that is written by a Device in say directory :file:`/home/bareos/backups` cannot be read by a Device with an :config:option:`sd/device/ArchiveDevice`\ = :file:`/home/bareos/client1`, you will not be able to restore all your files if you give both those devices :config:option:`sd/device/MediaType`\ = File. During the restore, Bareos will -simply choose the first available device, which may not be the correct one. If this is confusing, just remember that the Directory has only the Media Type and the Volume name. It does not know the :config:option:`sd/device/ArchiveDevice`\ (or the full path) that is specified in the |bareosSd|. Thus you must explicitly tie your Volumes to the correct Device by using the Media Type. +simply choose the first available device, which may not be the correct one. If this is confusing, just remember that the Directory has only the Media Type and the Volume name. It does not know the :config:option:`sd/device/ArchiveDevice`\ (or the full path) that is specified in the |sd|. Thus you must explicitly tie your Volumes to the correct Device by using the Media Type. Example for two clients, separate devices and recycling ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -196,9 +197,9 @@ The following example is not very practical, but can be used to demonstrate the The example consists of a two clients that are backed up to a set of 12 Volumes for each client into different directories on the Storage machine. Each Volume is used (written) only once, and there are four Full saves done every hour (so the whole thing cycles around after three hours). -What is key here is that each physical device on the |bareosSd| has a different Media Type. This allows the Director to choose the correct device for restores. +What is key here is that each physical device on the |sd| has a different Media Type. This allows the Director to choose the correct device for restores. -The |bareosDir| configuration is as follows: +The |dir| configuration is as follows: .. code-block:: bareosconfig @@ -311,7 +312,7 @@ The |bareosDir| configuration is as follows: Recycle = yes } -and the |bareosSd| configuration is: +and the |sd| configuration is: .. code-block:: bareosconfig @@ -359,7 +360,7 @@ With a little bit of work, you can change the above example into a weekly or mon Using Multiple Storage Devices ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Multiple Storage Devices] ` :index:`[TAG=Storage Device->Multiple] ` +:index:`[TAG=Multiple Storage Devices] ` :index:`[TAG=Storage Device->Multiple] ` Bareos treats disk volumes similar to tape volumes as much as it can. This means that you can only have a single Volume mounted at one time on a disk as defined in your :config:option:`Sd/Device`\ resource. @@ -375,7 +376,7 @@ Example: use four storage devices pointing to the same directory ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bareosconfig - :caption: |bareosDir| configuration: using 4 storage devices + :caption: |dir| configuration: using 4 storage devices Director { Name = bareos-dir.example.com @@ -400,7 +401,7 @@ Example: use four storage devices pointing to the same directory [...] .. code-block:: bareosconfig - :caption: |bareosSd| configuraton: using 4 storage devices + :caption: |sd| configuraton: using 4 storage devices Storage { Name = bareos-sd.example.com @@ -468,7 +469,7 @@ Example: use four storage devices pointing to the same directory Automatic Volume Recycling -------------------------- -:index:`[TAG=Recycle->Automatic Volume] ` :index:`[TAG=Volume->Recycle->Automatic] ` +:index:`[TAG=Recycle->Automatic Volume] ` :index:`[TAG=Volume->Recycle->Automatic] ` By default, once Bareos starts writing a Volume, it can append to the volume, but it will not overwrite the existing data thus destroying it. However when Bareos recycles a Volume, the Volume becomes available for being reused and Bareos can at some later time overwrite the previous contents of that Volume. Thus all previous data will be lost. If the Volume is a tape, the tape will be rewritten from the beginning. If the Volume is a disk file, the file will be truncated before being rewritten. @@ -520,7 +521,7 @@ Only Volumes marked **Full** or **Used** will be considerd for pruning. The Volu Until recycling actually occurs, the Volume data remains intact. If no Volumes can be found for recycling for any of the reasons stated above, Bareos will request operator intervention (i.e. it will ask you to label a new volume). -A key point mentioned above, that can be a source of frustration, is that Bareos will only recycle purged Volumes if there is no other appendable Volume available. Otherwise, it will always write to an appendable Volume before recycling even if there are Volume marked as Purged. This preserves your data as long as possible. So, if you wish to ''force'' Bareos to use a purged Volume, you must first ensure that no other Volume in the Pool is marked Append. If necessary, you can +A key point mentioned above, that can be a source of frustration, is that Bareos will only recycle purged Volumes if there is no other appendable Volume available. Otherwise, it will always write to an appendable Volume before recycling even if there are Volume marked as Purged. This preserves your data as long as possible. So, if you wish to "force" Bareos to use a purged Volume, you must first ensure that no other Volume in the Pool is marked Append. If necessary, you can manually set a volume to Full. The reason for this is that Bareos wants to preserve the data on your old tapes (even though purged from the catalog) as long as absolutely possible before overwriting it. There are also a number of directives such as **Volume Use Duration** that will automatically mark a volume as **Used** and thus no longer appendable. .. _AutoPruning: @@ -528,7 +529,7 @@ manually set a volume to Full. The reason for this is that Bareos wants to prese Automatic Pruning ~~~~~~~~~~~~~~~~~ -:index:`[TAG=Automatic->Pruning] ` :index:`[TAG=Pruning->Automatic] ` +:index:`[TAG=Automatic->Pruning] ` :index:`[TAG=Pruning->Automatic] ` As Bareos writes files to tape, it keeps a list of files, jobs, and volumes in a database called the catalog. Among other things, the database helps Bareos to decide which files to back up in an incremental or differential backup, and helps you locate files on past backups when you want to restore something. However, the catalog will grow larger and larger as time goes on, and eventually it can become unacceptably large. @@ -541,7 +542,7 @@ The alternative to Automatic Pruning is Manual Pruning, in which you explicitly Pruning Directives ~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Pruning->Directives] ` +:index:`[TAG=Pruning->Directives] ` There are three pruning durations. All apply to catalog database records and not to the actual data in a Volume. The pruning (or retention) durations are for: Volumes (Media records), Jobs (Job records), and Files (File records). The durations inter-depend because if Bareos prunes a Volume, it automatically removes all the Job records, and all the File records. Also when a Job record is pruned, all the File records for that Job are also pruned (deleted) from the catalog. @@ -551,7 +552,7 @@ When a Job record is pruned, the Volume (Media record) for that Job can still re In each case, pruning removes information about where older files are, but it also prevents the catalog from growing to be too large. You choose the retention periods in function of how many files you are backing up and the time periods you want to keep those records online, and the size of the database. It is possible to re-insert the records (with 98% of the original data) by using :command:`bscan` to scan in a whole Volume or any part of the volume that you want. -By setting :config:option:`dir/pool/AutoPrune`\ = yes you will permit the |bareosDir| to automatically prune all Volumes in the Pool when a Job needs another Volume. Volume pruning means removing records from the catalog. It does not shrink the size of the Volume or affect the Volume data until the Volume gets overwritten. When a Job requests another volume and there are no Volumes with Volume status **Append** available, Bareos will +By setting :config:option:`dir/pool/AutoPrune`\ = yes you will permit the |dir| to automatically prune all Volumes in the Pool when a Job needs another Volume. Volume pruning means removing records from the catalog. It does not shrink the size of the Volume or affect the Volume data until the Volume gets overwritten. When a Job requests another volume and there are no Volumes with Volume status **Append** available, Bareos will begin volume pruning. This means that all Jobs that are older than the **Volume Retention** period will be pruned from every Volume that has Volume status **Full** or **Used** and has **Recycle = yes**. Pruning consists of deleting the corresponding Job, File, and JobMedia records from the catalog database. No change to the physical data on the Volume occurs during the pruning process. When all files are pruned from a Volume (i.e. no records in the catalog), the Volume will be marked as **Purged** implying that no Jobs remain on the volume. The Pool records that control the pruning are described below. @@ -574,13 +575,13 @@ files are pruned from a Volume (i.e. no records in the catalog), the Volume will When all file catalog entries are removed from the volume, its Volume status is set to **Purged**. The files remain physically on the Volume until the volume is overwritten. :config:option:`dir/pool/Recycle`\ - defines whether or not the particular Volume can be recycled (i.e. rewritten). If Recycle is set to ``no``, then even if Bareos prunes all the Jobs on the volume and it is marked **Purged**, it will not consider the tape for recycling. If Recycle is set to ``yes`` and all Jobs have been pruned, the volume status will be set to **Purged** and the volume may then be reused when another volume is needed. If + defines whether or not the particular Volume can be recycled (i.e. rewritten). If Recycle is set to :strong:`no`, then even if Bareos prunes all the Jobs on the volume and it is marked **Purged**, it will not consider the tape for recycling. If Recycle is set to :strong:`yes` and all Jobs have been pruned, the volume status will be set to **Purged** and the volume may then be reused when another volume is needed. If the volume is reused, it is relabeled with the same Volume Name, however all previous data will be lost. Recycling Algorithm ~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Algorithm->Recycling] ` :index:`[TAG=Recycle->Algorithm] ` +:index:`[TAG=Algorithm->Recycling] ` :index:`[TAG=Recycle->Algorithm] ` .. _RecyclingAlgorithm: @@ -595,9 +596,9 @@ After all Volumes of a Pool have been pruned (as mentioned above, this happens w As mentioned above, there are two key points for getting a Volume to be recycled. First, the Volume must no longer be marked **Append** (there are a number of directives to automatically make this change), and second since the last write on the Volume, one or more of the Retention periods must have expired so that there are no more catalog backup job records that reference that Volume. Once both those conditions are satisfied, the volume can be marked **Purged** and hence recycled. -The full algorithm that Bareos uses when it needs a new Volume is: :index:`[TAG=New Volume Algorithm] ` :index:`[TAG=Algorithm->New Volume] ` +The full algorithm that Bareos uses when it needs a new Volume is: :index:`[TAG=New Volume Algorithm] ` :index:`[TAG=Algorithm->New Volume] ` -The algorithm described below assumes that :strong:`Auto Prune` is enabled, that Recycling is turned on, and that you have defined appropriate Retention periods or used the defaults for all these items. +The algorithm described below assumes that :strong:`Auto Prune`\ is enabled, that Recycling is turned on, and that you have defined appropriate Retention periods or used the defaults for all these items. #. If the request is for an Autochanger device, look only for Volumes in the Autochanger (i.e. with InChanger set and that have the correct Storage device). @@ -621,8 +622,9 @@ The algorithm described below assumes that :strong:`Auto Prune` is enabled, that #. Purge the oldest Volume if :config:option:`dir/pool/PurgeOldestVolume`\ =yes (the Volume with the oldest LastWritten date and VolStatus equal to Full, Recycle, Purged, Used, or Append is chosen). - .. warning:: - We strongly recommend against the use of :strong:`Purge Oldest Volume` as it can quite easily lead to loss of current backup +.. warning:: + + We strongly recommend against the use of :strong:`Purge Oldest Volume`\ as it can quite easily lead to loss of current backup data. #. Give up and ask operator. @@ -819,7 +821,7 @@ What would the Bareos configuration look like to implement such a scheme? Automatic Pruning and Recycling Example ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Automatic->Pruning and Recycling Example] ` :index:`[TAG=Example->Automatic Pruning and Recycling] ` :index:`[TAG=Pruning->Automatic->Example] ` :index:`[TAG=Recycle->Automatic->Example] ` +:index:`[TAG=Automatic->Pruning and Recycling Example] ` :index:`[TAG=Example->Automatic Pruning and Recycling] ` :index:`[TAG=Pruning->Automatic->Example] ` :index:`[TAG=Recycle->Automatic->Example] ` Perhaps the best way to understand the various resource records that come into play during automatic pruning and recycling is to run a Job that goes through the whole cycle. If you add the following resources to your Director’s configuration file: @@ -907,7 +909,7 @@ To turn it off, either delete all the resources you’ve added, or simply commen Manually Recycling Volumes ~~~~~~~~~~~~~~~~~~~~~~~~~~ -:index:`[TAG=Volume->Recycle->Manual] ` :index:`[TAG=Recycle->Manual] ` +:index:`[TAG=Volume->Recycle->Manual] ` :index:`[TAG=Recycle->Manual] ` Although automatic recycling of Volumes is implemented (see the :ref:`RecyclingChapter` chapter of this manual), you may want to manually force reuse (recycling) of a Volume. @@ -923,8 +925,9 @@ If you wish to reuse the tape by giving it a new name, use the :bcommand:`relabe -.. warning:: - The :bcommand:`delete` command can be dangerous. Once it is + .. warning:: + + The :bcommand:`delete` command can be dangerous. Once it is done, to recover the File records, you must either restore your database as it was before the :bcommand:`delete` command or use the :ref:`bscan` utility program to scan the tape and recreate the database entries. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/console-console-HistoryLength.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/console-console-HistoryLength.rst.inc index a3ab1adccaf..6d7b389e3ba 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/console-console-HistoryLength.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/console-console-HistoryLength.rst.inc @@ -1,2 +1,2 @@ -If this directive is specified the history file will be truncated after :strong:`HistoryLength` entries. +If this directive is specified the history file will be truncated after :strong:`HistoryLength`\ entries. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/console-director-Password.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/console-director-Password.rst.inc index 268eb3934df..dfa4b9c6271 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/console-director-Password.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/console-director-Password.rst.inc @@ -1,2 +1,2 @@ -This password is used to authenticate when connecting to the |bareosDir| as default console. It must correspond to :config:option:`dir/director/Password`\ . +This password is used to authenticate when connecting to the |dir| as default console. It must correspond to :config:option:`dir/director/Password`\ . diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-catalog-DisableBatchInsert.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-catalog-DisableBatchInsert.rst.inc index 939402d9b7a..a26a955bd23 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-catalog-DisableBatchInsert.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-catalog-DisableBatchInsert.rst.inc @@ -1,2 +1,2 @@ -This directive allows you to override at runtime if the Batch insert should be enabled or disabled. Normally this is determined by querying the database library if it is thread-safe. If you think that disabling Batch insert will make your backup run faster you may disable it using this option and set it to ``Yes``. +This directive allows you to override at runtime if the Batch insert should be enabled or disabled. Normally this is determined by querying the database library if it is thread-safe. If you think that disabling Batch insert will make your backup run faster you may disable it using this option and set it to :strong:`Yes`. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-FdPort.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-FdPort.rst.inc index 2d13625a683..544c74443d2 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-FdPort.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-FdPort.rst.inc @@ -1,2 +1,2 @@ -Where the port is a port number at which the |bareosFd| can be contacted. The default is 9102. For NDMP backups set this to 10000. +Where the port is a port number at which the |fd| can be contacted. The default is 9102. For NDMP backups set this to 10000. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-FileRetention.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-FileRetention.rst.inc index 0807bfd8f41..45e3e8a3737 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-FileRetention.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-FileRetention.rst.inc @@ -1,4 +1,4 @@ -The File Retention directive defines the length of time that Bareos will keep File records in the Catalog database after the End time of the Job corresponding to the File records. When this time period expires and \resourceDirectiveValue{Dir}{Client}{Auto Prune}{yes}, Bareos will prune (remove) File records that are older than the specified File Retention period. Note, this affects only records in the catalog database. It does not affect your archive backups. +The File Retention directive defines the length of time that Bareos will keep File records in the Catalog database after the End time of the Job corresponding to the File records. When this time period expires and :config:option:`dir/client/AutoPrune = yes`\ , Bareos will prune (remove) File records that are older than the specified File Retention period. Note, this affects only records in the catalog database. It does not affect your archive backups. File records may actually be retained for a shorter period than you specify on this directive if you specify either a shorter :config:option:`dir/client/JobRetention`\ or a shorter :config:option:`dir/pool/VolumeRetention`\ period. The shortest retention period of the three takes precedence. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-JobRetention.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-JobRetention.rst.inc index d3049476588..021a147be90 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-JobRetention.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-JobRetention.rst.inc @@ -1,4 +1,4 @@ -The Job Retention directive defines the length of time that Bareos will keep Job records in the Catalog database after the Job End time. When this time period expires and \resourceDirectiveValue{Dir}{Client}{Auto Prune}{yes} Bareos will prune (remove) Job records that are older than the specified File Retention period. As with the other retention periods, this affects only records in the catalog and not data in your archive backup. +The Job Retention directive defines the length of time that Bareos will keep Job records in the Catalog database after the Job End time. When this time period expires and :config:option:`dir/client/AutoPrune = yes`\ Bareos will prune (remove) Job records that are older than the specified File Retention period. As with the other retention periods, this affects only records in the catalog and not data in your archive backup. If a Job record is selected for pruning, all associated File and JobMedia records will also be pruned regardless of the File Retention period set. As a consequence, you normally will set the File retention period to be less than the Job retention period. The Job retention period can actually be less than the value you specify here if you set the :config:option:`dir/pool/Volume Retention`\ directive to a smaller duration. This is because the Job retention period and the Volume retention period are independently applied, so the smaller of the two takes precedence. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-LanAddress.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-LanAddress.rst.inc index 84da0c36892..1b69aa1f061 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-LanAddress.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-LanAddress.rst.inc @@ -1,4 +1,4 @@ -This directive might be useful in network setups where the |bareosDir| and |bareosSd| need different addresses to communicate with the |bareosFd|. +This directive might be useful in network setups where the |dir| and |sd| need different addresses to communicate with the |fd|. For details, see :ref:`LanAddress`. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-SoftQuotaGracePeriod.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-SoftQuotaGracePeriod.rst.inc index e4f12bc5394..8fe420d5a6a 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-SoftQuotaGracePeriod.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-client-SoftQuotaGracePeriod.rst.inc @@ -9,7 +9,7 @@ When the amount of data backed up by the client outruns the value specified by t -In the Job Overview, the value of Grace Expiry Date: will then change from ``Soft Quota was never exceeded`` to the date when the grace time expires, e.g. ``11-Dec-2012 04:09:05``. +In the Job Overview, the value of Grace Expiry Date: will then change from :strong:`Soft Quota was never exceeded` to the date when the grace time expires, e.g. :strong:`11-Dec-2012 04:09:05`. During that period, it is possible to do backups even if the total amount of stored data exceeds the limit specified by soft quota. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-console-JobAcl.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-console-JobAcl.rst.inc index 6f8b50ac2b1..d1fdc1fa8f9 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-console-JobAcl.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-console-JobAcl.rst.inc @@ -1,8 +1,8 @@ -This directive is used to specify a list of Job resource names that can be accessed by the console. Without this directive, the console cannot access any of the Director’s Job resources. Multiple Job resource names may be specified by separating them with commas, and/or by specifying multiple :strong:`Job ACL` directives. For example, the directive may be specified as: +This directive is used to specify a list of Job resource names that can be accessed by the console. Without this directive, the console cannot access any of the Director’s Job resources. Multiple Job resource names may be specified by separating them with commas, and/or by specifying multiple :strong:`Job ACL`\ directives. For example, the directive may be specified as: .. literalinclude:: /include/config/DirConsoleJobACL1.conf :language: bareosconfig With the above specification, the console can -access the Director’s resources for the jobs named on the :strong:`Job ACL` directives, but for no others. +access the Director’s resources for the jobs named on the :strong:`Job ACL`\ directives, but for no others. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-console-WhereAcl.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-console-WhereAcl.rst.inc index c381ca1d614..2310f5e0bea 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-console-WhereAcl.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-console-WhereAcl.rst.inc @@ -1,3 +1,3 @@ -This directive permits you to specify where a restricted console can restore files. If this directive is not specified, only the default restore location is permitted (normally :file:`/tmp/bareos-restores`. If :strong:`*all*` is specified any path the user enters will be accepted. Any other value specified (there may be multiple :strong:`Where ACL` directives) will restrict the user to use that path. For example, on a Unix system, if you specify +This directive permits you to specify where a restricted console can restore files. If this directive is not specified, only the default restore location is permitted (normally :file:`/tmp/bareos-restores`. If :strong:`*all*` is specified any path the user enters will be accepted. Any other value specified (there may be multiple :strong:`Where ACL`\ directives) will restrict the user to use that path. For example, on a Unix system, if you specify "/", the file will be restored to the original location. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-FdConnectTimeout.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-FdConnectTimeout.rst.inc index a7c09671e1b..e4ed1e18cab 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-FdConnectTimeout.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-FdConnectTimeout.rst.inc @@ -1,2 +1,2 @@ -where ``time`` is the time that the Director should continue attempting to contact the File daemon to start a job, and after which the Director will cancel the job. +where :strong:`time` is the time that the Director should continue attempting to contact the File daemon to start a job, and after which the Director will cancel the job. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-OptimizeForSize.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-OptimizeForSize.rst.inc index 52aeb3445d5..42372b1024a 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-OptimizeForSize.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-OptimizeForSize.rst.inc @@ -1,4 +1,4 @@ -If set to ``yes`` this directive will use the optimizations for memory size over speed. So it will try to use less memory which may lead to a somewhat lower speed. Its currently mostly used for keeping all hardlinks in memory. +If set to :strong:`yes` this directive will use the optimizations for memory size over speed. So it will try to use less memory which may lead to a somewhat lower speed. Its currently mostly used for keeping all hardlinks in memory. If none of :config:option:`dir/director/OptimizeForSize`\ and :config:option:`dir/director/OptimizeForSpeed`\ is enabled, :config:option:`dir/director/OptimizeForSize`\ is enabled by default. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-OptimizeForSpeed.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-OptimizeForSpeed.rst.inc index dcc7a00f766..b2987036e3b 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-OptimizeForSpeed.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-OptimizeForSpeed.rst.inc @@ -1,2 +1,2 @@ -If set to ``yes`` this directive will use the optimizations for speed over the memory size. So it will try to use more memory which lead to a somewhat higher speed. Its currently mostly used for keeping all hardlinks in memory. Its relates to the :config:option:`dir/director/OptimizeForSize`\ option set either one to ``yes`` as they are mutually exclusive. +If set to :strong:`yes` this directive will use the optimizations for speed over the memory size. So it will try to use more memory which lead to a somewhat higher speed. Its currently mostly used for keeping all hardlinks in memory. Its relates to the :config:option:`dir/director/OptimizeForSize`\ option set either one to :strong:`yes` as they are mutually exclusive. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-SdConnectTimeout.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-SdConnectTimeout.rst.inc index 7f99b79e433..81652f74749 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-SdConnectTimeout.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-SdConnectTimeout.rst.inc @@ -1,2 +1,2 @@ -where ``time`` is the time that the Director should continue attempting to contact the Storage daemon to start a job, and after which the Director will cancel the job. +where :strong:`time` is the time that the Director should continue attempting to contact the Storage daemon to start a job, and after which the Director will cancel the job. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-StatisticsRetention.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-StatisticsRetention.rst.inc index d1963d04858..9cdbbd418fc 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-StatisticsRetention.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-StatisticsRetention.rst.inc @@ -2,7 +2,7 @@ .. _PruneStatistics: - The :strong:`Statistics Retention` directive defines the length of time that Bareos will keep statistics job records in the Catalog database after the Job End time (in the catalog **JobHisto** table). When this time period expires, and if user runs :bcommand:`prune stats` command, Bareos will prune (remove) Job records that are older than the specified period. + The :strong:`Statistics Retention`\ directive defines the length of time that Bareos will keep statistics job records in the Catalog database after the Job End time (in the catalog **JobHisto** table). When this time period expires, and if user runs :bcommand:`prune stats` command, Bareos will prune (remove) Job records that are older than the specified period. Theses statistics records aren’t use for restore purpose, but mainly for capacity planning, billings, etc. See chapter :ref:`section-JobStatistics` for additional information. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-VerId.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-VerId.rst.inc index 49923d93d8f..406fb4cf2cb 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-VerId.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-director-VerId.rst.inc @@ -1,2 +1,2 @@ -where ``string`` is an identifier which can be used for support purpose. This string is displayed using the :bcommand:`version` command. +where :strong:`string` is an identifier which can be used for support purpose. This string is displayed using the :bcommand:`version` command. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-fileset-EnableVss.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-fileset-EnableVss.rst.inc index 4ac14e75189..bb1670cfec4 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-fileset-EnableVss.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-fileset-EnableVss.rst.inc @@ -1,3 +1,3 @@ -:index:`[TAG=Windows->Enable VSS] ` If this directive is set to ``yes`` the File daemon will be notified that the user wants to use a Volume Shadow Copy Service (VSS) backup for this job. This directive is effective only on the Windows File Daemon. It permits a consistent copy of open files to be made for cooperating writer applications, and for applications that are not VSS away, Bareos can at least copy open files. The Volume Shadow Copy will only be done on -Windows drives where the drive (e.g. C:, D:, ...) is explicitly mentioned in a :strong:`File` directive. For more information, please see the :ref:`Windows ` chapter of this manual. +:index:`[TAG=Windows->Enable VSS] ` If this directive is set to :strong:`yes` the File daemon will be notified that the user wants to use a Volume Shadow Copy Service (VSS) backup for this job. This directive is effective only on the Windows File Daemon. It permits a consistent copy of open files to be made for cooperating writer applications, and for applications that are not VSS away, Bareos can at least copy open files. The Volume Shadow Copy will only be done on +Windows drives where the drive (e.g. C:, D:, ...) is explicitly mentioned in a :strong:`File`\ directive. For more information, please see the :ref:`Windows ` chapter of this manual. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-fileset-IgnoreFileSetChanges.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-fileset-IgnoreFileSetChanges.rst.inc index c821204d7d4..2cd50a6df99 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-fileset-IgnoreFileSetChanges.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-fileset-IgnoreFileSetChanges.rst.inc @@ -2,5 +2,5 @@ Normally, if you modify the FileSet Include or Exclude lists, the next backup wi We strongly recommend against setting this directive to yes, since doing so may cause you to have an incomplete set of backups. -If this directive is set to ``yes``, any changes you make to the FileSet Include or Exclude lists, will not force a Full during subsequent backups. +If this directive is set to :strong:`yes`, any changes you make to the FileSet Include or Exclude lists, will not force a Full during subsequent backups. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-AllowDuplicateJobs.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-AllowDuplicateJobs.rst.inc index b56eb223204..1547c2dacf0 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-AllowDuplicateJobs.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-AllowDuplicateJobs.rst.inc @@ -1,4 +1,4 @@ -\centering + .. figure:: /include/images/duplicate-real.* :alt: Allow Duplicate Jobs usage @@ -9,7 +9,7 @@ A duplicate job in the sense we use it here means a second or subsequent job with the same name starts. This happens most frequently when the first job runs longer than expected because no tapes are available. -If this directive is enabled duplicate jobs will be run. If the directive is set to ``no`` then only one job of a given name may run at one time. The action that Bareos takes to ensure only one job runs is determined by the directives +If this directive is enabled duplicate jobs will be run. If the directive is set to :strong:`no` then only one job of a given name may run at one time. The action that Bareos takes to ensure only one job runs is determined by the directives - @@ -23,5 +23,5 @@ If this directive is enabled duplicate jobs will be run. If the directive is set :config:option:`dir/job/CancelRunningDuplicates`\ -If none of these directives is set to ``yes``, Allow Duplicate Jobs is set to ``no`` and two jobs are present, then the current job (the second one started) will be cancelled. +If none of these directives is set to :strong:`yes`, Allow Duplicate Jobs is set to :strong:`no` and two jobs are present, then the current job (the second one started) will be cancelled. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-AllowMixedPriority.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-AllowMixedPriority.rst.inc index a4fb3811736..6fec893f00a 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-AllowMixedPriority.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-AllowMixedPriority.rst.inc @@ -1,4 +1,4 @@ -When set to ``yes``, this job may run even if lower priority jobs are already running. This means a high priority job will not have to wait for other jobs to finish before starting. The scheduler will only mix priorities when all running jobs have this set to true. +When set to :strong:`yes`, this job may run even if lower priority jobs are already running. This means a high priority job will not have to wait for other jobs to finish before starting. The scheduler will only mix priorities when all running jobs have this set to true. Note that only higher priority jobs will start early. Suppose the director will allow two concurrent jobs, and that two jobs with priority 10 are running, with two more in the queue. If a job with priority 5 is added to the queue, it will be run as soon as one of the running jobs finishes. However, new priority 10 jobs will not be run until the priority 5 job has finished. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-BackupFormat.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-BackupFormat.rst.inc index d5223eec664..60639e5fa1f 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-BackupFormat.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-BackupFormat.rst.inc @@ -1,4 +1,4 @@ -The backup format used for protocols which support multiple formats. By default, it uses the Bareos ``Native`` Backup format. Other protocols, like NDMP supports different backup formats for instance: +The backup format used for protocols which support multiple formats. By default, it uses the Bareos :strong:`Native` Backup format. Other protocols, like NDMP supports different backup formats for instance: - Dump diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelLowerLevelDuplicates.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelLowerLevelDuplicates.rst.inc index 0342def793e..3f3021eb607 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelLowerLevelDuplicates.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelLowerLevelDuplicates.rst.inc @@ -1,3 +1,3 @@ -If :config:option:`dir/job/AllowDuplicateJobs`\ is set to ``no`` and this directive is set to ``yes``, Bareos will choose between duplicated jobs the one with the highest level. For example, it will cancel a previous Incremental to run a Full backup. It works only for Backup jobs. If the levels of the duplicated jobs are the same, nothing is done and the directives +If :config:option:`dir/job/AllowDuplicateJobs`\ is set to :strong:`no` and this directive is set to :strong:`yes`, Bareos will choose between duplicated jobs the one with the highest level. For example, it will cancel a previous Incremental to run a Full backup. It works only for Backup jobs. If the levels of the duplicated jobs are the same, nothing is done and the directives :config:option:`dir/job/CancelQueuedDuplicates`\ and :config:option:`dir/job/CancelRunningDuplicates`\ will be examined. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelQueuedDuplicates.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelQueuedDuplicates.rst.inc index 24bfa6a4552..31f16dbdc48 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelQueuedDuplicates.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelQueuedDuplicates.rst.inc @@ -1,2 +1,2 @@ -If :config:option:`dir/job/AllowDuplicateJobs`\ is set to ``no`` and if this directive is set to ``yes`` any job that is already queued to run but not yet running will be canceled. +If :config:option:`dir/job/AllowDuplicateJobs`\ is set to :strong:`no` and if this directive is set to :strong:`yes` any job that is already queued to run but not yet running will be canceled. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelRunningDuplicates.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelRunningDuplicates.rst.inc index 41d04a357c8..2151911f460 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelRunningDuplicates.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-CancelRunningDuplicates.rst.inc @@ -1,2 +1,2 @@ -If :config:option:`dir/job/AllowDuplicateJobs`\ is set to ``no`` and if this directive is set to ``yes`` any job that is already running will be canceled. +If :config:option:`dir/job/AllowDuplicateJobs`\ is set to :strong:`no` and if this directive is set to :strong:`yes` any job that is already running will be canceled. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-ClientRunBeforeJob.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-ClientRunBeforeJob.rst.inc index 4d79ec61b14..a90dce1915c 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-ClientRunBeforeJob.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-ClientRunBeforeJob.rst.inc @@ -3,6 +3,7 @@ This is basically a shortcut for the :config:option:`dir/job/RunScript`\ resour .. warning:: + For compatibility reasons, with this shortcut, the command is executed directly when the client receive it. And if the command is in error, other remote runscripts will be discarded. To be sure that all commands will be diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-FileHistorySize.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-FileHistorySize.rst.inc index d4fe3b28081..af0a9cbcb9f 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-FileHistorySize.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-FileHistorySize.rst.inc @@ -1,10 +1,11 @@ When using NDMP and :config:option:`dir/job/SaveFileHistory`\ is enabled, this directives controls the size of the internal temporary database (LMDB) to translate NDMP file and directory information into Bareos file and directory information. -:strong:`File History Size` must be greater the number of directories + files of this NDMP backup job. +:strong:`File History Size`\ must be greater the number of directories + files of this NDMP backup job. .. warning:: - This uses a large memory mapped file (:strong:`File History Size` $* 256 \Longrightarrow$ around 2,3 GB for the :strong:`File History Size = 10000000`). - On 32-bit systems or if a memory limit for the user running the |bareosDir| (normally **bareos**) exists + + This uses a large memory mapped file (:strong:`File History Size`\ $* 256 \Longrightarrow$ around 2,3 GB for the :strong:`File History Size = 10000000`\ ). + On 32-bit systems or if a memory limit for the user running the |dir| (normally **bareos**) exists (verify by :command:`su - bareos -s /bin/sh -c "ulimit -a"`), this may fail. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Level.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Level.rst.inc index f0601945259..89dbf8e79f8 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Level.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Level.rst.inc @@ -29,7 +29,7 @@ Backup The File daemon (Client) decides which files to backup for an Incremental backup by comparing start time of the prior Job (Full, Differential, or Incremental) against the time each file was last "modified" (st_mtime) and the time its attributes were last "changed"(st_ctime). If the file was modified or its attributes changed on or after this start time, it will then be backed up. - Some virus scanning software may change st_ctime while doing the scan. For example, if the virus scanning program attempts to reset the access time (st_atime), which Bareos does not use, it will cause st_ctime to change and hence Bareos will backup the file during an Incremental or Differential backup. In the case of Sophos virus scanning, you can prevent it from resetting the access time (st_atime) and hence changing st_ctime by using the ``--no-reset-atime`` option. + Some virus scanning software may change st_ctime while doing the scan. For example, if the virus scanning program attempts to reset the access time (st_atime), which Bareos does not use, it will cause st_ctime to change and hence Bareos will backup the file during an Incremental or Differential backup. In the case of Sophos virus scanning, you can prevent it from resetting the access time (st_atime) and hence changing st_ctime by using the :strong:`--no-reset-atime` option. For other software, please see their manual. When Bareos does an Incremental backup, all modified files that are still on the system are backed up. However, any file that has been deleted since the last Full backup remains in the Bareos catalog, which means that if between a Full save and the time you do a restore, some files are deleted, those deleted files will also be restored. The deleted files will no longer appear in the catalog after doing another Full save. @@ -81,8 +81,9 @@ Backup -.. warning:: - Opposite to the other backup levels, VirtualFull may require read and write access to multiple volumes. In most cases you have to make sure, that Bareos does not try to read and write to the same Volume. + .. warning:: + + Opposite to the other backup levels, VirtualFull may require read and write access to multiple volumes. In most cases you have to make sure, that Bareos does not try to read and write to the same Volume. Restore | @@ -105,6 +106,7 @@ Verify .. warning:: + If you run two Verify Catalog jobs on the same client at the same time, the results will certainly be incorrect. This is because Verify Catalog modifies the Catalog database while running in order to @@ -120,6 +122,7 @@ Verify .. warning:: + If you run two Verify VolumeToCatalog jobs on the same client at the same time, the results will certainly be incorrect. This is because the Verify VolumeToCatalog modifies the Catalog database diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-MaxRunTime.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-MaxRunTime.rst.inc index 0e2b3651d1c..898b1ba7df2 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-MaxRunTime.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-MaxRunTime.rst.inc @@ -1,4 +1,4 @@ The time specifies the maximum allowed time that a job may run, counted from when the job starts, (not necessarily the same as when the job was scheduled). -By default, the watchdog thread will kill any Job that has run more than 6 days. The maximum watchdog timeout is independent of :strong:`Max Run Time` and cannot be changed. +By default, the watchdog thread will kill any Job that has run more than 6 days. The maximum watchdog timeout is independent of :strong:`Max Run Time`\ and cannot be changed. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-MaxWaitTime.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-MaxWaitTime.rst.inc index e25562286c3..289c82d114a 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-MaxWaitTime.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-MaxWaitTime.rst.inc @@ -1,6 +1,6 @@ The time specifies the maximum allowed time that a job may block waiting for a resource (such as waiting for a tape to be mounted, or waiting for the storage or file daemons to perform their duties), counted from the when the job starts, (not necessarily the same as when the job was scheduled). -\centering + .. figure:: /include/images/different_time.* :alt: Job time control directives diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-RegexWhere.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-RegexWhere.rst.inc index e94314e4279..ba75f5e73e4 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-RegexWhere.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-RegexWhere.rst.inc @@ -1,5 +1,4 @@ -This directive applies only to a Restore job and specifies a regex filename manipulation of all files being restored. This will use :ref:`File - Relocation ` feature. +This directive applies only to a Restore job and specifies a regex filename manipulation of all files being restored. This will use :ref:`File Relocation ` feature. For more informations about how use this option, see :ref:`regexwhere`. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-RunScript.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-RunScript.rst.inc index 74340f4a18b..bcc345d128e 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-RunScript.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-RunScript.rst.inc @@ -32,7 +32,7 @@ You can specify more than one Command/Console option per RunScript. \hline Runs On Client & :strong:`Yes` | No & run command on client\\ \hline - Runs When & :strong:`\variable{Never}` | \variable{Before} | \variable{After} | \variable{Always} | \textsl{\variable{AfterVSS}} & When to run\\ + Runs When & :strong:```Never``\ ` | ``Before``\ | ``After``\ | ``Always``\ | \textsl{\variable{AfterVSS}} & When to run\\ \hline Fail Job On Error & :strong:`Yes` | No & Fail job if script returns something different from 0\\ \hline @@ -50,7 +50,7 @@ Options Value Runs On Success **Yes** \| No run if JobStatus is successful Runs On Failure Yes \| **No** run if JobStatus isn’t successful Runs On Client **Yes** \| No run command on client -Runs When **\variable{Never}** \| \variable{Before} \| \variable{After} \| \variable{Always} \| *\variable{AfterVSS}* When to run +Runs When **``Never``\ ** \| ``Before``\ \| ``After``\ \| ``Always``\ \| *``AfterVSS``\ * When to run Fail Job On Error **Yes** \| No Fail job if script returns something different from 0 Command External command Console Console command @@ -61,6 +61,7 @@ Any output sent by the command to standard output will be included in the Bareos .. warning:: + The command string is parsed then fed to the OS, which means that the path will be searched to execute your specified command, but there is no shell interpretation. As a consequence, if you @@ -192,7 +193,7 @@ Examples: -Special Windows Considerations :index:`[TAG=Windows->Run Script] ` +Special Windows Considerations :index:`[TAG=Windows->Run Script] ` You can run scripts just after snapshots initializations with *AfterVSS* keyword. @@ -218,7 +219,7 @@ System environment variables can be referenced with %var% and used as either par The outer set of quotes is removed when the configuration file is parsed. You need to escape the inner quotes so that they are there when the code that parses the command line for execution runs so it can tell what the program name is. -The special characters \configCharsToQuote will need to be quoted, if they are part of a filename or argument. +The special characters |configCharsToQuote| will need to be quoted, if they are part of a filename or argument. If someone is logged in, a blank "command" window running the commands will be present during the execution of the command. @@ -253,7 +254,7 @@ If /C or /K is specified, then the remainder of the command line after the switc - exactly two quote characters. - - no special characters between the two quote characters, where special is one of: \configCharsToQuote + - no special characters between the two quote characters, where special is one of: |configCharsToQuote| - there are one or more whitespace characters between the the two quote characters. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SaveFileHistory.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SaveFileHistory.rst.inc index 04a15739c3c..04e5cdb2145 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SaveFileHistory.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SaveFileHistory.rst.inc @@ -1,8 +1,9 @@ -:index:`[TAG=NDMP->File History] ` Allow disabling storing the file history, as this causes problems problems with some implementations of NDMP (out-of-order metadata). +:index:`[TAG=NDMP->File History] ` Allow disabling storing the file history, as this causes problems problems with some implementations of NDMP (out-of-order metadata). With :config:option:`dir/job/FileHistorySize`\ the maximum number of files and directories inside a NDMP job can be configured. -.. warning:: - The File History is required to do a single file restore from NDMP backups. With this disabled, only full restores are possible. + .. warning:: + + The File History is required to do a single file restore from NDMP backups. With this disabled, only full restores are possible. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SpoolAttributes.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SpoolAttributes.rst.inc index 350eb980740..880b0267722 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SpoolAttributes.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SpoolAttributes.rst.inc @@ -1,4 +1,4 @@ -Is Spool Attributes is disabled, the File attributes are sent by the Storage daemon to the Director as they are stored on tape. However, if you want to avoid the possibility that database updates will slow down writing to the tape, you may want to set the value to ``yes``, in which case the Storage daemon will buffer the File attributes and Storage coordinates to a temporary file in the Working Directory, then when writing the Job data to the tape is completed, the +Is Spool Attributes is disabled, the File attributes are sent by the Storage daemon to the Director as they are stored on tape. However, if you want to avoid the possibility that database updates will slow down writing to the tape, you may want to set the value to :strong:`yes`, in which case the Storage daemon will buffer the File attributes and Storage coordinates to a temporary file in the Working Directory, then when writing the Job data to the tape is completed, the attributes and storage coordinates will be sent to the Director. NOTE: When :config:option:`dir/job/SpoolData`\ is set to yes, Spool Attributes is also automatically set to yes. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SpoolData.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SpoolData.rst.inc index 60fc2043570..3e453dfe48e 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SpoolData.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-SpoolData.rst.inc @@ -1,4 +1,4 @@ -If this directive is set to ``yes``, the Storage daemon will be requested to spool the data for this Job to disk rather than write it directly to the Volume (normally a tape). +If this directive is set to :strong:`yes`, the Storage daemon will be requested to spool the data for this Job to disk rather than write it directly to the Volume (normally a tape). Thus the data is written in large blocks to the Volume rather than small blocks. This directive is particularly useful when running multiple simultaneous backups to tape. Once all the data arrives or the spool files’ maximum sizes are reached, the data will be despooled and written to tape. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Type.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Type.rst.inc index 2f8b3c5a824..59e75a0ad70 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Type.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Type.rst.inc @@ -1,4 +1,4 @@ -The :strong:`Type` directive specifies the Job type, which is one of the following: +The :strong:`Type`\ directive specifies the Job type, which is one of the following: Backup | diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Where.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Where.rst.inc index 91188d62d38..58be1879e22 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Where.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-job-Where.rst.inc @@ -2,5 +2,6 @@ This directive applies only to a Restore job and specifies a prefix to the direc -.. warning:: - To use Where on NDMP backups, please read :ref:`section-ndmp-where` + .. warning:: + + To use Where on NDMP backups, please read :ref:`section-ndmp-where` diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailCommand.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailCommand.rst.inc index 2eecea567eb..13930da6891 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailCommand.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailCommand.rst.inc @@ -6,7 +6,7 @@ /usr/lib/sendmail -F BAREOS -In many cases, depending on your machine, this command may not work. However, by using the :strong:`Mail Command`, you can specify exactly how to send the mail. During the processing of the command part, normally specified as a quoted string, the following substitutions will be used: +In many cases, depending on your machine, this command may not work. However, by using the :strong:`Mail Command`\ , you can specify exactly how to send the mail. During the processing of the command part, normally specified as a quoted string, the following substitutions will be used: - %% = % @@ -36,9 +36,9 @@ In many cases, depending on your machine, this command may not work. However, by - %V = Write Volume name (Only on director side) -Please note: any :strong:`Mail Command` directive must be specified in the Messages resource before the desired :config:option:`dir/messages/Mail`\ , :config:option:`dir/messages/MailOnSuccess`\ or :config:option:`dir/messages/MailOnError`\ directive. In fact, each of those directives may be preceded by a different :strong:`Mail Command`. +Please note: any :strong:`Mail Command`\ directive must be specified in the Messages resource before the desired :config:option:`dir/messages/Mail`\ , :config:option:`dir/messages/MailOnSuccess`\ or :config:option:`dir/messages/MailOnError`\ directive. In fact, each of those directives may be preceded by a different :strong:`Mail Command`\ . -A default installation will use the program bsmtp as :strong:`Mail Command`. The program :command:`bsmtp` is provided by Bareos and unifies the usage of a mail client to a certain degree: +A default installation will use the program bsmtp as :strong:`Mail Command`\ . The program :command:`bsmtp` is provided by Bareos and unifies the usage of a mail client to a certain degree: @@ -47,5 +47,5 @@ A default installation will use the program bsmtp as :strong:`Mail Command`. The -The :command:`bsmtp` program is provided as part of Bareos. For additional details, please see the :ref:`bsmtp` section. Please test any :strong:`Mail Command` that you use to ensure that your smtp gateway accepts the addressing form that you use. Certain programs such as Exim can be very selective as to what forms are permitted particularly in the from part. +The :command:`bsmtp` program is provided as part of Bareos. For additional details, please see the :ref:`bsmtp` section. Please test any :strong:`Mail Command`\ that you use to ensure that your smtp gateway accepts the addressing form that you use. Certain programs such as Exim can be very selective as to what forms are permitted particularly in the from part. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailOnError.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailOnError.rst.inc index 89a66e17b1d..d141ddacb28 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailOnError.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailOnError.rst.inc @@ -1,3 +1,3 @@ -Send the message to the email addresses that are given as a comma separated list in the address field if the Job terminates with an error condition. :strong:`Mail On Error` messages are grouped together during a job and then sent as a single email message when the job terminates. This destination differs from the mail destination in that if the Job terminates normally, the message is totally discarded (for this destination). If the Job terminates in error, it is emailed. By +Send the message to the email addresses that are given as a comma separated list in the address field if the Job terminates with an error condition. :strong:`Mail On Error`\ messages are grouped together during a job and then sent as a single email message when the job terminates. This destination differs from the mail destination in that if the Job terminates normally, the message is totally discarded (for this destination). If the Job terminates in error, it is emailed. By using other destinations such as append you can ensure that even if the Job terminates normally, the output information is saved. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailOnSuccess.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailOnSuccess.rst.inc index b68c373329b..9cf243c617d 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailOnSuccess.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-MailOnSuccess.rst.inc @@ -1,3 +1,3 @@ -Send the message to the email addresses that are given as a comma separated list in the address field if the Job terminates normally (no error condition). :strong:`Mail On Success` messages are grouped together during a job and then sent as a single email message when the job terminates. This destination differs from the mail destination in that if the Job terminates abnormally, the message is totally discarded (for this destination). If the Job terminates normally, it is +Send the message to the email addresses that are given as a comma separated list in the address field if the Job terminates normally (no error condition). :strong:`Mail On Success`\ messages are grouped together during a job and then sent as a single email message when the job terminates. This destination differs from the mail destination in that if the Job terminates abnormally, the message is totally discarded (for this destination). If the Job terminates normally, it is emailed. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-OperatorCommand.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-OperatorCommand.rst.inc index 7e00a58ac1f..a9e3e29ae35 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-OperatorCommand.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-OperatorCommand.rst.inc @@ -1,3 +1,3 @@ -This resource specification is similar to the :config:option:`dir/messages/MailCommand`\ except that it is used for Operator messages. The substitutions performed for the :config:option:`dir/messages/MailCommand`\ are also done for this command. Normally, you will set this command to the same value as specified for the :config:option:`dir/messages/MailCommand`\ . The :strong:`Operator Command` directive must +This resource specification is similar to the :config:option:`dir/messages/MailCommand`\ except that it is used for Operator messages. The substitutions performed for the :config:option:`dir/messages/MailCommand`\ are also done for this command. Normally, you will set this command to the same value as specified for the :config:option:`dir/messages/MailCommand`\ . The :strong:`Operator Command`\ directive must appear in the Messages resource before the :config:option:`dir/messages/Operator`\ directive. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-Syslog.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-Syslog.rst.inc index aa765437c74..09c343f7769 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-Syslog.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-messages-Syslog.rst.inc @@ -1,6 +1,6 @@ Send the message to the system log (syslog). -Since :sinceVersion:`14.4.0: Syslog Level` the facility can be specified in the address field and the loglevel correspond to the Bareos :ref:`MessageTypes`. The defaults are ``DAEMON`` and ``LOG_ERR``. +Since :sinceVersion:`14.4.0: Syslog Level` the facility can be specified in the address field and the loglevel correspond to the Bareos :ref:`MessageTypes`. The defaults are :strong:`DAEMON` and :strong:`LOG_ERR`. Although the syslog destination is not used in the default Bareos config files, in certain cases where Bareos encounters errors in trying to deliver a message, as a last resort, it will send it to the system syslog to prevent loss of the message, so you might occassionally check the syslog for Bareos output. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-LabelFormat.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-LabelFormat.rst.inc index 29e911ad410..5954009f75c 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-LabelFormat.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-LabelFormat.rst.inc @@ -5,8 +5,8 @@ The format should be specified in double quotes (:file:`"`), and consists of let In addition, the format may contain a number of variable expansion characters which will be expanded by a complex algorithm allowing you to create Volume names of many different formats. In all cases, the expansion process must resolve to the set of characters noted above that are legal Volume names. Generally, these variable expansion characters begin with a dollar sign (:file:`$`) or a left bracket (:file:`[`). For more details on variable expansion, please see :ref:`section-VariableExpansionVolumeLabels`. -If no variable expansion characters are found in the string, the Volume name will be formed from the format string appended with the a unique number that increases. If you do not remove volumes from the pool, this number should be the number of volumes plus one, but this is not guaranteed. The unique number will be edited as four digits with leading zeros. For example, with a :strong:`Label Format = "File-"`, the first volumes will be named \volume{File-0001}, -\volume{File-0002}, ... +If no variable expansion characters are found in the string, the Volume name will be formed from the format string appended with the a unique number that increases. If you do not remove volumes from the pool, this number should be the number of volumes plus one, but this is not guaranteed. The unique number will be edited as four digits with leading zeros. For example, with a :strong:`Label Format = "File-"`\ , the first volumes will be named **File-0001**, +**File-0002**, ... In almost all cases, you should enclose the format specification (part after the equal sign) in double quotes (:file:`"`). diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-MaximumBlockSize.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-MaximumBlockSize.rst.inc index 4f0a2277c39..18729d5af1f 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-MaximumBlockSize.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-MaximumBlockSize.rst.inc @@ -1,6 +1,7 @@ -The :strong:`Maximum Block Size` can be defined here to define different block sizes per volume or statically for all volumes at :config:option:`sd/device/MaximumBlockSize`\ . If not defined, its default is 63 KB. Increasing this value could improve the throughput of writing to tapes. +The :strong:`Maximum Block Size`\ can be defined here to define different block sizes per volume or statically for all volumes at :config:option:`sd/device/MaximumBlockSize`\ . If not defined, its default is 63 KB. Increasing this value could improve the throughput of writing to tapes. -.. warning:: - However make sure to read the :ref:`Setting Block Sizes ` chapter carefully before applying any changes. + .. warning:: + + However make sure to read the :ref:`Setting Block Sizes ` chapter carefully before applying any changes. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-MinimumBlockSize.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-MinimumBlockSize.rst.inc index 696ede51c02..5753eca8295 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-MinimumBlockSize.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-MinimumBlockSize.rst.inc @@ -1,2 +1,2 @@ -The :strong:`Minimum Block Size` can be defined here to define different block sizes per volume or statically for all volumes at :config:option:`sd/device/MinimumBlockSize`\ . For details, see chapter :ref:`Setting Block Sizes `. +The :strong:`Minimum Block Size`\ can be defined here to define different block sizes per volume or statically for all volumes at :config:option:`sd/device/MinimumBlockSize`\ . For details, see chapter :ref:`Setting Block Sizes `. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-PurgeOldestVolume.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-PurgeOldestVolume.rst.inc index 47d2f269c01..cf57f1a285b 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-PurgeOldestVolume.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-PurgeOldestVolume.rst.inc @@ -7,8 +7,9 @@ In most cases, you should use :config:option:`dir/pool/RecycleOldestVolume`\ in .. warning:: + - Be aware that :strong:`Purge Oldest Volume` disregards all retention + Be aware that :strong:`Purge Oldest Volume`\ disregards all retention periods. If you have only a single Volume defined and you turn this variable on, that Volume will always be immediately overwritten when it fills! So at a minimum, ensure that you have a decent number of Volumes diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-Recycle.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-Recycle.rst.inc index 3f7bc92455b..9719edf6c26 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-Recycle.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-Recycle.rst.inc @@ -3,5 +3,5 @@ the data will remain valid. If you want to reuse (re-write) the Volume, and the Please note that the value defined by this directive in the configuration file is the default value used when a Volume is created. Once the volume is created, changing the value in the configuration file will not change what is stored for the Volume. To change the value for an existing Volume you must use the :bcommand:`update volume` command. -When all Job and File records have been pruned or purged from the catalog for a particular Volume, if that Volume is marked as Append, Full, Used, or Error, it will then be marked as Purged. Only Volumes marked as Purged will be considered to be converted to the Recycled state if the :strong:`Recycle` directive is set to :strong:`yes`. +When all Job and File records have been pruned or purged from the catalog for a particular Volume, if that Volume is marked as Append, Full, Used, or Error, it will then be marked as Purged. Only Volumes marked as Purged will be considered to be converted to the Recycled state if the :strong:`Recycle`\ directive is set to :strong:`yes`. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-VolumeUseDuration.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-VolumeUseDuration.rst.inc index 9252edd2eb5..60a940e8fb4 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-VolumeUseDuration.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-pool-VolumeUseDuration.rst.inc @@ -4,5 +4,5 @@ appended to the Volume, but it may be recycled if recycling is enabled. Once the You might use this directive, for example, if you have a Volume used for Incremental backups, and Volumes used for Weekly Full backups. Once the Full backup is done, you will want to use a different Incremental Volume. This can be accomplished by setting the Volume Use Duration for the Incremental Volume to six days. I.e. it will be used for the 6 days following a Full save, then a different Incremental volume will be used. Be careful about setting the duration to short periods such as 23 hours, or you might experience problems of Bareos waiting for a tape over the weekend only to complete the backups Monday morning when an operator mounts a new tape. -Please note that the value defined by this directive in the bareos-dir.conf file is the default value used when a Volume is created. Once the volume is created, changing the value in the bareos-dir.conf file will not change what is stored for the Volume. To change the value for an existing Volume you must use the :ref:`\bf update volume ` command in the Console. +Please note that the value defined by this directive in the bareos-dir.conf file is the default value used when a Volume is created. Once the volume is created, changing the value in the bareos-dir.conf file will not change what is stored for the Volume. To change the value for an existing Volume you must use the :ref:` update volume ` command in the Console. diff --git a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-schedule-Run.rst.inc b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-schedule-Run.rst.inc index cc618df9a05..d6b8d9b2dc6 100644 --- a/docs/manuals/en/new_main_reference/source/config-directive-description/dir-schedule-Run.rst.inc +++ b/docs/manuals/en/new_main_reference/source/config-directive-description/dir-schedule-Run.rst.inc @@ -7,34 +7,34 @@ By the use of overrides, you may customize a particular Job. For example, you ma Job-overrides are specified as: keyword=value where the keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool, or IncrementalPool, and the value is as defined on the respective directive formats for the Job resource. You may specify multiple Job-overrides on one Run directive by separating them with one or more spaces or by separating them with a trailing comma. For example: Level=Full - :index:`[TAG=Level] ` :index:`[TAG=Directive->Level] ` is all files in the FileSet whether or not they have changed. + :index:`[TAG=Level] ` :index:`[TAG=Directive->Level] ` is all files in the FileSet whether or not they have changed. Level=Incremental - :index:`[TAG=Level] ` :index:`[TAG=Directive->Level] ` is all files that have changed since the last backup. + :index:`[TAG=Level] ` :index:`[TAG=Directive->Level] ` is all files that have changed since the last backup. Pool=Weekly - :index:`[TAG=Pool] ` :index:`[TAG=Directive->Pool] ` specifies to use the Pool named Weekly. + :index:`[TAG=Pool] ` :index:`[TAG=Directive->Pool] ` specifies to use the Pool named Weekly. Storage=DLT_Drive - :index:`[TAG=Storage] ` :index:`[TAG=Directive->Storage] ` specifies to use DLT_Drive for the storage device. + :index:`[TAG=Storage] ` :index:`[TAG=Directive->Storage] ` specifies to use DLT_Drive for the storage device. Messages=Verbose - :index:`[TAG=Messages] ` :index:`[TAG=Directive->Messages] ` specifies to use the Verbose message resource for the Job. + :index:`[TAG=Messages] ` :index:`[TAG=Directive->Messages] ` specifies to use the Verbose message resource for the Job. FullPool=Full - :index:`[TAG=FullPool] ` :index:`[TAG=Directive->FullPool] ` specifies to use the Pool named Full if the job is a full backup, or is upgraded from another type to a full backup. + :index:`[TAG=FullPool] ` :index:`[TAG=Directive->FullPool] ` specifies to use the Pool named Full if the job is a full backup, or is upgraded from another type to a full backup. DifferentialPool=Differential - :index:`[TAG=DifferentialPool] ` :index:`[TAG=Directive->DifferentialPool] ` specifies to use the Pool named Differential if the job is a differential backup. + :index:`[TAG=DifferentialPool] ` :index:`[TAG=Directive->DifferentialPool] ` specifies to use the Pool named Differential if the job is a differential backup. IncrementalPool=Incremental - :index:`[TAG=IncrementalPool] ` :index:`[TAG=Directive->IncrementalPool] ` specifies to use the Pool named Incremental if the job is an incremental backup. + :index:`[TAG=IncrementalPool] ` :index:`[TAG=Directive->IncrementalPool] ` specifies to use the Pool named Incremental if the job is an incremental backup. Accurate=yes|no - :index:`[TAG=Accurate] ` :index:`[TAG=Directive->Accurate] ` tells Bareos to use or not the Accurate code for the specific job. It can allow you to save memory and and CPU resources on the catalog server in some cases. + :index:`[TAG=Accurate] ` :index:`[TAG=Directive->Accurate] ` tells Bareos to use or not the Accurate code for the specific job. It can allow you to save memory and and CPU resources on the catalog server in some cases. SpoolData=yes|no - :index:`[TAG=SpoolData] ` :index:`[TAG=Directive->Spool Data] ` tells Bareos to use or not to use spooling for the specific job. + :index:`[TAG=SpoolData] ` :index:`[TAG=Directive->Spool Data] ` tells Bareos to use or not to use spooling for the specific job. Date-time-specification determines when the Job is to be run. The specification is a repetition, and as a default Bareos is set to run a job at the beginning of the hour of every hour of every day of every week of every month of every year. This is not normally what you want, so you must specify or limit when you want the job to run. Any specification given is assumed to be repetitive in nature and will serve to override or limit the default repetition. This is done by specifying masks or times for the hour, day of the month, day of the week, week of the month, week of the year, and month when you want the job to run. By specifying one or more of the above, you can define a schedule to repeat at almost any frequency you want. @@ -52,67 +52,67 @@ The date/time to run the Job can be specified in the following way in pseudo-BNF :: \begin{longtable}{ l @{ ::= } p{0.5\textwidth} } - \bnfvar{week-keyword} & 1st \pipe 2nd \pipe 3rd \pipe 4th \pipe 5th \pipe first \pipe - second \pipe third \pipe fourth \pipe fifth \pipe last \\ - \bnfvar{wday-keyword} & sun \pipe mon \pipe tue \pipe wed \pipe thu \pipe fri \pipe sat \pipe - sunday \pipe monday \pipe tuesday \pipe wednesday \pipe - thursday \pipe friday \pipe saturday \\ - \bnfvar{week-of-year-keyword} & w00 \pipe w01 \pipe ... w52 \pipe w53 \\ - \bnfvar{month-keyword} & jan \pipe feb \pipe mar \pipe apr \pipe may \pipe jun \pipe jul \pipe - aug \pipe sep \pipe oct \pipe nov \pipe dec \pipe - january \pipe february \pipe ... \pipe december \\ - \bnfvar{digit} & 1 \pipe 2 \pipe 3 \pipe 4 \pipe 5 \pipe 6 \pipe 7 \pipe 8 \pipe 9 \pipe 0 \\ - \bnfvar{number} & \bnfvar{digit} \pipe \bnfvar{digit}\bnfvar{number} \\ - \bnfvar{12hour} & 0 \pipe 1 \pipe 2 \pipe ... 12 \\ - \bnfvar{hour} & 0 \pipe 1 \pipe 2 \pipe ... 23 \\ - \bnfvar{minute} & 0 \pipe 1 \pipe 2 \pipe ... 59 \\ - \bnfvar{day} & 1 \pipe 2 \pipe ... 31 \\ - \bnfvar{time} & \bnfvar{hour}:\bnfvar{minute} \pipe - \bnfvar{12hour}:\bnfvar{minute}am \pipe - \bnfvar{12hour}:\bnfvar{minute}pm \\ - \bnfvar{time-spec} & at \bnfvar{time} \pipe hourly \\ - % ??? \bnfvar{date-keyword} & on \pipe weekly \\ - \bnfvar{day-range} & \bnfvar{day}-\bnfvar{day} \\ - \bnfvar{month-range} & \bnfvar{month-keyword}-\bnfvar{month-keyword} \\ - \bnfvar{wday-range} & \bnfvar{wday-keyword}-\bnfvar{wday-keyword} \\ - \bnfvar{range} & \bnfvar{day-range} \pipe \bnfvar{month-range} \pipe - \bnfvar{wday-range} \\ - \bnfvar{modulo} & \bnfvar{day}/\bnfvar{day} \pipe \bnfvar{week-of-year-keyword}/\bnfvar{week-of-year-keyword} \\ - \bnfvar{date} & \bnfvar{date-keyword} \pipe \bnfvar{day} \pipe \bnfvar{range} \\ - \bnfvar{date-spec} & \bnfvar{date} \pipe \bnfvar{date-spec} \\ - \bnfvar{day-spec} & \bnfvar{day} \pipe \bnfvar{wday-keyword} \pipe - \bnfvar{day} \pipe \bnfvar{wday-range} \pipe - \bnfvar{week-keyword} \bnfvar{wday-keyword} \pipe - \bnfvar{week-keyword} \bnfvar{wday-range} \pipe + & 1st | 2nd | 3rd | 4th | 5th | first | + second | third | fourth | fifth | last \\ + & sun | mon | tue | wed | thu | fri | sat | + sunday | monday | tuesday | wednesday | + thursday | friday | saturday \\ + & w00 | w01 | ... w52 | w53 \\ + & jan | feb | mar | apr | may | jun | jul | + aug | sep | oct | nov | dec | + january | february | ... | december \\ + & 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 \\ + & | \\ + <12hour> & 0 | 1 | 2 | ... 12 \\ + & 0 | 1 | 2 | ... 23 \\ + & 0 | 1 | 2 | ... 59 \\ + & 1 | 2 | ... 31 \\ +