frostfs-http-gw/README.md

38 lines
1.8 KiB
Markdown
Raw Normal View History

2019-11-07 17:29:29 +00:00
# NeoFS HTTP Gateway
NeoFS HTTP Gateway is example of tool that provides basic interactions with NeoFS.
You can download files from NeoFS Network using NeoFS Gateway.
## Install
```go get -u github.com/nspcc-dev/neofs-gw```
## Configuration
```
# Flags
-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")
--verbose debug gRPC connections
--request_timeout duration gRPC request timeout (default 5s)
--connect_timeout duration gRPC connect timeout (default 30s)
--listen_address string HTTP Gateway listen address (default "0.0.0.0:8082")
--neofs_address string NeoFS Node address for proxying requests (default "0.0.0.0:8080")
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
GW_NEOFS_ADDRESS=host:port - address of NeoFS Node
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.
```