From 8b36144ab00804cd5f29523313c7405a0b812f10 Mon Sep 17 00:00:00 2001 From: Jos Craw Date: Sun, 26 Feb 2023 10:47:18 +1300 Subject: [PATCH] chore: added docs for overall config Signed-off-by: Jos Craw --- docs/features/techdocs/configuration.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/features/techdocs/configuration.md b/docs/features/techdocs/configuration.md index e95db2fad0..49ee9d72c2 100644 --- a/docs/features/techdocs/configuration.md +++ b/docs/features/techdocs/configuration.md @@ -136,6 +136,11 @@ techdocs: # https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html#endpoint endpoint: ${AWS_ENDPOINT} + # (Optional) HTTPS proxy to use for S3 Requests + # Defaults to using no proxy + # This allows docs to be published and read from behind a proxy + httpsProxy: ${HTTPS_PROXY} + # (Optional) Whether to use path style URLs when communicating with S3. # Defaults to false. # This allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used to host tech docs.