Skip to content

Commit

Permalink
make README match example
Browse files Browse the repository at this point in the history
  • Loading branch information
thattommyhall committed Apr 27, 2022
1 parent 03cacf4 commit 0001fee
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,33 @@
# go-ipfs-docker-examples

> A few patterns for using go-ipfs inside containers
Now that we have [landed](https://github.com/ipfs/go-ipfs/pull/6577) a way to
set and manage config in containers started from the go-ipfs [Docker
image](https://hub.docker.com/r/ipfs/go-ipfs/), it opens up some nice
possibilities.

Some of these examples will be immediately usable, some are starting points,
each has its own README.
each has its own README.
## Documentation

Each folder is a self contained example of using `/container-init.d` scripts to
configure go-ipfs when running inside a container, you can build each by running

```
docker build .
```
in the usual way.

## Lead Maintainer

[thattommyhall](https://github.com/thattommyhall)

## Contributing

Contributions are welcome! This repository is part of the IPFS project and
therefore governed by our [contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md).

## License

[SPDX-License-Identifier: Apache-2.0 OR MIT](LICENSE.md)
4 changes: 2 additions & 2 deletions gateway/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gateway Example
You won't be to use this as-is, but it does highlight some interesting options
you might want to toggle inside the container.
You won't be able to use this as-is, but it does highlight some interesting
options you might want to toggle inside the container.

It has:
- config examples for path and subdomain gateways (with the well-known PL ones
Expand Down

0 comments on commit 0001fee

Please sign in to comment.