From 99a0a16fb7c5ebd6f566e405602c29b62cd81e6b Mon Sep 17 00:00:00 2001 From: Osma Ahvenlampi Date: Tue, 7 Feb 2023 18:57:55 +0200 Subject: [PATCH] Add note about S3 keys urlencoding (#500) --- docs/installation.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index d1e3b55..104f5fd 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -147,7 +147,8 @@ To use S3, provide a URL in one of these forms: * ``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 -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 set all files it uploads to be ``public-read``. We randomise uploaded file