Skip to content

Commit a560935

Browse files
committed
README: Add information about containers
1 parent 88e15c6 commit a560935

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,49 @@ In particular, the following are known limitations which we intend to address:
9494
* No support for missing data
9595
* No support for compressed or encrypted objects
9696

97+
## Running
98+
99+
There are various ways to run the S3 Active Storage server.
100+
101+
### Running in a container
102+
103+
The simplest method is to run it in a container using a pre-built image:
104+
105+
```sh
106+
docker run -it --detach --rm --net=host --name s3-active-storage ghcr.io/stackhpc/s3-active-storage-rs:latest
107+
```
108+
109+
Images are published to [GitHub Container Registry](https://github.com/stackhpc/s3-active-storage-rs/pkgs/container/s3-active-storage-rs) when the project is released.
110+
The `latest` tag corresponds to the most recent release, or you can use a specific release e.g. `0.1.0`.
111+
112+
This method does not require access to the source code.
113+
114+
### Building a container image
115+
116+
If you need to use unreleased changes, but still want to run in a container, it is possible to build an image.
117+
First, clone this repository:
118+
119+
```sh
120+
git clone https://github.com/stackhpc/s3-active-storage-rs.git
121+
cd s3-active-storage-rs
122+
```
123+
124+
```sh
125+
make build
126+
```
127+
128+
The image will be tagged as `s3-active-storage`.
129+
The image may be pushed to a registry, or deployed locally.
130+
131+
```sh
132+
make run
133+
```
134+
97135
## Build
98136

137+
If you prefer not to run the S3 Active Storage server in a container, it will be necessary to build a binary.
138+
Building locally may also be preferable during development to take advantage of incremental compilation.
139+
99140
### Prerequisites
100141

101142
This project is written in Rust, and as such requires a Rust toolchain to be installed in order to build it.

0 commit comments

Comments
 (0)