FrostFS HTTP Gateway

Find a file

Evgeniy Kulikov 01f13ef210 Prepare to release - set output for flag set - change env prefix for all environments - migrate to CDN SDK release v0.1.0 Signed-off-by: Evgeniy Kulikov <kim@nspcc.ru>		2020-12-02 12:25:18 +03:00
.gitignore	ignore blast benchmark config	2020-02-28 19:52:33 +03:00
.test.env	add test environments	2020-02-28 19:45:00 +03:00
app.go	Migrate to new release of NeoFS API	2020-11-23 12:32:03 +03:00
Dockerfile	Prepare to release	2020-12-02 12:25:18 +03:00
go.mod	Prepare to release	2020-12-02 12:25:18 +03:00
go.sum	Prepare to release	2020-12-02 12:25:18 +03:00
go_dev.mod	change module name	2020-08-21 02:50:14 +03:00
health.go	Migrate to CDN SDK	2020-11-10 14:46:28 +03:00
LICENSE.md	NSPCC-587 Add License and Readme	2019-11-07 20:29:29 +03:00
main.go	Change ENV prefix	2020-11-27 18:18:53 +03:00
Makefile	update makefile dev command	2020-02-29 13:25:22 +03:00
metrics.go	metrics: fix doc-comments	2020-05-12 11:20:28 +03:00
misc.go	Prepare to release	2020-12-02 12:25:18 +03:00
pprof.go	pprof: fix route params	2020-05-12 11:20:28 +03:00
README.md	Deprecation warning	2020-11-23 12:43:27 +03:00
receive.go	Migrate to new release of NeoFS API	2020-11-23 12:32:03 +03:00
settings.go	Prepare to release	2020-12-02 12:25:18 +03:00

README.md

NeoFS HTTP Gate

NeoFS HTTP Gate is example of tool that provides basic interactions with NeoFS. You can download files from NeoFS Network using NeoFS Gate.

Install

go get -u github.com/nspcc-dev/neofs-http-gate

Configuration

# Flags
      --pprof                      enable pprof
      --metrics                    enable prometheus
  -h, --help                       show help
  -v, --version                    show version
      --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 Gate listen address (default "0.0.0.0:8082")
  -p, --peers stringArray          NeoFS nodes

# Environments:

GW_KEY=stirng                           - "generated" to generate key, path to private key file, hex string or wif (default "generated")
GW_REQUEST_TIMEOUT=Duration             - timeout for request
GW_CONNECT_TIMEOUT=Duration             - timeout for connection
GW_LISTEN_ADDRESS=host:port             - address to listen connections
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)
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.

WARNING

generated value for GW_KEY or --key is deprecated, you should use pre-generated keys.