kubo README

The project's README from github.com/ipfs/kubo. As one markdown file: README.md.


Kubo logo
Kubo: IPFS Implementation in Go

The first implementation of IPFS.

Official Part of IPFS Project Discourse Forum Matrix GitHub release


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:

Other IPFS implementations: Helia (JavaScript), more...

Quick Taste

After installing Kubo, verify it works:

$ ipfs init --profile=unixfs-v1-2025
generating ED25519 keypair...done
peer identity: 12D3KooWGcSLQdLDBi2BvoP8WnpdHvhWPbxpGcqkf93rL2XMZK7R

$ ipfs daemon &
Daemon is ready

$ echo "hello IPFS" | ipfs add -q
bafkreicouv3sksjuzxb3rbb6rziy6duakk2aikegsmtqtz5rsuppjorxsa

$ ipfs cat bafkreicouv3sksjuzxb3rbb6rziy6duakk2aikegsmtqtz5rsuppjorxsa
hello IPFS

Verify this CID is provided by your node to the IPFS network: https://check.ipfs.network/?cid=bafkreicouv3sksjuzxb3rbb6rziy6duakk2aikegsmtqtz5rsuppjorxsa

See ipfs add --help 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.

For running Kubo on constrained hardware such as a Raspberry Pi, see Kubo on low-memory devices.

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/: Docker Image Version (latest semver)

🟢 Release Images

Use these for production deployments.

$ docker pull ipfs/kubo:latest
$ docker run --rm -it --net=host ipfs/kubo:latest

To customize your node, pass config via -e or mount scripts in /container-init.d.

🟠 Developer Preview Images

For internal testing, not intended for production.

🔴 Internal Staging Images

For testing arbitrary commits and experimental patches (force push to staging branch).

Build from Source

GitHub go.mod Go version

git clone https://github.com/ipfs/kubo.git
cd kubo
make build    # creates cmd/ipfs/ipfs
make install  # installs to $GOPATH/bin/ipfs

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: Packaging status

[!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: sudo apt install ipfs-kubo PPA: twdragon
Arch pacman -S kubo Arch package
Fedora COPR: dnf install kubo COPR: taw
Nix nix-env -i kubo nixpkgs unstable
Gentoo emerge -a net-p2p/kubo Gentoo package
openSUSE zypper install kubo openSUSE Tumbleweed
Solus sudo eopkg install kubo Solus package
Guix guix install kubo Guix package
other See Repology for the full list

Snap no longer supported (#8688)

macOS

Manager Install Version
Homebrew brew install ipfs Homebrew
MacPorts sudo port install ipfs MacPorts
Nix nix-env -i kubo nixpkgs unstable
other See Repology for the full list

Windows

Manager Install Version
Scoop scoop install kubo 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
FUSE mounts Mount /ipfs, /ipns, /mfs as local filesystems
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

Security Issues

See SECURITY.md.

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:

kubo (ipfs/kubo)

Searching Database…

17.1K ·GitHub
Что это такое?Kubo — первоначальная и самая широко используемая реализация IPFS на Go: демон, который хранит и раздаёт данные, адресуемые по содержимому, через одноранговую сеть. Также в составе есть CLI, WebUI, HTTP-шлюз и HTTP RPC API для управления им.
Это библиотека, которую встраивают в проект, или самостоятельный узел, который я запускаю сам?Это самостоятельная фоновая служба (демон 'ipfs'), которую вы запускаете на своём компьютере или сервере. Её можно найти в локальной сети через mDNS и в глобальной сети через WAN Amino DHT. Это не библиотека, которую импортируют в приложение.
Как установить и запустить?Скачайте официальные готовые бинарные файлы или релизы на GitHub, загрузите Docker-образ из Docker Hub или установите через менеджер пакетов (Homebrew/MacPorts на macOS, Scoop на Windows, apt/pacman/dnf и др. на Linux).
Нужно ли сначала что-то специальное установить?Отдельная среда выполнения не требуется — это самодостаточный бинарный файл на Go. Главное требование — достаточно оперативной памяти: большим наборам закреплённых данных (pinset) для переобъявления в DHT нужно примерно 1 ГиБ на каждые 20 миллионов элементов.
Можно ли безопасно запускать это на чём-то вроде Raspberry Pi?Только с осторожностью: на слабых системах с малым объёмом памяти могут возникать ошибки OOM, частые перезапуски и пропущенные анонсы данных, из-за чего ваши данные станут частично недоступны другим участникам сети. Для устройств с малым объёмом памяти есть отдельное руководство.
Чем Kubo отличается от других реализаций IPFS?Kubo — первоначальная, наиболее проверенная на практике реализация на Go, ориентированная на максимальную совместимость (UnixFS, HTTP-шлюзы, Bitswap). В README также упоминается Helia — реализация на JavaScript для сценариев в браузере и Node.js.
Можно ли подключить содержимое IPFS как локальную файловую систему?Да, в Kubo есть экспериментальная функция FUSE, которая монтирует /ipfs, /ipns и /mfs (изменяемую файловую систему) как обычные локальные каталоги.
Можно ли запустить собственный публичный шлюз и фильтровать контент?Да. Kubo включает HTTP-шлюз, который отдаёт контент как доверенный, так и проверяемый без доверия к посреднику, а также функцию блокировки контента по списку запретов, предназначенную для операторов публичных узлов.
Как Kubo находит данные в сети?Он использует Bitswap и HTTP для передачи проверяемых данных и участвует в Amino DHT (а также в клиенте и сервере HTTP Routing V1 для делегированной маршрутизации), чтобы находить контент по CID среди участников сети.
Creator
ipfs
Size
59.7 MB
Stars
17.1K
Age
12y
Commits · 90 Days