Skip to content

Commit

Permalink
Improve wording for backup sources conf setup (#3944)
Browse files Browse the repository at this point in the history
* better wording

* Update devops/backup_sources/sources_backup.rst

---------

Co-authored-by: Carlos Zoido <[email protected]>
  • Loading branch information
AbrilRBS and czoido authored Dec 11, 2024
1 parent cc9239d commit 9d79072
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion devops/backup_sources/sources_backup.rst
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

0 comments on commit 9d79072

Please sign in to comment.