Developer Documentation and Guides

If you're looking for User Documentation & Guides, visit docs.ipfs.tech.

If you're experiencing an issue with IPFS, please file an issue in this repository.

Configuration

• Configuration reference
  • Datastore configuration
  • Experimental features
• Environment variables

Running Kubo

• Gateway configuration
• Delegated routing
• Content blocking (for public node operators)
• libp2p resource management
• Mounting IPFS with FUSE

Metrics & Monitoring

• Prometheus metrics
• Telemetry plugin
• Provider statistics
• Performance debugging

Development

• Developer Guide - prerequisites, build, test, and contribute
• AGENTS.md - instructions for AI coding agents
• Contributing Guidelines for IPFS projects and for Go code specifically
• Building on Windows
• Customizing Kubo
• Installing plugins
• Release checklist

Guides

• Transferring files over IPFS
• How to implement an API client
• HTTP/RPC clients
• Websocket transports
• Command completion

Production

• Reverse proxy setup
• Firewall setup (ufw)

Specifications

• Repository structure
• Filesystem datastore
• Keystore

Examples

• Kubo as a library