upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-02-18 18:19:16 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add S3/B2 urls to documentation for repository urls, fixes #8833

Browse source
This commit is contained in:
Vaskebjoern 2025-05-19 08:41:07 +00:00 committed by GitHub
parent b73af3642d
commit 15e55bfd2e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/usage/general/repository-urls.rst.inc
View file

@ -30,6 +30,14 @@ For ssh and sftp URLs, the ``user@`` and ``:port`` parts are optional.
``rclone:remote:path`` - see the rclone docs for more details about remote:path.
**Remote repositories** accessed via S3:
``(s3|b2):[profile|(access_key_id:access_key_secret)@][schema://hostname[:port]]/bucket/path`` - see the boto3 docs for more details about the credentials.
If you're connecting to AWS S3, ``[schema://hostname[:port]]`` is optional, but ``bucket`` and ``path`` are always required.
Note: There is a known issue with some S3-compatible services, e.g., Backblaze B2. If you encounter problems, try using ``b2:`` instead of ``s3:`` in the url.
If you frequently need the same repo URL, it is a good idea to set the
``BORG_REPO`` environment variable to set a default for the repo URL: