- Exciting release!Introducing "safe npm". Learn more →
@ceramicnetwork/ipfs-daemon
Advanced tools
- Version published
- Maintainers
- 8
- Weekly downloads
- 831
- increased by19.4%
Weekly downloads
Changelog
@ceramicnetwork/stream-caip10-link-handler@2.17.0
2.17.0 (2023-03-22)
Note: Version bump only for package @ceramicnetwork/stream-caip10-link-handler
Readme
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
npm install -g @ceramicnetwork/ipfs-daemon
export CERAMIC_NETWORK=testnet-clay # or another Ceramic network
ipfs-daemon
or use it in a Node.js application
npm install @ceramicnetwork/ipfs-daemon
import {IpfsDaemon} from "@ceramicnetwork/ipfs-daemon";
// All the parameters are optional here
// If not set, they are given defaults or got read from process environment variables
const ipfsDaemon = await IpfsDaemon.create({
ipfsDhtServerMode: IPFS_DHT_SERVER_MODE, // DHT Server
ipfsEnableGateway: true, // Enable IPFS Gateway
useCentralizedPeerDiscovery: true, // Connect to bootstrap nodes
ceramicNetwork: 'testnet-clay' // Bootstrap nodes are selected per network
})
await ipfsDaemon.start()
const ipfs = ipfsDaemon.ipfs
await 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
FAQs
IPFS daemon wraps js-ipfs instance with dag-jose codec enabled
The npm package @ceramicnetwork/ipfs-daemon receives a total of 713 weekly downloads. As such, @ceramicnetwork/ipfs-daemon popularity was classified as not popular.
We found that @ceramicnetwork/ipfs-daemon demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.