Clean up [upload] config doc

This commit is contained in:
Kailash Nadh 2020-04-01 19:59:41 +05:30
parent 9dcd716f91
commit 21ffe5fb02
1 changed files with 31 additions and 25 deletions

View File

@ -111,32 +111,38 @@ max_idle = 10
# Maximum concurrent connections to the SMTP server. # Maximum concurrent connections to the SMTP server.
max_conns = 10 max_conns = 10
# Upload settings
[upload] [upload]
# Provider which will be used to host uploaded media. Bundled providers are "filesystem" and "s3". # File storage backend. "filesystem" or "s3".
provider = "filesystem" provider = "filesystem"
# S3 Provider settings
[upload.s3] [upload.s3]
# (Optional). AWS Access Key and Secret Key for the user to access the bucket. Leaving it empty would default to use # (Optional). AWS Access Key and Secret Key for the user to access the bucket.
# instance IAM role. # Leaving it empty would default to use instance IAM role.
aws_access_key_id = "" aws_access_key_id = ""
aws_secret_access_key = "" aws_secret_access_key = ""
# AWS Region where S3 bucket is hosted. # AWS Region where S3 bucket is hosted.
aws_default_region="ap-south-1" aws_default_region="ap-south-1"
# Specify bucket name.
# Bucket name.
bucket="" bucket=""
# Path where the files will be stored inside bucket. Empty value ("") means the root of bucket.
# Path where the files will be stored inside bucket. Empty for root.
bucket_path="" bucket_path=""
# Bucket type can be "private" or "public".
# "private" or "public".
bucket_type="public" bucket_type="public"
# (Optional) Specify TTL (in seconds) for the generated presigned URL. Expiry value is used only if the bucket is private.
# (Optional) Specify TTL (in seconds) for the generated presigned URL.
# Expiry value is used only if the bucket is private.
expiry="86400" expiry="86400"
# Filesystem provider settings
[upload.filesystem] [upload.filesystem]
# Path to the uploads directory where media will be uploaded. Leaving it empty ("") means current working directory. # Path to the uploads directory where media will be uploaded.
upload_path="" upload_path="./uploads"
# Upload URI that's visible to the outside world. The media uploaded to upload_path will be made available publicly
# Upload URI that's visible to the outside world.
# The media uploaded to upload_path will be made available publicly
# under this URI, for instance, list.yoursite.com/uploads. # under this URI, for instance, list.yoursite.com/uploads.
upload_uri = "/uploads" upload_uri = "/uploads"