kubo/docs/README.md

Developer Documentation and Guides

If you are looking for User Documentation & Guides, please visit docs.ipfs.io.

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:

Developing kubo

• First, please read the Contributing Guidelines for IPFS projects and then the Contributing Guidelines for Go code specifically
• Building on…
  • Windows
• Performance Debugging Guidelines
• Release Checklist

Guides

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

Advanced User Guides

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

Other

• Thanks to all our contributors ❤️ (We use the generate-authors.sh script to regenerate this list.)
• How to file a GitHub Issue