summaryrefslogtreecommitdiff
path: root/example
diff options
context:
space:
mode:
authorLibravatar CDN <cardinal@codeword.info>2024-07-31 20:44:18 +0800
committerLibravatar GitHub <noreply@github.com>2024-07-31 13:44:18 +0100
commit43519324b39de697e3403691fb286de03bf0d4d1 (patch)
tree5a179a34b7bff4e261b7cffaf700a96cbd18246c /example
parentFix no rows in result set error in emoji list command (#3152) (diff)
downloadgotosocial-43519324b39de697e3403691fb286de03bf0d4d1.tar.xz
[feature] Object store custom URL (S3) (#3046)
* tweaks * boobs * fix variable name + typo --------- Co-authored-by: tobi <tobi.smethurst@protonmail.com>
Diffstat (limited to 'example')
-rw-r--r--example/config.yaml33
1 files changed, 32 insertions, 1 deletions
diff --git a/example/config.yaml b/example/config.yaml
index 75d0587cf..60fdd88cc 100644
--- a/example/config.yaml
+++ b/example/config.yaml
@@ -551,11 +551,42 @@ storage-local-base-path: "/gotosocial/storage"
# Default: ""
storage-s3-endpoint: ""
-# Bool. If data stored in S3 should be proxied through GoToSocial instead of redirecting to a presigned URL.
+# Bool. Set this to true if data stored in S3 should be proxied through
+# GoToSocial instead of forwarding the request to a presigned URL.
+#
+# In most cases you won't need to touch this setting, but it might be useful
+# if it's not possible for your bucket provider to generate presigned URLs,
+# or if your bucket is not able to exposed to the wider internet.
#
# Default: false
storage-s3-proxy: false
+# String. URL to use a base for redirecting incoming media requests to.
+#
+# Must start with "http://" or "https://" and end without a trailing slash.
+#
+# DON'T SET THIS VALUE UNLESS YOU HAVE GOOD REASON TO! It's not necessary for
+# "normal" s3 usage, and most admins can happily just ignore this setting.
+#
+# If set, then media fileserver requests to your instance will be redirected
+# to this URL instead of your bucket URL, preserving relevant path parts.
+#
+# This is useful if you are using a CDN proxy in front of your S3 bucket, and you
+# want to serve media from the CDN rather than serving from your S3 bucket directly.
+#
+# For example, if you have your storage-s3-endpoint value set to "s3.my-storage.example.org",
+# and you have a CDN set up to proxy your bucket, serving from "cdn.some-fancy-host.org",
+# then you should set storage-s3-redirect-url to "https://cdn.some-fancy-host.org".
+#
+# This will allow your GoToSocial instance to *upload* data to "s3.my-storage.example.org",
+# but direct callers to *download* that data from "https://cdn.some-fancy-host.org".
+#
+# This value is ignored if storage-backend is not s3, or if storage-s3-proxy is true.
+#
+# Examples: ["https://cdn.some-fancy-host.org"]
+# Default: ""
+storage-s3-redirect-url: ""
+
# Bool. Use SSL for S3 connections.
#
# Only set this to 'false' when testing locally.