IPFS Docs

• API Docs
• How tos and other documentation
• Development documentation

API Docs

ipfs can run as part of your program (an in-process node) or as a standalone daemon process that can be communicated with via an HTTP RPC API using the ipfs-http-client module.

Whether accessed directly or over HTTP, both methods support the full Core API. In addition other methods are available to construct instances of each module, etc.

• Core API docs
• IPFS API
• IPFS-HTTP-CLIENT API

How tos and other documentation

• Architecture overview
• How to run js-IPFS in the browser
• Running js-IPFS on the CLI
• js-IPFS configuration options
• How to configure CORS for use with the http client
• Running js-IPFS as a daemon
• Configuring Delegate Routers
• Running js-IPFS under Docker
• FAQ
• How to configure additional IPLD codecs
• Running js-IPFS in your application
• How to get metrics out of js-IPFS

Development documentation

• Getting started
• Release issue template
• Early testers
• Releases