From 21ffe5fb02256a6e391b5e2ebe11554badee5ee5 Mon Sep 17 00:00:00 2001 From: Kailash Nadh Date: Wed, 1 Apr 2020 19:59:41 +0530 Subject: [PATCH] Clean up [upload] config doc --- config.toml.sample | 56 +++++++++++++++++++++++++--------------------- 1 file changed, 31 insertions(+), 25 deletions(-) diff --git a/config.toml.sample b/config.toml.sample index 962c4ca..fb0bd2f 100644 --- a/config.toml.sample +++ b/config.toml.sample @@ -111,32 +111,38 @@ max_idle = 10 # Maximum concurrent connections to the SMTP server. max_conns = 10 -# Upload settings + [upload] -# Provider which will be used to host uploaded media. Bundled providers are "filesystem" and "s3". +# File storage backend. "filesystem" or "s3". provider = "filesystem" -# S3 Provider settings -[upload.s3] -# (Optional). AWS Access Key and Secret Key for the user to access the bucket. Leaving it empty would default to use -# instance IAM role. -aws_access_key_id = "" -aws_secret_access_key = "" -# AWS Region where S3 bucket is hosted. -aws_default_region="ap-south-1" -# Specify bucket name. -bucket="" -# Path where the files will be stored inside bucket. Empty value ("") means the root of bucket. -bucket_path="" -# Bucket type can be "private" or "public". -bucket_type="public" -# (Optional) Specify TTL (in seconds) for the generated presigned URL. Expiry value is used only if the bucket is private. -expiry="86400" + [upload.s3] + # (Optional). AWS Access Key and Secret Key for the user to access the bucket. + # Leaving it empty would default to use instance IAM role. + aws_access_key_id = "" + aws_secret_access_key = "" -# Filesystem provider settings -[upload.filesystem] -# Path to the uploads directory where media will be uploaded. Leaving it empty ("") means current working directory. -upload_path="" -# 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. -upload_uri = "/uploads" + # AWS Region where S3 bucket is hosted. + aws_default_region="ap-south-1" + + # Bucket name. + bucket="" + + # Path where the files will be stored inside bucket. Empty for root. + bucket_path="" + + # "private" or "public". + bucket_type="public" + + # (Optional) Specify TTL (in seconds) for the generated presigned URL. + # Expiry value is used only if the bucket is private. + expiry="86400" + + [upload.filesystem] + # Path to the uploads directory where media will be uploaded. + upload_path="./uploads" + + # 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. + upload_uri = "/uploads"