cascade/ipfs-cluster
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
a1b6dabbb0
ipfs-cluster/cmd/ipfs-cluster-follow/dist/README.md
Hector Sanjuan 4ea830f74e Feat: ipfs-cluster-follow 
This adds a new cluster command: ipfs-cluster-follow.

This command allows initializing and running follower peers as configured by a
remote-source configuration. The command can list configured peers
and obtain information for each of them.

Peers are launched with the rest API listening on a local unix socket. The
command can be run to list the items in the cluster pinset using this
endpoint. Alternatively, if no socket is present, the peer will be assumed to
be offline and the pin list will be directly read from the datastore.

Cluster peers launched with this command (and their configurations) are
compatible with ipfs-cluster-ctl and ipfs-cluster-service. We purposely do not
support most configuration options here. Using ipfs-cluster-ctl or launching
the peers using ipfs-cluster-service is always an option when the usecase
deviates from that supported by ipfs-cluster-follow.

Examples:

$ ipfs-cluster-follow -> list configured peers
$ ipfs-cluster-follow --help
$ ipfs-cluster-follow <clusterName> init <url>
$ ipfs-cluster-follow <clusterName> info
$ ipfs-cluster-follow <clusterName> run
$ ipfs-cluster-follow <clusterName> list
2019-12-07 15:38:59 +01:00

1.3 KiB
Raw Blame History

ipfs-cluster-follow

A tool to run IPFS Cluster follower peers

ipfs-cluster-follow allows to setup and run IPFS Cluster follower peers.

Follower peers can join collaborative clusters to track content in the cluster. Follower peers do not have permissions to modify the cluster pinset or access endpoints from other follower peers.

ipfs-cluster-follow allows to run several peers at the same time (each joining a different cluster) and it is intended to be a very easy to use application with a minimal feature set. In order to run a fully-featured peer (follower or not), use ipfs-cluster-service.

Usage

The ipfs-cluster-follow command is always followed by the cluster name that we wish to work with. Full usage information can be obtained by running:

$ ipfs-cluster-follow --help
$ ipfs-cluster-follow --help
$ ipfs-cluster-follow <clusterName> --help
$ ipfs-cluster-follow <clusterName> info --help
$ ipfs-cluster-follow <clusterName> init --help
$ ipfs-cluster-follow <clusterName> run --help
$ ipfs-cluster-follow <clusterName> list --help

For more information, please check the Documentation, in particular the ipfs-cluster-follow section.