README.md

Documentation and Guides

If you’re experiencing an issue with IPFS, please follow our issue guide when filing an issue!

Otherwise, check out the following guides to using and developing IPFS:

General Usage

• Transferring a File Over IPFS
• Configuration reference
  • Datastore configuration
  • Experimental features
• Installing command completion
• Mounting IPFS with FUSE
• Installing plugins

API Support

• How to Implement an API Client
• Connecting with Websockets — if you want js-ipfs nodes in web browsers to connect to your go-ipfs node, you will need to turn on websocket support in your go-ipfs node.

Developing go-ipfs

• Building on…
  • Windows
  • OpenBSD
• Performance Debugging Guidelines
• Release Checklist

Other

• Thanks to all our contributors ❤️ (We use the generate-authors.sh script to regenerate this list.)
• Our Developer Certificate of Origin (DCO) — when you sign your commits with Signed-off-by: <your name>, you are agreeing to this document.
• How to file a GitHub Issue