Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve wording for backup sources conf setup #3944

Merged
merged 2 commits into from
Dec 11, 2024
Merged

Improve wording for backup sources conf setup #3944

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
575b395
better wording
AbrilRBS Dec 10, 2024
6dcf9b2
Update devops/backup_sources/sources_backup.rst
czoido Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion devops/backup_sources/sources_backup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,18 @@ Setting up the necessary configs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The :ref:`global.conf<reference_config_files_global_conf>` file should contain the
``core.sources:download_urls``
``core.sources:download_urls`` if downloading from a custom backup source remote is desired,
and ``core.sources:download_cache`` if a custom local cache path to download the backups to is desired.

.. code-block:: text
:caption: global.conf

core.sources:download_urls=["https://myteam.myorg.com/artifactory/backup-sources/", "origin"]
core.sources:download_cache=/path/to/backup/sources

.. note::

Either ``core.sources:download_urls`` or ``core.sources:download_cache`` should be defined for the feature to be enabled.

You might want to add extra confs based on your use case, as described :ref:`in the beginning of this document<backup_sources_config>`.

Expand Down