Skip to content

Commit

Permalink
Merge pull request #875
Browse files Browse the repository at this point in the history
docs: enhance documentation of  msssql plugin
  • Loading branch information
arogge committed Jul 5, 2021
2 parents f6455ad + a9ec684 commit 0a3c617
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 7 deletions.
27 changes: 21 additions & 6 deletions docs/manuals/source/Appendix/Howtos.rst
Expand Up @@ -65,7 +65,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.
If you set the databases into the mentionend mode you have to consider some maintenance 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
| For connections you can use a SQL-User or a integrated systemaccount (Windows NT user). Both connection types are supported.
Expand Down Expand Up @@ -101,7 +101,7 @@ Install the Bareos filedaemon including the component "Bareos FileDameon Plugins
Manual install
''''''''''''''

After downloading the plugin you need to copy it into :file:`C:\Program Files\Bareos\Plugins`. Then you need to define the plugin directory and which plugin the bareos-filedaemon should use. You have to edit the bareos-filedaemon resource in :file:`C:\Program Data\bareos-fd.conf` as follows:
After downloading the plugin you need to copy it into :file:`C:\\Program Files\\Bareos\\Plugins`. Then you need to define the plugin directory and which plugin the bareos-filedaemon should use. You have to edit the bareos-filedaemon resource in :file:`C:\\Program Data\\bareos-fd.conf` as follows:

.. code-block:: bareosconfig
:caption: MSSQL plugin configuration
Expand Down Expand Up @@ -276,7 +276,7 @@ At least you gain a full backup which contains the follow:


After your first full backup you will be able to also run differential and incremental backups.
Differntial FileSet example:
Differential FileSet example:



Expand Down Expand Up @@ -314,14 +314,29 @@ replace=<yes|no>
With this option you can replace the database if it still exist.

instance
Defines the server instance whithin the database is running.
Defines the server instance within the database is running.

database
Defines the database you want to backup.

If you want to restore the actual backup to a set of backup files which you can use to restore a database under an new name or perform any kind of special operations using for example the sql management studio, you can use a where setting for the restore other then ’/’. When the where is set to ’/’ it will restore to the Virtual Device Interface (VDI).
Restore to local files
''''''''''''''''''''''
Sometimes it is desirable to restore the backup **into local files** instead of
restoring directly to the database server. This is useful to restore the
database **under a different name**, or perform any kind of special operations
using the sql management studio.

If the *where* parameter is set **to a directory** instead of '/', the plugin will
restore the backup as files into the given directory.

Example: If *where* is set to **’c:/temp’**, the plugin will restore the selected backup
files under a relocated path under c:/temp/@MSSQL@/...

If *where* is set to ’/’ it will restore to the Virtual Device Interface (VDI).


When you specify for restore a where path which is lets say ’c:/temp’ the plugin will restore the selected backup files under a relocated path under c:/temp/@MSSQL@/...
Restore to database
'''''''''''''''''''

Example for a full restore:

Expand Down
Expand Up @@ -197,7 +197,7 @@ The encoding of the bareos database must be :strong:`SQL_ASCII`. The command :co
template1 | postgres | UTF8
(4 rows)
The owner of the database may vary. The Bareos database maintance scripts don’t change the default owner of the Bareos database, so it stays at the PostgreSQL administration user. The :command:`grant_bareos_privileges` script grant the required permissions to the Bareos database user. In contrast, when installing (not updating) using :ref:`dbconfig <section-dbconfig>`, the database owner will be identical with the Bareos database user.
The owner of the database may vary. The Bareos database maintenance scripts don’t change the default owner of the Bareos database, so it stays at the PostgreSQL administration user. The :command:`grant_bareos_privileges` script grant the required permissions to the Bareos database user. In contrast, when installing (not updating) using :ref:`dbconfig <section-dbconfig>`, the database owner will be identical with the Bareos database user.

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`.

Expand Down

0 comments on commit 0a3c617

Please sign in to comment.