From ebd8f0c74ab46f658e04474594afca68e1e6b11c Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sat, 31 Aug 2024 19:39:30 +0200 Subject: [PATCH] docs: make s3-compatible section standalone --- doc/030_preparing_a_new_repo.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/030_preparing_a_new_repo.rst b/doc/030_preparing_a_new_repo.rst index fd5b31127..3dc107456 100644 --- a/doc/030_preparing_a_new_repo.rst +++ b/doc/030_preparing_a_new_repo.rst @@ -314,9 +314,17 @@ this command. S3-compatible Storage ********************* -For an S3-compatible server that is not Amazon, you can specify the URL to the server +For an S3-compatible storage service that is not Amazon, you can specify the URL to the server like this: ``s3:https://server:port/bucket_name``. +You must also set credentials for authentication to the service. + +.. code-block:: console + + $ export AWS_ACCESS_KEY_ID= + $ export AWS_SECRET_ACCESS_KEY= + $ restic -r s3:https://server:port/bucket_name init + If needed, you can manually specify the region to use by either setting the environment variable ``AWS_DEFAULT_REGION`` or calling restic with an option parameter like ``-o s3.region="us-east-1"``. If the region is not specified,