ironbee/frostfs-http-gw
1
0
Fork 0
forked from TrueCloudLab/frostfs-http-gw
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README

Browse source 
Signed-off-by: Evgeniy Kulikov <kim@nspcc.ru>
This commit is contained in:
Evgeniy Kulikov 2020-12-02 12:20:21 +03:00
parent 8bd210d67e
commit 65a5a3f9fc
No known key found for this signature in database
GPG key ID: BF6AEE0A2A699BF2
2 changed files with 26 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -24,21 +24,31 @@ You can download files from NeoFS Network using NeoFS Gate.
# Environments: # Environments:
GW_KEY=stirng - "generated" to generate key, path to private key file, hex string or wif (default "generated") HTTP_GW_KEY=string - "generated" to generate key, path to private key file, hex string or wif (default "generated")
GW_REQUEST_TIMEOUT=Duration - timeout for request HTTP_GW_CONNECT_TIMEOUT=Duration - timeout for connection
GW_CONNECT_TIMEOUT=Duration - timeout for connection HTTP_GW_REQUEST_TIMEOUT=Duration - timeout for request
GW_LISTEN_ADDRESS=host:port - address to listen connections HTTP_GW_REBALANCE_TIMER=Duration - time between connections checks
GW_PEERS_<X>_ADDRESS=host:port - address of NeoFS Node HTTP_GW_LISTEN_ADDRESS=host:port - address to listen connections
GW_PEERS_<X>_WEIGHT=float - weight of NeoFS Node HTTP_GW_PEERS_<X>_ADDRESS=host:port - address of NeoFS Node
GW_PPROF=bool - enable/disable pprof (/debug/pprof) HTTP_GW_PEERS_<X>_WEIGHT=float - weight of NeoFS Node
GW_METRICS=bool - enable/disable prometheus metrics endpoint (/metrics) HTTP_GW_PPROF=bool - enable/disable pprof (/debug/pprof)
GW_KEEPALIVE_TIME=Duration - аfter a duration of this time if the client doesn't see any activity HTTP_GW_METRICS=bool - enable/disable prometheus metrics endpoint (/metrics)
HTTP_GW_LOGGER_FORMAT=string - logger format
HTTP_GW_LOGGER_LEVEL=string - logger level
HTTP_GW_LOGGER_NO_CALLER=bool - logger don't show caller
HTTP_GW_LOGGER_NO_DISCLAIMER=bool - logger don't show application name/version
HTTP_GW_LOGGER_SAMPLING_INITIAL=int - logger sampling initial
HTTP_GW_LOGGER_SAMPLING_THEREAFTER=int - logger sampling thereafter
HTTP_GW_LOGGER_TRACE_LEVEL=string - logger show trace on level
HTTP_GW_KEEPALIVE_TIME=Duration - аfter a duration of this time if the client doesn't see any activity
it pings the server to see if the transport is still alive. it pings the server to see if the transport is still alive.
GW_KEEPALIVE_TIMEOUT=Duration - after having pinged for keepalive check, the client waits for a duration HTTP_GW_KEEPALIVE_TIMEOUT=Duration - after having pinged for keepalive check, the client waits for a duration
of Timeout and if no activity is seen even after that the connection is closed of Timeout and if no activity is seen even after that the connection is closed
GW_KEEPALIVE_PERMIT_WITHOUT_STREAM=Bool - if true, client sends keepalive pings even with no active RPCs. HTTP_GW_KEEPALIVE_PERMIT_WITHOUT_STREAM=Bool - if true, client sends keepalive pings even with no active RPCs.
If false, when there are no active RPCs, Time and Timeout will be ignored and no keepalive pings will be sent. If false, when there are no active RPCs, Time and Timeout will be ignored and no keepalive pings will be sent.
```
### WARNING Peers preset:
`generated` value for `GW_KEY` or `--key` is deprecated, you should use pre-generated keys.
HTTP_GW_PEERS_[N]_ADDRESS = string
HTTP_GW_PEERS_[N]_WEIGHT = 0..1 (float)
```

4
settings.go
View file

@ -41,8 +41,8 @@ const (
cfgWebConnectionPerHost = "web.connection_per_host" cfgWebConnectionPerHost = "web.connection_per_host"
// Timeouts // Timeouts
cfgConTimeout = "con_timeout" cfgConTimeout = "connect_timeout"
cfgReqTimeout = "req_timeout" cfgReqTimeout = "request_timeout"
cfgRebalance = "rebalance_timer" cfgRebalance = "rebalance_timer"
// Logger: // Logger: