octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-12-22 10:58:55 +00:00
Code Issues Releases Wiki Activity

doc: Update wording for S3 path-only requirement

Browse Source
This commit is contained in:
Wouter van Os 2021-01-31 15:10:03 +01:00 committed by GitHub
parent b5972f184c
commit 8442c43209
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/030_preparing_a_new_repo.rst
View File

@ -238,11 +238,12 @@ after the bucket name like this:
For an S3-compatible server that is not Amazon (like Minio, see below),
or is only available via HTTP, you can specify the URL to the server
like this: ``s3:http://server:port/bucket_name``.
.. note:: Currently, restic only supports defining the `path-style URLs <https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro>`__. Virtual-hosted–style URLs, where the bucket name is in the
hostname itself (like ``bucket_name.s3.us-west-2.amazonaws.com``),
is not supported. It should be written in the path-style URL instead,
for example ``s3.us-west-2.amazonaws.com/bucket_name``.
.. note:: restic expects `path-style URLs <https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro>`__
like for example ````s3.us-west-2.amazonaws.com/bucket_name``.
Virtual-hosted–style URLs like ``bucket_name.s3.us-west-2.amazonaws.com``,
where the bucket name is part of the hostname are not supported. These must
be converted to path-style URLs instead, for example ``s3.us-west-2.amazonaws.com/bucket_name``.
.. note:: Certain S3-compatible servers do not properly implement the
``ListObjectsV2`` API, most notably Ceph versions before v14.2.5. On these