Add note about S3 keys urlencoding (#500)

This commit is contained in:
Osma Ahvenlampi 2023-02-07 18:57:55 +02:00 committed by GitHub
parent 21e286c5d2
commit 99a0a16fb7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -147,7 +147,8 @@ To use S3, provide a URL in one of these forms:
* ``s3://access-key:secret-key@endpoint-url/bucket-name`` * ``s3://access-key:secret-key@endpoint-url/bucket-name``
If you omit the keys or the endpoint URL, then Takahē will try to use implicit If you omit the keys or the endpoint URL, then Takahē will try to use implicit
authentication for them. authentication for them. The keys, if included, should be urlencoded, as AWS
secret keys commonly contain eg + characters.
Your S3 bucket *must* be set to allow publically-readable files, as Takahē will Your S3 bucket *must* be set to allow publically-readable files, as Takahē will
set all files it uploads to be ``public-read``. We randomise uploaded file set all files it uploads to be ``public-read``. We randomise uploaded file