From 15e55bfd2e884d0dc0a248d9d7012b82b2084c40 Mon Sep 17 00:00:00 2001
From: Vaskebjoern <190291379+vaskebjoern@users.noreply.github.com>
Date: Mon, 19 May 2025 08:41:07 +0000
Subject: [PATCH] docs: add S3/B2 urls to documentation for repository urls,
 fixes #8833

---
 docs/usage/general/repository-urls.rst.inc | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/docs/usage/general/repository-urls.rst.inc b/docs/usage/general/repository-urls.rst.inc
index 17f9560b9..f7209c770 100644
--- a/docs/usage/general/repository-urls.rst.inc
+++ b/docs/usage/general/repository-urls.rst.inc
@@ -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: