2020-08-20 23:50:14 +00:00
|
|
|
# NeoFS HTTP Gate
|
2019-11-07 17:29:29 +00:00
|
|
|
|
2020-08-20 23:50:14 +00:00
|
|
|
NeoFS HTTP Gate is example of tool that provides basic interactions with NeoFS.
|
|
|
|
|
You can download files from NeoFS Network using NeoFS Gate.
|
2019-11-07 17:29:29 +00:00
|
|
|
|
|
|
|
|
## Install
|
|
|
|
|
|
2020-08-20 23:50:14 +00:00
|
|
|
```go get -u github.com/nspcc-dev/neofs-http-gate```
|
2019-11-07 17:29:29 +00:00
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
```
|
2019-12-13 16:02:48 +00:00
|
|
|
# Flags
|
2019-12-21 10:26:14 +00:00
|
|
|
--pprof enable pprof
|
|
|
|
|
--metrics enable prometheus
|
2019-12-13 16:02:48 +00:00
|
|
|
-h, --help show help
|
|
|
|
|
-v, --version show version
|
2019-12-17 15:34:04 +00:00
|
|
|
--key string "generated" to generate key, path to private key file, hex string or wif (default "generated")
|
2019-12-13 16:02:48 +00:00
|
|
|
--verbose debug gRPC connections
|
|
|
|
|
--request_timeout duration gRPC request timeout (default 5s)
|
|
|
|
|
--connect_timeout duration gRPC connect timeout (default 30s)
|
2020-08-20 23:50:14 +00:00
|
|
|
--listen_address string HTTP Gate listen address (default "0.0.0.0:8082")
|
2019-12-21 10:26:14 +00:00
|
|
|
-p, --peers stringArray NeoFS nodes
|
2019-12-13 16:02:48 +00:00
|
|
|
|
2019-11-07 17:29:29 +00:00
|
|
|
# Environments:
|
|
|
|
|
|
2019-12-17 15:34:04 +00:00
|
|
|
GW_KEY=stirng - "generated" to generate key, path to private key file, hex string or wif (default "generated")
|
2019-11-07 17:29:29 +00:00
|
|
|
GW_REQUEST_TIMEOUT=Duration - timeout for request
|
|
|
|
|
GW_CONNECT_TIMEOUT=Duration - timeout for connection
|
|
|
|
|
GW_LISTEN_ADDRESS=host:port - address to listen connections
|
2019-12-21 10:26:14 +00:00
|
|
|
GW_PEERS_<X>_ADDRESS=host:port - address of NeoFS Node
|
|
|
|
|
GW_PEERS_<X>_WEIGHT=float - weight of NeoFS Node
|
|
|
|
|
GW_PPROF=bool - enable/disable pprof (/debug/pprof)
|
|
|
|
|
GW_METRICS=bool - enable/disable prometheus metrics endpoint (/metrics)
|
2019-11-07 17:29:29 +00:00
|
|
|
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.
|
|
|
|
|
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
|
|
|
|
|
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.
|
|
|
|
|
```
|
2020-11-23 09:43:27 +00:00
|
|
|
|
|
|
|
|
### WARNING
|
|
|
|
|
`generated` value for `GW_KEY` or `--key` is deprecated, you should use pre-generated keys.
|
