node-distro/README.md
Anatoly Laskaris 308e5b2be8
Remove aqua-ipfs when not configured (#62)
* Update README

* Remove aqua-ipfs if not configured

* Substitute rust-peer for fluence node
2022-08-18 13:16:09 +03:00

5.3 KiB

node-distro

The distributive and packaging of the rust-peer.

Currently provides Network Dashboard as a side-car.

Image tags

Container flavor IPFS daemon services binaries
minimal aqua-ipfs, trust-graph, registry curl, ipfs
ipfs aqua-ipfs, trust-graph, registry curl, ipfs
rich aqua-ipfs, trust-graph, registry curl, ipfs, ceramic, bitcoin cli, geth cli

minimal

Contains rust-peer itself and some builtin services:

For those who want to run IPFS node separately. Serves as a base image for all other image flavours.

FLUENCE_ENV_AQUA_IPFS_* variables must be defined and configured to use externally running IPFS daemon in order for aqua-ipfs to work. If not defined aqua-ipfs builtin will be removed.

variable default description
FLUENCE_ENV_AQUA_IPFS_EXTERNAL_API_MULTIADDR IPFS node address used by aqua-ipfs builtin
FLUENCE_ENV_AQUA_IPFS_LOCAL_API_MULTIADDR same as above
FLUENCE_ENV_AQUA_IPFS_EXTERNAL_SWARM_MULTIADDR same as above

ipfs

rust-peer packaged with IPFS node running inside container.

variable default description
IPFS_PATH /config/ipfs IPFS node data directory
IPFS_LOG_PATH /log/ipfs directory where IPFS will store its logs
IPFS_MIGRATE_FS false automatically run fs-repo-migrations on start
FLUENCE_ENV_AQUA_IPFS_EXTERNAL_API_MULTIADDR /ip4/127.0.0.1/tcp/5001 IPFS node address used by aqua-ipfs builtin
FLUENCE_ENV_AQUA_IPFS_LOCAL_API_MULTIADDR /ip4/127.0.0.1/tcp/5001 same as above
FLUENCE_ENV_AQUA_IPFS_EXTERNAL_SWARM_MULTIADDR /ip4/127.0.0.1/tcp/4001 same as above

rich

rust-peer packaged with IPFS node, Ceramic CLI and some other binaries like bitcoin-cli or geth.

variable default description
CERAMIC_HOST ceramic daemon address
IPFS_PATH /config/ipfs IPFS node data directory
IPFS_LOG_PATH /log/ipfs directory where IPFS will store its logs
IPFS_MIGRATE_FS false automatically run fs-repo-migrations on start
FLUENCE_ENV_AQUA_IPFS_EXTERNAL_API_MULTIADDR /ip4/127.0.0.1/tcp/5001 IPFS node address used by aqua-ipfs builtin
FLUENCE_ENV_AQUA_IPFS_LOCAL_API_MULTIADDR /ip4/127.0.0.1/tcp/5001 same as above
FLUENCE_ENV_AQUA_IPFS_EXTERNAL_SWARM_MULTIADDR /ip4/127.0.0.1/tcp/4001 same as above

How to run

Copy docker-compose.yml locally and run

docker-compose up -d

That will run 2 containers: local rust-peer and Network Dashboard connected to it.

How to open dashboard

Open http://localhost:8080 in your browser