Skip to content

Commit

Permalink
fix: 👷 Fixing CI + Readme
Browse files Browse the repository at this point in the history
Signed-off-by: Nishant Arora <[email protected]>
  • Loading branch information
whizzzkid committed Oct 4, 2023
1 parent 1db8748 commit 450fd5a
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ jobs:

- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
with:
platforms: linux/amd64

- name: Docker meta
id: meta
Expand Down
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
# helia-docker
# helia-docker

Docker images for Helia.

## Purpose

This container image hosts helia in a node container. It implements [HTTP IPFS-gateway API](https://docs.ipfs.tech/concepts/ipfs-gateway/#gateway-types) and responds to the incoming requests using helia to fetch the content from IPFS.

## Building

```sh
$ docker build . --tag helia
```

Pass the explicit platform when building on a Mac.

```sh
$ docker build . --tag helia --platform linux/arm64
```

Building with custom CMAKE flags.

```sh
$ docker build . --tag helia --build-arg CMAKE_CXX_FLAGS="..." --build-arg CMAKE_C_FLAGS="..."
```

## Running

```sh
$ docker run -it -p 8080:8080 helia
```

## Author

- [whizzzkid](https://github.com/whizzzkid)

0 comments on commit 450fd5a

Please sign in to comment.