Merge pull request #41 from nspcc-dev/fix-readme-and-settings

Fix README and settings
This commit is contained in:
Evgeniy Kulikov 2021-02-02 13:53:56 +03:00 committed by GitHub
commit 0861d7bb9b
2 changed files with 8 additions and 4 deletions

View file

@ -8,7 +8,7 @@
--metrics enable prometheus metrics --metrics enable prometheus metrics
-h, --help show help -h, --help show help
-v, --version show version -v, --version show version
--neofs-key string set value to hex string, WIF string, or path to NeoFS private key file (use "generated" to generate key) (default "generated") --neofs-key string set value to hex string, WIF string, or path to NeoFS private key file
--auth-key string set path to file with auth (curve25519) private key to use in auth scheme --auth-key string set path to file with auth (curve25519) private key to use in auth scheme
--verbose set debug mode of gRPC connections --verbose set debug mode of gRPC connections
--request_timeout duration set gRPC request timeout (default 15s) --request_timeout duration set gRPC request timeout (default 15s)
@ -16,13 +16,16 @@
--rebalance_timer duration set gRPC connection rebalance timer (default 15s) --rebalance_timer duration set gRPC connection rebalance timer (default 15s)
--max_clients_count int set max-clients count (default 100) --max_clients_count int set max-clients count (default 100)
--max_clients_deadline duration set max-clients deadline (default 30s) --max_clients_deadline duration set max-clients deadline (default 30s)
-t, --con_ttl duration set gRPC connection time to live (default 5m0s)
--listen_address string set address to listen (default "0.0.0.0:8080") --listen_address string set address to listen (default "0.0.0.0:8080")
-p, --peers stringArray set NeoFS nodes -p, --peers stringArray set NeoFS nodes
-d, --listen_domains stringArray set domains to be listened
# Environments # Environments
S3_GW_AUTH-KEY = S3_GW_AUTH-KEY =
S3_GW_NEOFS-KEY = S3_GW_NEOFS-KEY =
S3_GW_CON_TTL = 5m0s
S3_GW_CONNECT_TIMEOUT = 30s S3_GW_CONNECT_TIMEOUT = 30s
S3_GW_REBALANCE_TIMER = 15s S3_GW_REBALANCE_TIMER = 15s
S3_GW_REQUEST_TIMEOUT = 15s S3_GW_REQUEST_TIMEOUT = 15s
@ -30,8 +33,10 @@ S3_GW_KEEPALIVE_PERMIT_WITHOUT_STREAM = true
S3_GW_KEEPALIVE_TIME = 10s S3_GW_KEEPALIVE_TIME = 10s
S3_GW_KEEPALIVE_TIMEOUT = 10s S3_GW_KEEPALIVE_TIMEOUT = 10s
S3_GW_LISTEN_ADDRESS = 0.0.0.0:8080 S3_GW_LISTEN_ADDRESS = 0.0.0.0:8080
S3_GW_LISTEN_DOMAINS = []
S3_GW_LOGGER_FORMAT = console S3_GW_LOGGER_FORMAT = console
S3_GW_LOGGER_LEVEL = debug S3_GW_LOGGER_LEVEL = debug
S3_GW_LOGGER_NO_CALLER = false
S3_GW_LOGGER_NO_DISCLAIMER = true S3_GW_LOGGER_NO_DISCLAIMER = true
S3_GW_LOGGER_SAMPLING_INITIAL = 1000 S3_GW_LOGGER_SAMPLING_INITIAL = 1000
S3_GW_LOGGER_SAMPLING_THEREAFTER = 1000 S3_GW_LOGGER_SAMPLING_THEREAFTER = 1000

View file

@ -17,7 +17,6 @@ import (
const ( const (
devNull = empty(0) devNull = empty(0)
generated = "generated"
minimumTTLInMinutes = 5 minimumTTLInMinutes = 5
@ -162,7 +161,7 @@ func newSettings() *viper.Viper {
help := flags.BoolP(cmdHelp, "h", false, "show help") help := flags.BoolP(cmdHelp, "h", false, "show help")
version := flags.BoolP(cmdVersion, "v", false, "show version") version := flags.BoolP(cmdVersion, "v", false, "show version")
flags.String(cfgNeoFSPrivateKey, generated, fmt.Sprintf(`set value to hex string, WIF string, or path to NeoFS private key file (use "%s" to generate key)`, generated)) flags.String(cfgNeoFSPrivateKey, "", "set value to hex string, WIF string, or path to NeoFS private key file")
flags.String(cfgGateAuthPrivateKey, "", "set path to file with auth (curve25519) private key to use in auth scheme") flags.String(cfgGateAuthPrivateKey, "", "set path to file with auth (curve25519) private key to use in auth scheme")
flags.Bool(cfgGRPCVerbose, false, "set debug mode of gRPC connections") flags.Bool(cfgGRPCVerbose, false, "set debug mode of gRPC connections")