From c9fabbe833787738b1f32a72fb5dafba10666e88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20Fr=C3=B6hlich?= Date: Sun, 25 Jan 2026 16:54:05 +0100 Subject: [PATCH 1/3] Add a note that you need to install boto3 if you want to use s3/b2 URLs in the docs Add boto3 to dev dependencies --- docs/usage/general/repository-urls.rst.inc | 2 ++ requirements.d/development.txt | 1 + 2 files changed, 3 insertions(+) diff --git a/docs/usage/general/repository-urls.rst.inc b/docs/usage/general/repository-urls.rst.inc index 5cda0aaa26..11da73a101 100644 --- a/docs/usage/general/repository-urls.rst.inc +++ b/docs/usage/general/repository-urls.rst.inc @@ -38,6 +38,8 @@ If you are connecting to AWS S3, ``[schema://hostname[:port]]`` is optional, but 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. +Note: ``boto3`` is required to use s3 repositories. Install it with `pip install boto3` in your venv + If you frequently need the same repository URL, it is a good idea to set the ``BORG_REPO`` environment variable to set a default repository URL: diff --git a/requirements.d/development.txt b/requirements.d/development.txt index 96c20f0f18..c4ced68656 100644 --- a/requirements.d/development.txt +++ b/requirements.d/development.txt @@ -14,3 +14,4 @@ pytest-benchmark Cython pre-commit bandit[toml] +boto3 From 246faa1a923b28ea0dbc50e00805b2bab8eb6b4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20Fr=C3=B6hlich?= Date: Sun, 25 Jan 2026 19:40:41 +0100 Subject: [PATCH 2/3] Update installation instructions --- docs/installation.rst | 4 ++++ docs/usage/general/repository-urls.rst.inc | 1 - requirements.d/development.txt | 1 - 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 0e9fd92b3e..aa09d04787 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -180,6 +180,10 @@ development header files (sometimes in a separate `-dev` or `-devel` package). - llfuse_ >= 1.3.8 (for fuse 2, use `pip install borgbackup[llfuse]`). - Additionally, your OS will need to have FUSE support installed (e.g. a package `fuse` for fuse 2 or a package `fuse3` for fuse 3 support). +* Optionally, if you wish to use S3 Backend: + - borgstore[s3] ~= 0.3.0 (use `pip install borgbackup[s3]`) +* Optionally, if you wish to use SFTP Backend: + - borgstore[sftp] ~= 0.3.0 (use `pip install borgbackup[sftp]`) If you have troubles finding the right package names, have a look at the distribution specific sections below or the Vagrantfile in the git repository, diff --git a/docs/usage/general/repository-urls.rst.inc b/docs/usage/general/repository-urls.rst.inc index 11da73a101..1a68fe9989 100644 --- a/docs/usage/general/repository-urls.rst.inc +++ b/docs/usage/general/repository-urls.rst.inc @@ -38,7 +38,6 @@ If you are connecting to AWS S3, ``[schema://hostname[:port]]`` is optional, but 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. -Note: ``boto3`` is required to use s3 repositories. Install it with `pip install boto3` in your venv If you frequently need the same repository URL, it is a good idea to set the diff --git a/requirements.d/development.txt b/requirements.d/development.txt index c4ced68656..96c20f0f18 100644 --- a/requirements.d/development.txt +++ b/requirements.d/development.txt @@ -14,4 +14,3 @@ pytest-benchmark Cython pre-commit bandit[toml] -boto3 From bddce9793edb129ade8fd88424a857ae758fd3a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabian=20Fr=C3=B6hlich?= Date: Sun, 25 Jan 2026 20:09:40 +0100 Subject: [PATCH 3/3] Update docs --- docs/installation.rst | 2 +- docs/usage/general/repository-urls.rst.inc | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index aa09d04787..002b5b50f6 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -180,7 +180,7 @@ development header files (sometimes in a separate `-dev` or `-devel` package). - llfuse_ >= 1.3.8 (for fuse 2, use `pip install borgbackup[llfuse]`). - Additionally, your OS will need to have FUSE support installed (e.g. a package `fuse` for fuse 2 or a package `fuse3` for fuse 3 support). -* Optionally, if you wish to use S3 Backend: +* Optionally, if you wish to use S3/B2 Backend: - borgstore[s3] ~= 0.3.0 (use `pip install borgbackup[s3]`) * Optionally, if you wish to use SFTP Backend: - borgstore[sftp] ~= 0.3.0 (use `pip install borgbackup[sftp]`) diff --git a/docs/usage/general/repository-urls.rst.inc b/docs/usage/general/repository-urls.rst.inc index 1a68fe9989..5cda0aaa26 100644 --- a/docs/usage/general/repository-urls.rst.inc +++ b/docs/usage/general/repository-urls.rst.inc @@ -39,7 +39,6 @@ If you are connecting to AWS S3, ``[schema://hostname[:port]]`` is optional, but 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 repository URL, it is a good idea to set the ``BORG_REPO`` environment variable to set a default repository URL: