From 0001fee596e579c2a7e6275d90ec26185025b8c2 Mon Sep 17 00:00:00 2001 From: Tom Hall Date: Wed, 27 Apr 2022 18:26:00 -0400 Subject: [PATCH] make README match example --- README.md | 26 +++++++++++++++++++++++++- gateway/README.md | 4 ++-- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fa175cc..c7761d9 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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) \ No newline at end of file diff --git a/gateway/README.md b/gateway/README.md index c88fff5..b12bd70 100644 --- a/gateway/README.md +++ b/gateway/README.md @@ -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