Add protocol gateway docs

Brief descriptions for http and s3 protocol gateways.

Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-12-01 18:32:03 +03:00 committed by Stanislav Bogatyrev
parent 64ec80db58
commit d5ad9f6df5
3 changed files with 77 additions and 1 deletions

18
docs/s3_gate.md Normal file
View file

@ -0,0 +1,18 @@
# S3 Protocol gateway
Protocol Gateway to access data in NeoFS using AWS S3 protocol
Source code and more information can be found in [project's GitHub repository](https://github.com/nspcc-dev/neofs-s3-gate)
## .env settings
### S3_GW_VERSION=0.12.0
Image version label to use for containers.
If you want to use locally built image, just set it's label here. Instead of
pulling from DockerHub, the local image will be used.
### S3_GW_IMAGE=nspccdev/neofs-s3-gate
Image label prefix to use for containers.