/usr/bin/ipfs-cluster-service

NAME:
   ipfs-cluster-service - IPFS Cluster peer

USAGE:
   ipfs-cluster-service [global options] command [command options] [arguments...]

VERSION:
   1.1.6+git2182e887ef378f906455784396f1011df968822c

DESCRIPTION:

ipfs-cluster-service runs an IPFS Cluster peer.

A peer participates in the cluster consensus, follows a distributed log
of pinning and unpinning requests and manages pinning operations to a
configured IPFS daemon.

This peer also provides an API for cluster management, an IPFS Proxy API which
forwards requests to IPFS and a number of components for internal communication
using LibP2P. This is a simplified view of the components:

             +------------------+
             | ipfs-cluster-ctl |
             +---------+--------+
                       |
                       | HTTP(s)
ipfs-cluster-service   |                           HTTP
+----------+--------+--v--+----------------------+      +-------------+
| RPC      | Peer 1 | API | IPFS Connector/Proxy +------> IPFS daemon |
+----^-----+--------+-----+----------------------+      +-------------+
     | libp2p
     |
+----v-----+--------+-----+----------------------+      +-------------+
| RPC      | Peer 2 | API | IPFS Connector/Proxy +------> IPFS daemon |
+----^-----+--------+-----+----------------------+      +-------------+
     |
     |
+----v-----+--------+-----+----------------------+      +-------------+
| RPC      | Peer 3 | API | IPFS Connector/Proxy +------> IPFS daemon |
+----------+--------+-----+----------------------+      +-------------+


ipfs-cluster-service needs valid configuration and identity files to run.
These are independent from IPFS. The identity includes its own
libp2p key-pair. They can be initialized with "init" and their
default locations are ~/.ipfs-cluster/service.json
and ~/.ipfs-cluster/identity.json.

For feedback, bug reports or any additional information, visit
https://github.com/ipfs-cluster/ipfs-cluster.


EXAMPLES:

Initial configuration:

$ ipfs-cluster-service init

Launch a cluster:

$ ipfs-cluster-service daemon

Launch a peer and join existing cluster:

$ ipfs-cluster-service daemon --bootstrap /ip4/192.168.1.2/tcp/9096/p2p/QmPSoSaPXpyunaBwHs1rZBKYSqRV4bLRk32VGYLuvdrypL

Customize logs using --loglevel flag. To customize component-level
logging pass a comma-separated list of component-identifer:log-level
pair or without identifier for overall loglevel. Valid loglevels
are critical, error, warning, notice, info and debug.

$ ipfs-cluster-service --loglevel info,cluster:debug,pintracker:debug daemon


COMMANDS:
   init     Creates a configuration and generates an identity
   daemon   Runs the IPFS Cluster peer (default)
   state    Manages the peer's persistent state (pinset)
   version  Prints the ipfs-cluster version
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config FOLDER, -c FOLDER  path to the configuration and data FOLDER (default: "/tmp/.ipfs-cluster") [$IPFS_CLUSTER_PATH]
   --force, -f                 forcefully proceed with some actions. i.e. overwriting configuration
   --debug, -d                 enable full debug logging (very verbose)
   --loglevel value, -l value  set overall and component-wise log levels [$IPFS_CLUSTER_LOG_LEVEL]
   --help, -h                  show help
   --version, -v               print the version