From 671034a03198b840c2036eac39c275f63d690c67 Mon Sep 17 00:00:00 2001 From: Ben McClelland Date: Fri, 5 Apr 2024 20:06:24 -0700 Subject: [PATCH] feat: add new config options to example This adds some new setting options and explanations to the example service config. --- extra/example.conf | 41 ++++++++++++++++++++++++++++++++++------- 1 file changed, 34 insertions(+), 7 deletions(-) diff --git a/extra/example.conf b/extra/example.conf index eac1128..9378e1f 100644 --- a/extra/example.conf +++ b/extra/example.conf @@ -121,28 +121,55 @@ ROOT_SECRET_ACCESS_KEY= # Event Logs # ############## +# The gateway events are similar to AWS S3 events, and are documented in the +# wiki: +# https://github.com/versity/versitygw/wiki/Events-Notifications. + +# The VGW_EVENT_FILTER option specifies a config file that contains the +# event filter rules. The event filter rules are used to determine which +# events are sent to the configured event services. +# Use the following to generate a default rules file in /etc/versitygw.d/: +# versitygw utils gen-event-filter-config -p /etc/versitygw.d +# The resulting file, /etc/versitygw.d/event_config.json, can be modified and +# specified in the VGW_EVENT_FILTER option. +# When VGW_EVENT_FILTER is not specified, all events are sent to the configured +# event service. +#VGW_EVENT_FILTER= + # Bucket events can be sent to a Kafka message bus. When VGW_EVENT_KAFKA_URL, # VGW_EVENT_KAFKA_TOPIC, and optionally VGW_EVENT_KAFKA_KEY are specified, all -# bucket events will be sent to the kafka service. The gateway events are -# similar to AWS S3 events, and are documented in the wiki: -# https://github.com/versity/versitygw/wiki/Events-Notifications. +# configured bucket events will be sent to the kafka service. #VGW_EVENT_KAFKA_URL= #VGW_EVENT_KAFKA_TOPIC= #VGW_EVENT_KAFKA_KEY= # Bucket events can be sent to a NATS messaging service. When VGW_EVENT_NATS_URL -# and VGW_EVENT_NATS_TOPIC are specified, all bucket events will be sent to the -# the NATS messaging service. The gateway events are similar to AWS S3 events, -# and are documented in the wiki: -# https://github.com/versity/versitygw/wiki/Events-Notifications. +# and VGW_EVENT_NATS_TOPIC are specified, all configured bucket events will be +# sent to the the NATS messaging service. #VGW_EVENT_NATS_URL= #VGW_EVENT_NATS_TOPIC= +# Bucket events can be sent to a webhook. When VGW_EVENT_WEBHOOK_URL is +# specified, all configured bucket events will be sent to the webhook. +#VGW_EVENT_WEBHOOK_URL= + +####################### +# Debug / Diagnostics # +####################### + # The VGW_DEBUG option enables verbose debug log output to stdout. This output # includes details for signature verification steps. This is generally only # useful for debugging the S3 server, and should not be used in production. #VGW_DEBUG=false +# The VGW_PPROF option enables the pprof HTTP server for profiling the S3 +# server. See the following for more information: +# https://pkg.go.dev/net/http/pprof +# To enable, set the VGW_PPROF option to the listening address for the pprof +# server. For example, to listen on localhost port 6060, set the option to +# "localhost:6060". +#VGW_PPROF= + ################ # IAM services # ################