Merge pull request #5033 from MichaelEischer/s3-clarify-docs

docs: make s3-compatible section standalone
This commit is contained in:
Michael Eischer 2024-09-02 00:14:31 +02:00 committed by GitHub
commit 3023b2f566
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 1 deletions

View File

@ -314,9 +314,17 @@ this command.
S3-compatible Storage 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``. 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=<YOUR-ACCESS-KEY-ID>
$ export AWS_SECRET_ACCESS_KEY=<YOUR-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 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 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, parameter like ``-o s3.region="us-east-1"``. If the region is not specified,