Skip to content

Commit

Permalink
docs: use sphinx linkcheck to fix broken links
Browse files Browse the repository at this point in the history
- Adding linkcheck options to conf.py
- Fix all broken link in documentation
- Increase clarity for Windows download location
- use short url for bareos domain: the redirection is excluded
  as error in linkcheck configuration.
- xca use github devel project

Sphinx linkcheck can be used during documentation build
```sphinx-build -M linkcheck docs/manuals/source docs/BareosMainReference -j2```

Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
  • Loading branch information
bruno-at-bareos and joergsteffens committed Jul 11, 2022
1 parent 6a41db3 commit 08225a3
Show file tree
Hide file tree
Showing 23 changed files with 90 additions and 41 deletions.
6 changes: 3 additions & 3 deletions docs/manuals/source/Appendix/OperatingSystems.rst
Expand Up @@ -18,7 +18,7 @@ Additionally, the following table gives an overview on the available package ver
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:`\ <single: Platform; Gentoo>`\ , `X <https://packages.gentoo.org/package/app-backup/bareos>`__, `X <https://packages.gentoo.org/package/app-backup/bareos>`__, `X <https://packages.gentoo.org/package/app-backup/bareos>`__
Gentoo :index:`\ <single: Platform; Gentoo>`\ , `X <https://packages.gentoo.org/packages/app-backup/bareos>`__, `X <https://packages.gentoo.org/packages/app-backup/bareos>`__, `X <https://packages.gentoo.org/packages/app-backup/bareos>`__
openSUSE, current, v12.4, v12.4, v12.4
RHEL, current, v12.4, v12.4, v12.4
SLES, current, v12.4, v12.4, v12.4
Expand Down Expand Up @@ -126,7 +126,7 @@ The Bareos version for the Univention App Center integraties into the Univention
Preamble
^^^^^^^^

The `Univention Corporate Server <http://www.univention.de/>`_ is an enterprise Linux distribution based on Debian. It consists of an integrated management system for the centralised administration of servers, computer workplaces, users and their rights as well as a wide range of server applications. It also includes an Unvention App Center for the easy installation and management of extensions and appliances.
The `Univention Corporate Server <https://www.univention.de/>`_ is an enterprise Linux distribution based on Debian. It consists of an integrated management system for the centralised administration of servers, computer workplaces, users and their rights as well as a wide range of server applications. It also includes an Unvention App Center for the easy installation and management of extensions and appliances.

Bareos is part of the `App Center <https://www.univention.de/produkte/univention-app-center/app-katalog/bareos/>`_ and therefore an Univention environment can easily be extended to provide backup functionality for the Univention servers as well as for the connected client systems. Using the Univention Management Console (UMC), you can also create backup jobs for client computers (Windows or Linux systems), without the need of editing configuration files.

Expand Down Expand Up @@ -383,7 +383,7 @@ Alternatively you can also set those UCR variables via commandline.
File: /etc/bareos/...
[ ok ] Reloading Bareos Director: bareos-dir.
When your login credentials are set, you can login into Bareos Webui by following the entry in your Administration UCS Overview or directly via https://<UCS_SERVER>/bareos-webui/.
When your login credentials are set, you can login into Bareos Webui by following the entry in your Administration UCS Overview or directly via https://UCS_SERVER/bareos-webui/.

.. image:: /include/images/univention-ucs-overview-administration.*
:width: 80.0%
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/source/Appendix/ReleaseNotes.rst
Expand Up @@ -7,7 +7,7 @@ Release Notes

.. warning::

While all the source code is published on `GitHub <https://github.com/bareos/bareos>`_, 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.
While all the source code is published on `GitHub <https://github.com/bareos/bareos/>`_, the releases of packages on https://download.bareos.org/ is limited to the initial versions of a major release. Later maintenance releases are only published on https://download.bareos.com/.


This information is also available as ``CHANGELOG.md`` in the corresponding branch of the `Bareos GitHub project`_
Expand Down
Expand Up @@ -15,7 +15,7 @@ For the test-environment, we use the minimal defines required to run the tests.
When interested in the cmake defines for the Bareos production packages,
please refer to the corresponding build descriptions:

