ipfs / kubo
An IPFS implementation in Go
AI Architecture Analysis
This repository is indexed by RepoMind. By analyzing ipfs/kubo in our AI interface, you can instantly generate complete architecture diagrams, visualize control flows, and perform automated security audits across the entire codebase.
Our Agentic Context Augmented Generation (Agentic CAG) engine loads full source files into context on-demand, avoiding the fragmentation of traditional RAG systems. Ask questions about the architecture, dependencies, or specific features to see it in action.
Embed this Badge
Showcase RepoMind's analysis directly in your repository's README.
Repository Overview (README excerpt)
Crawler viewKubo: IPFS Implementation in Go The first implementation of IPFS. What is Kubo? | Quick Taste | Install | Documentation | Development | Getting Help What is Kubo? Kubo was the first IPFS implementation and is the most widely used one today. It takes an opinionated approach to content-addressing (CIDs, DAGs) that maximizes interoperability: UnixFS for files and directories, HTTP Gateways for web browsers, Bitswap and HTTP for verifiable data transfer. **Features:** • Runs an IPFS node as a network service (LAN mDNS and WAN Amino DHT) • Command-line interface ( ) • WebUI for node management • HTTP Gateway for trusted and trustless content retrieval • HTTP RPC API to control the daemon • HTTP Routing V1 client and server for delegated routing • Content blocking for public node operators **Other IPFS implementations:** Helia (JavaScript), more... Quick Taste After installing Kubo, verify it works: Verify this CID is provided by your node to the IPFS network: See for all import options. Ready for more? Follow the command-line quick start. Install Follow the official installation guide, or choose: prebuilt binary | Docker | package manager | from source. Prefer a GUI? Try IPFS Desktop and/or IPFS Companion. Minimal System Requirements Kubo runs on most Linux, macOS, and Windows systems. For optimal performance, we recommend at least 6 GB of RAM and 2 CPU cores (more is ideal, as Kubo is highly parallel). > [!IMPORTANT] > Larger pinsets require additional memory, with an estimated ~1 GiB of RAM per 20 million items for reproviding to the Amino DHT. > [!CAUTION] > Systems with less than the recommended memory may experience instability, frequent OOM errors or restarts, and missing data announcement (reprovider window), which can make data fully or partially inaccessible to other peers. Running Kubo on underprovisioned hardware is at your own risk. Official Prebuilt Binaries Download from https://dist.ipfs.tech#kubo or GitHub Releases. Docker Official images are published at https://hub.docker.com/r/ipfs/kubo/: 🟢 Release Images Use these for production deployments. • and always point at the latest stable release • points at a specific release tag To customize your node, pass config via or mount scripts in . 🟠 Developer Preview Images For internal testing, not intended for production. • points at of • points at a specific commit 🔴 Internal Staging Images For testing arbitrary commits and experimental patches (force push to branch). • points at of • points at a specific commit Build from Source See the Developer Guide for details, Windows instructions, and troubleshooting. Package Managers Kubo is available in community-maintained packages across many operating systems, Linux distributions, and package managers. See Repology for the full list: > [!WARNING] > These packages are maintained by third-party volunteers. The IPFS Project and Kubo maintainers are not responsible for their contents or supply chain security. For increased security, build from source. Linux | Distribution | Install | Version | |--------------|---------|---------| | Ubuntu | PPA: | | | Arch | | | | Fedora | COPR: | | | Nix | | | | Gentoo | | | | openSUSE | | | | Solus | | | | Guix | | | | _other_ | See Repology for the full list | | ~~Snap~~ no longer supported (#8688) macOS | Manager | Install | Version | |---------|---------|---------| | Homebrew | | | | MacPorts | | | | Nix | | | | _other_ | See Repology for the full list | | Windows | Manager | Install | Version | |---------|---------|---------| | Scoop | | | | _other_ | See Repology for the full list | | ~~Chocolatey~~ no longer supported (#9341) Documentation | Topic | Description | |-------|-------------| | Configuration | All config options reference | | Environment variables | Runtime settings via env vars | | Experimental features | Opt-in features in development | | HTTP Gateway | Path, subdomain, and trustless gateway setup | | HTTP RPC clients | Client libraries for Go, JS | | Delegated routing | Multi-router and HTTP routing | | Metrics & monitoring | Prometheus metrics | | Content blocking | Denylist for public nodes | | Customizing | Unsure if use Plugins, Boxo, or fork? | | Debug guide | CPU profiles, memory analysis, tracing | | Changelogs | Release notes for each version | | All documentation | Full list of docs | Development See the Developer Guide for build instructions, testing, and contribution workflow. AI coding agents should follow AGENTS.md. Getting Help • IPFS Forum - community support, questions, and discussion • Community - chat, events, and working groups • GitHub Issues - bug reports for Kubo specifically • IPFS Docs Issues - documentation issues Security Issues See . Contributing We welcome contributions. See CONTRIBUTING.md and the Developer Guide. This repository follows the IPFS Code of Conduct. Maintainer Info > [!NOTE] > Kubo is maintained by the Shipyard team. > > Release Process License Dual-licensed under Apache 2.0 and MIT: • LICENSE-APACHE • LICENSE-MIT