Skip to content

Commit

Permalink
README fix (#946)
Browse files Browse the repository at this point in the history
  • Loading branch information
roman-khimov authored Apr 2, 2024
2 parents ca52b60 + 6015b66 commit d5515ce
Showing 1 changed file with 9 additions and 19 deletions.
28 changes: 9 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,14 @@ NeoFS S3 gateway provides API compatible with Amazon S3 cloud storage service.

## Installation

```go get -u github.com/nspcc-dev/neofs-s3-gw```
Binaries are provided for [all releases](https://github.com/nspcc-dev/neofs-s3-gw/releases),
you can also use a [Docker image](https://hub.docker.com/r/nspccdev/neofs-s3-gw)
(`:latest` points to the latest stable release).

Or you can call `make` to build it from the cloned repository (the binary will
end up in `bin/neofs-s3-gw` with authmate helper in `bin/neofs-s3-authmate`).
To build binaries in clean docker environment, call `make docker/all`.
### Build

Other notable make targets:

```
dep Check and ensure dependencies
image Build clean docker image
dirty-image Build dirty docker image with host-built binaries
format Run all code formatters
lint Run linters
version Show current version
```

Or you can also use a [Docker
image](https://hub.docker.com/r/nspccdev/neofs-s3-gw) provided for released
(and occasionally unreleased) versions of gateway (`:latest` points to the
latest stable release).
Gateway can be built with a simple `make`. Currently it requires `curl` and `jq`
to be installed.

## Execution

Expand Down Expand Up @@ -54,6 +41,9 @@ $ S3_GW_PEERS_0_ADDRESS=grpcs://192.168.130.72:8080 \
neofs-s3-gw
```

Notice that currently S3 gateway can't be used for public networks like mainnet
or testnet because of experimental tree service extension that is required for it.

## Domains

By default, s3-gw enable only `path-style access`.
Expand Down

0 comments on commit d5515ce

Please sign in to comment.