Get a running IPFS daemon quickly with Javascript
This module provides a quick way to get an IPFS daemon up and running in your Javascript program. It works with both Node.js and the browsers and can be used to start a js-ipfs instance or a go-ipfs daemon.
NOTE! This module will be deprecated in the near future. js-ipfs has now implemented a new API for creating an instance which is similar to the API in ipfs-daemon. Please also note that module uses [email protected] which is older than the latest version.
The recommended way to create an IPFS instance for Node.js and Browsers is to use js-ipfs.
This modules uses:
npm install ipfs-daemon
const IPFS = require('ipfs-daemon')
const ipfs = new IPFS()
ipfs.on('ready', () => {
// IPFS is now ready to be used
// eg. ipfs.files.add(..)
})
ipfs.on('error', (e) => console.error(err))See API documentation for details.
You can find a simple Node.js example in examples/native.js. You can run it with:
node examples/native.js
You can find a browser example in examples/browser/index.html. You can run it by opening the file in a browser.
Note! Browser example currently only works in Chrome.
In addition to the API documented here, ipfs-daemon makes the IPFS API available at the top level of the instantiated object.
When used in Node.js, the available functionality is described in js-ipfs-api documentation.
When used in the browser, the available functionality is described in js-ipfs documentation.
In order to use an IPFS daemon, you first need to require the module in your project:
const IPFS = require('ipfs-daemon')And then instantiate an IPFS object. You can pass options to the constructor, see options for details.
const ipfs = new IPFS(options)Then, before you can use it, you'll have to wait for the ready event to be emitted:
ipfs.on('ready', () => {
// IPFS API is now ready to be used
// eg. ipfs.files.add(..)
})
ipfs.on('error', (e) => console.log(e))const ipfs = new IPFS(options)IpfsDaemon takes options as an optional argument where you can define various properties for the IPFS daemon. Default options are:
{
IpfsDataDir: process.env.IPFS_PATH, // Location of IPFS data repository
LogDirectory: '/tmp', // Directory to write ipfs-daemon.log file for ipfs-daemon
Flags: ['--enable-pubsub-experiment'], // Flags to pass to IPFS daemon
Addresses: { // IPFS Daemon addresses
API: '/ip4/127.0.0.1/tcp/5001',
Swarm: ['/ip4/0.0.0.0/tcp/4001'],
Gateway: '/ip4/0.0.0.0/tcp/8080'
},
API: { // API config for IPFS daemon
HTTPHeaders: {
"Access-Control-Allow-Origin": ['*'], // Origins from which to allow http requests
"Access-Control-Allow-Methods": [], // "PUT", "GET", "POST", "DELETE", etc.
"Access-Control-Allow-Credentials": [] // "true" || "false"
}
},
SignalServer: null // WebRTC sig-star server, browser only, eg. '127.0.0.1'
}Stops and shuts down the IPFS daemon
ipfs.stop()The Peer ID of the IPFS daemon.
ipfs.PeerId // 'QmSUs7xtkm4yTZpashfjJZvptNZAAzahJjDbRcnGL43BzH'The address to which the IPFS HTTP Gateway of go-ipfs is bound to.
ipfs.GatewayAddress // 'localhost:8080/ipfs/'The address to which the IPFS HTTP API of go-ipfs is bound to.
ipfs.APIAddress // '127.0.0.1:5001'Ipfs inherits from EventEmitter and it emits the following events:
Emitted when IPFS has started and is ready to be used.
ipfs.on('ready', () => {
// IPFS is now ready to be used
})Emitted when an error occurs in IPFS.
ipfs.on('error', (e) => console.error(err))git clone https://github.com/haadcode/ipfs-daemon.git
cd ipfs-daemon/
npm install
npm test
npm run build
Currently existing modules for IPFS require multiple steps and knowledge how to get an IPFS daemon started. Furthermore, some of the required steps are not documented, making it hard to get started with Javacript and IPFS. This module was written to provide an easy way to get IPFS up and running.
In Node.js, ipfs-daemon will initialize and start a detached go-ipfs process that can then be called via the API. Internally the Node.js version uses ipfsd-ctl, js-ipfs-api and go-ipfs-dep modules. Please note that ipfs-daemon currently uses a custom version of go-ipfs binary called floodsub-2 which is required to make sure Pubsub API works.
In the browsers, ipfs-daemon will start a js-ipfs instance which can be used via the API.
I would be happy to accept PRs! If something is not working, opening a new issue would be highly appreciated.
You can reach me on IRC #ipfs on Freenode, or by opening an issue.
MIT ©️ 2016 Haadcode