summaryrefslogtreecommitdiff
path: root/docs/configuration/storage.md
diff options
context:
space:
mode:
authorLibravatar firescry <49809580+firescry@users.noreply.github.com>2023-07-12 10:28:41 +0200
committerLibravatar GitHub <noreply@github.com>2023-07-12 10:28:41 +0200
commit8d92b2479f810bc5d20245361fa59339763a1495 (patch)
tree05b95d76a0fb7cc683a2f8a81ea40fec8fb8873a /docs/configuration/storage.md
parentBump semver from 6.3.0 to 6.3.1 in /web/source (#1981) (diff)
downloadgotosocial-8d92b2479f810bc5d20245361fa59339763a1495.tar.xz
[bugfix] Align default values in the configuration file with the code (#1971)
* Set default value of SMTPFrom to empty string This parameter should contain proper e-mail address (to be provided by user during configuration). * Update default values in example/config.yaml Default values and related comments in example/config.yaml are aligned with values defined in internal/config/defaults.go. Small improvements to foramting of config.yaml file. * Add default value for AdvancedThrottlingRetryAfter to internal/config/defaults.go AdvancedThrottlingRetryAfter was introduced in 70739d3 (superseriousbusiness/gotosocial#1466). * Update config.yaml snippets in documentation
Diffstat (limited to 'docs/configuration/storage.md')
-rw-r--r--docs/configuration/storage.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/configuration/storage.md b/docs/configuration/storage.md
index 9808669f9..e8715f48a 100644
--- a/docs/configuration/storage.md
+++ b/docs/configuration/storage.md
@@ -24,11 +24,9 @@ storage-local-base-path: "/gotosocial/storage"
# String. API endpoint of the S3 compatible service.
# Only required when running with the s3 storage backend.
-#
-# If your endpoint contains the bucket name, all files will be put into a
-# subdirectory with the name of `storage-s3-bucket`
-#
# Examples: ["minio:9000", "s3.nl-ams.scw.cloud", "s3.us-west-002.backblazeb2.com"]
+# GoToSocial uses "DNS-style" when accessing buckets.
+# If you are using Scaleways object storage, please remove the "bucket name" from the endpoint address
# Default: ""
storage-s3-endpoint: ""
@@ -36,6 +34,7 @@ storage-s3-endpoint: ""
#
# Default: false
storage-s3-proxy: false
+
# Bool. Use SSL for S3 connections.
#
# Only set this to 'false' when testing locally.
@@ -49,12 +48,14 @@ storage-s3-use-ssl: true
# Examples: ["AKIAJSIE27KKMHXI3BJQ","miniouser"]
# Default: ""
storage-s3-access-key: ""
+
# String. Secret key part of the S3 credentials.
# Consider setting this value using environment variables to avoid leaking it via the config file
# Only required when running with the s3 storage backend.
# Examples: ["5bEYu26084qjSFyclM/f2pz4gviSfoOg+mFwBH39","miniopassword"]
# Default: ""
storage-s3-secret-key: ""
+
# String. Name of the storage bucket.
#
# If you have already encoded your bucket name in the storage-s3-endpoint, this