frostfs-http-gw/README.md

# 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
      --key string                 "gen" to generate key, path to private key file, hex string or wif (default "gen")
      --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")

# Environments:

GW_KEY=stirng                           - "gen" to generate key, path to private key file, hex string or wif (default "gen")
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
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.
```