* Debian Packages: `debian/rules <https://github.com/bareos/bareos/blob/master/core/debian/rules>`__
* Debian Packages: `debian/rules <https://github.com/bareos/bareos/blob/master/debian/rules>`__
* RPM Packages: `core/platforms/packaging/bareos.spec <https://github.com/bareos/bareos/blob/master/core/platforms/packaging/bareos.spec>`__


Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/source/DeveloperGuide/PythonBareos.rst
Expand Up @@ -25,7 +25,7 @@ Example:
>>> print(directorconsole.call('help').decode("utf-8"))
If you want to create a command line tool, the examples in
https://github.com/bareos/bareos/blob/master/python-bareos/bin/ might be useful.
https://github.com/bareos/bareos/tree/master/python-bareos/bin might be useful.



Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/source/DeveloperGuide/api.rst
Expand Up @@ -232,7 +232,7 @@ differs from API mode 1 in several aspects:

- JSON output
- The JSON output is in the format of JSON-RPC 2.0 responce objects
(http://www.jsonrpc.org/specification#response_object). This should
(https://www.jsonrpc.org/specification#response_object). This should
make it easier to implement a full JSON-RPC service later.
- No user interaction inside a command (meaning: if not all parameters
are given to a :bcommand:`run` command, the command fails).
Expand Down Expand Up @@ -405,7 +405,7 @@ Example of a JSON-RPC Error Response
''''''''''''''''''''''''''''''''''''

Example of a JSON-RPC Error Response
(http://www.jsonrpc.org/specification#error_object):
(https://www.jsonrpc.org/specification#error_object):

.. code-block:: bconsole
Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/source/DeveloperGuide/generaldevel.rst
Expand Up @@ -45,7 +45,7 @@ Also, include the Bareos copyright notice that can be found in every source file
Bug Database
------------

We have a bug database which is at https://bugs.bareos.org.
We have a bug database which is at https://bugs.bareos.org/.

The first thing is if you want to take over a bug, rather than just make
a note, you should assign the bug to yourself. This helps other
Expand Down Expand Up @@ -83,7 +83,7 @@ If the user has not properly filled in most of the important fields (platform, O
The same applies to a support request (we answer only bugs), you might give the user a tip, but please politely refer him to the manual, the `bareos-users`_ mailing list and maybe the `commercial support`_.

.. _bareos-users: https://groups.google.com/forum/#!forum/bareos-users
.. _commercial support: https://www.bareos.com/en/Support.html
.. _commercial support: https://www.bareos.com/product/support/

Reporting security issues
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/source/DeveloperGuide/gitworkflow.rst
Expand Up @@ -14,7 +14,7 @@ Basically this means we want you to create pull requests against our master bran
We will then build and review the code, request changes as required and eventually merge the pull request.
You may need to rebase and force-push during the review-phase as master is a moving target.

.. _Github Flow: https://help.github.com/en/articles/github-flow
.. _Github Flow: https://docs.github.com/en/get-started/quickstart/github-flow

Releases and Backporting
------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/source/DeveloperGuide/tests.rst
Expand Up @@ -13,7 +13,7 @@ Adding a new C++ Test
~~~~~~~~~~~~~~~~~~~~~
To add a new test, you create your sourcefiles in ``core/src/tests`` and register the test in ``CMakeLists.txt`` in that directory. The easiest way is to copy an existing test sourcefile and the related lines in ``core/src/CMakeLists.txt``.

For general advice on how to use the Google Test framework see this documentation: `Googletest Primer <https://github.com/google/googletest/blob/master/docs/primer.md>`_
For general advice on how to use the Google Test framework see this documentation: `Googletest Primer <https://github.com/google/googletest/blob/main/docs/primer.md>`_

Adding tests in general
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Expand Up @@ -4,7 +4,7 @@ Issues tracked on Mantis
bugs.bareos.org
---------------

If you want to reference an issue that is tracked on https://bugs.bareos.org, the following formatting should be used:
If you want to reference an issue that is tracked on https://bugs.bareos.org/, the following formatting should be used:

.. literalinclude:: /DocumentationStyleGuide/example/mantis-issue.rst.inc
:language: none
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/source/DocumentationStyleGuide/Gotchas.rst
Expand Up @@ -74,6 +74,6 @@ toctree
------------

Don't use the ``:options:`` role, as this tries to refers to a option definition, which we don't have.
Also, as we document different programs, using option would require to prefix it with the program name, see https://www.sphinx-doc.org/en/1.7/domains.html#directive-program.
Also, as we document different programs, using option would require to prefix it with the program name, see https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program.

This only applies to ``:options:`` without domain. We do you ``:config:option:`` in :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:Bareos Configuration`.
4 changes: 2 additions & 2 deletions docs/manuals/source/DocumentationStyleGuide/RestOverview.rst
Expand Up @@ -228,7 +228,7 @@ Valid values for the highlighting language are:
* ``rest``
* ``c``
* ... and any other `lexer alias that Pygments supports
<http://pygments.org/docs/lexers/>`_.
<https://pygments.org/docs/lexers/>`_.

If the text resides in a seperate file, use::

Expand Down Expand Up @@ -658,7 +658,7 @@ In general, images should be stored as SVG.
Table
-----

Sphinx offers multiple methods to create tables, see https://www.sphinx-doc.org/en/2.0/usage/restructuredtext/basics.html#tables\ .
Sphinx offers multiple methods to create tables, see https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#tables\ .

Choose whatever sucks least.

Expand Down
Expand Up @@ -36,7 +36,7 @@ This will start a very basic Bareos installation which will regularly backup a d
Decide about the Bareos release to use
--------------------------------------

You’ll find Bareos binary package repositories at https://download.bareos.org/. The stable releases are available at https://download.bareos.org/bareos/release/.
You’ll find Bareos binary package repositories at https://download.bareos.org/bareos/. The stable releases are available at https://download.bareos.org/bareos/release/.

The public key to verify the repository is also in repository directory (:file:`Release.key` for Debian based distributions, :file:`repodata/repomd.xml.key` for RPM based distributions).

Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/source/IntroductionAndTutorial/WhatIsBareos.rst
Expand Up @@ -14,9 +14,9 @@ In technical terms, it is a network Client/Server based backup program. Bareos i
History
-------

Bareos is a `fork <http://www.bareos.org/en/faq/why_fork.html>`_ of the open source project `Bacula <http://www.bacula.org>`_ version 5.2. In 2010 the Bacula community developer Marco van Wieringen started to collect rejected or neglected community contributions in his own branch. This branch was later on the base of Bareos and since then was enriched by a lot of new features.
Bareos is a fork of the open source project `Bacula <https://www.bacula.org>`_ version 5.2. In 2010 the Bacula community developer Marco van Wieringen started to collect rejected or neglected community contributions in his own branch. This branch was later on the base of Bareos and since then was enriched by a lot of new features.

This documentation also bases on the `original Bacula documentation <http://www.bacula.org/5.2.x-manuals/en/main/main/>`_, it is technically also a fork of the documenation created following the rules of the GNU Free Documentation License.
This documentation also bases on the `original Bacula documentation <https://www.bacula.org/5.2.x-manuals/en/main/main/>`_, it is technically also a fork of the documenation created following the rules of the GNU Free Documentation License.

Original author of Bacula and its documentation is Kern Sibbald. We thank Kern and all contributors to Bacula and it’s documentation. We maintain a list of contributors to Bacula (until the time we’ve started the fork) and Bareos in our `AUTHORS <https://github.com/bareos/bareos/blob/master/AUTHORS>`_ file.

Expand Down
Expand Up @@ -505,7 +505,7 @@ Tapespeed and blocksizes
:index:`\ <single: Tape; speed>`
:index:`\ <single: Blocksize; optimize>`

The `Bareos Whitepaper Tape Speed Tuning <http://www.bareos.org/en/Whitepapers/articles/Speed_Tuning_of_Tape_Drives.html>`_ 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 <https://www.bareos.com/whitepapers/optimizing-the-tape-speed.pdf>`_ 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.
Expand Down
6 changes: 3 additions & 3 deletions docs/manuals/source/TasksAndConcepts/CatalogMaintenance.rst
Expand Up @@ -138,7 +138,7 @@ If this works on your system can be verified by
su - postgres
psql
If your database is configured to require a password, this must be defined in the file `:file:`~/.pgpass` <https://postgresql.org/docs/current/static/libpq-pgpass.html>`_ in the following syntax: :strong:`HOST:PORT:DATABASE:USER:PASSWORD`, e.g.
If your database is configured to require a password, this must be defined in the file `:file:`~/.pgpass` <https://www.postgresql.org/docs/current/libpq-pgpass.html>`_ in the following syntax: :strong:`HOST:PORT:DATABASE:USER:PASSWORD`, e.g.

.. code-block:: cfg
:caption: PostgreSQL access credentials
Expand Down Expand Up @@ -476,7 +476,7 @@ Depending on the size of your database, this will take more or less time and a f

Except from special cases PostgreSQL does not need to be dumped/restored to keep the database efficient. A normal process of vacuuming will prevent the database from getting too large. If you want to fine-tweak the database storage, commands such as VACUUM, VACUUM FULL, REINDEX, and CLUSTER exist specifically to keep you from having to do a dump/restore.

More details on this subject can be found in the PostgreSQL documentation. The page https://www.postgresql.org/docs/ contains links to the documentation for all PostgreSQL versions. The section *Routine Vacuuming* explains how VACUUM works and why it is required, see http://www.postgresql.org/docs/current/static/routine-vacuuming.html for the current PostgreSQL version.
More details on this subject can be found in the PostgreSQL documentation. The page https://www.postgresql.org/docs/ contains links to the documentation for all PostgreSQL versions. The section *Routine Vacuuming* explains how VACUUM works and why it is required, see https://www.postgresql.org/docs/current/routine-vacuuming.html for the current PostgreSQL version.

.. _PostgresSize:

Expand All @@ -498,7 +498,7 @@ The reason for autovacuuming not being triggered is then probably the default se
In essence, this means that a VACUUM is only triggered when 20% of table size are obsolete. Consequently, the larger the table is, the less frequently VACUUM will be triggered by autovacuum. This make sense because vacuuming has a performance impact. While it is possible to override the autovacuum parameters on a table-by-table basis, it can then still be triggered at any time.

To learn more details about autovacuum see https://www.postgresql.org/docs/current/static/routine-vacuuming.html#AUTOVACUUM
To learn more details about autovacuum see https://www.postgresql.org/docs/current/routine-vacuuming.html#AUTOVACUUM

The following example shows how to configure running VACUUM on the file table by using an admin-job in Bareos. The job will be scheduled to run at a time that should not run in parallel with normal backup jobs, here by scheduling it to run after the BackupCatalog job.

Expand Down
Expand Up @@ -14,7 +14,7 @@ NDMP

- is widely used by storage product vendors and OS vendors like NetApp, Isilon, EMC, Oracle.

- information is available at http://www.ndmp.org/.
- information is available at https://www.snia.org/ndmp.

- version is currently (2016) NDMP Version 4.

Expand Down Expand Up @@ -529,7 +529,7 @@ UPDATE
Example NDMP Fileset to backup a subset of a NDMP filesystem
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

The following fileset is intended to backup all files and directories matching :file:`/ifs/home/users/a*`. It has been tested against Isilon OneFS 7.2.0.1. See `Isilon OneFS 7.2.0 CLI Administration Guide <https://www.emc.com/collateral/TechnicalDocument/docu56048.pdf>`_, section quote{NDMP environment variables} for details about the supported NDMP environment variables. Excludes are not used in this example.
The following fileset is intended to backup all files and directories matching :file:`/ifs/home/users/a*`. It has been tested against Isilon OneFS 7.2.0.1. See `Isilon OneFS Administration Guide <https://www.delltechnologies.com/asset/en-us/products/storage/technical-support/isilon-quick-reference-guide-for-administrators.pdf>`_, section quote{NDMP environment variables} for details about the supported NDMP environment variables. Excludes are not used in this example.

.. code-block:: bareosconfig
:caption: NDMP Fileset Isilon Include/Exclude
Expand Down
Expand Up @@ -472,5 +472,5 @@ following Plugin Option must be entered:
Anything else from the restore dialogue is the same.

This will create disk image files that could be examined for example by using
the **guestfish** tool (see http://libguestfs.org/guestfish.1.html). This tool
the **guestfish** tool (see https://libguestfs.org/guestfish.1.html). This tool
can also be used to extract single files from the disk image.
Expand Up @@ -30,7 +30,7 @@ Incremental backups only work for INNODB tables, when using MYISAM, only full ba
Prerequisites of percona XtraBackup Plugin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

For authentication the :file:`.mycnf` file of the user running the |fd| is used. Before proceeding, make sure that XtraBackup can connect to the database and create backups.

Expand Down Expand Up @@ -110,7 +110,7 @@ This example shows the restore tree for restore job with ID 351. First subdirect

Next line is the first incremental job with ID 335, starting at LSN 10129154 until 10142295. The third line is the 2nd incremental job with ID 338.

To further prepare the restored files, use the :command:`XtraBackup --prepare` command. Read https://www.percona.com/doc/percona-xtrabackup/2.4/backup_scenarios/incremental_backup.html for more information.
To further prepare the restored files, use the :command:`XtraBackup --prepare` command. For more information read https://docs.percona.com/percona-xtrabackup/2.4/backup_scenarios/incremental_backup.html.


Troubleshooting
Expand Down

0 comments on commit 08225a3

Please sign in to comment.