kubo/docs

Developer Documentation and Guides

If you are looking for User Documentation & Guides, please visit docs.ipfs.tech or check General Documentation.

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 Documentation

• Configuration reference
  • Datastore configuration
  • Experimental features

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
• 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