Ceramic bundled IPFS Daemon

Wraps js-ipfs instance with dag-jose codec enabled.

Getting started

The daemon can be run with Node.js or Docker.

See the ceramic developer site for more details about how to use this package.

Using Node.js

You can install this package globally and run the binary from your shell

1npm install -g @ceramicnetwork/ipfs-daemon
2export CERAMIC_NETWORK=testnet-clay # or another Ceramic network
3ipfs-daemon

or use it in a Node.js application

1npm install @ceramicnetwork/ipfs-daemon

1import {IpfsDaemon} from "@dustil/ipfs-daemon";
2
3// All the parameters are optional here
4// If not set, they are given defaults or got read from process environment variables
5const ipfsDaemon = await IpfsDaemon.create({
6    ipfsDhtServerMode: IPFS_DHT_SERVER_MODE, // DHT Server
7    ipfsEnableGateway: true, // Enable IPFS Gateway
8    useCentralizedPeerDiscovery: true, // Connect to bootstrap nodes
9    ceramicNetwork: 'testnet-clay' // Bootstrap nodes are selected per network
10})
11await ipfsDaemon.start()
12const ipfs = ipfsDaemon.ipfs
13await ipfsDaemon.stop()

Using Docker

Public builds of the image Dockerfile.ipfs-daemon are hosted here: ceramicnetwork/ipfs-daemon on Docker Hub

docker pull ceramicnetwork/ipfs-daemon
docker run -p 5011:5011 -e CERAMIC_NETWORK=testnet-clay ceramicnetwork/ipfs-daemon

## Contributing
We are happy to accept small and large contributions. Make sure to check out the [Ceramic specifications](https://github.com/ceramicnetwork/ceramic/blob/main/SPECIFICATION.md) for details of how the protocol works.

## License

Apache-2.0 or MIT