From b09c33f46d9a1891fe6ee9ee999cb10f957778ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=9E=E3=83=AA=E3=82=A6=E3=82=B9?= Date: Sun, 26 Dec 2021 21:16:28 -0500 Subject: [PATCH] Updated README --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index 6a709e6..71573dd 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,33 @@ $ ./superhighway84 A setup wizard will help you with initial configuration. Please make sure to have at least HOME and EDITOR exported in your environment. +In case you would like to use a dedicated ipfs repository for Superhighway84, +you will have to export a different IPFS_PATH and make sure it was initialized +beforehand: + +$ export IPFS_PATH=~/.ipfs-sh84 +$ ipfs init +$ superhighway84 + +In case you're intending to run the official IPFS daemon and Superhighway84 in +parallel, be sure to adjust the ports in their respective IPFS repos (e.g. +~/.ipfs and ~/.ipfs-sh84) so that they won't utilize the same port numbers. +The ports 4001, 5001 and 8080 are relevant and should be adjusted to something +other for every new repo/IPFS node that will run in parallel, e.g.: + + "Addresses": { + "Swarm": [ + "/ip4/0.0.0.0/tcp/4002", + "/ip6/::/tcp/4002", + "/ip4/0.0.0.0/udp/4002/quic", + "/ip6/::/udp/4002/quic" + ], + "Announce": [], + "NoAnnounce": [], + "API": "/ip4/127.0.0.1/tcp/5002", + "Gateway": "/ip4/127.0.0.1/tcp/8081" + }, + USAGE