docs: improve README for first-time users (#11133)
* docs: improve README for first-time users - add Quick Taste section with real CIDv1 example near top - rewrite "What is Kubo?" with technical concepts (CIDs, DAGs, UnixFS, Bitswap) - reorder features to follow user journey (CLI before advanced HTTP features) - streamline install section with links to docs.ipfs.tech - organize package managers in tables with Repology version badges - add supply chain security warning for third-party packages - surface important docs (metrics, debug guide, customizing) - update maintainer info with Shipyard branding Closes #11125 Closes #7298 Closes #5471 Closes #5087 * docs(readme): add changelogs link and fix docs directory URL * docs(readme): add mDNS/DHT links and clarify build steps - link LAN discovery to mDNS spec and WAN to Amino DHT glossary - show both make build and make install with output paths
Marcin Rataj committed
Jan 7, 2026 at 20:33 UTC
584025bb6952d837829c0d89934fef87c2428115
1 file changed
+129
-380
README.md
+129
-380
@@ -2,7 +2,7 @@
2
<br>
3
<a href="https://github.com/ipfs/kubo/blob/master/docs/logo/"><img src="https://user-images.githubusercontent.com/157609/250148884-d6d12db8-fdcf-4be3-8546-2550b69845d8.png" alt="Kubo logo" title="Kubo logo" width="200"></a>
4
<br>
5
- Kubo: IPFS Implementation in GO
5
+ Kubo: IPFS Implementation in Go
6
<br>
7
</h1>
8
@@ -11,465 +11,214 @@
11
<p align="center">
12
<a href="https://ipfs.tech"><img src="https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square" alt="Official Part of IPFS Project"></a>
13
<a href="https://discuss.ipfs.tech"><img alt="Discourse Forum" src="https://img.shields.io/discourse/posts?server=https%3A%2F%2Fdiscuss.ipfs.tech"></a>
14
- <a href="https://matrix.to/#/#ipfs-space:ipfs.io"><img alt="Matrix" src="https://img.shields.io/matrix/ipfs-space%3Aipfs.io?server_fqdn=matrix.org"></a>
14
+ <a href="https://docs.ipfs.tech/community/"><img alt="Matrix" src="https://img.shields.io/matrix/ipfs-space%3Aipfs.io?server_fqdn=matrix.org"></a>
15
<a href="https://github.com/ipfs/kubo/actions"><img src="https://img.shields.io/github/actions/workflow/status/ipfs/kubo/gobuild.yml?branch=master"></a>
16
<a href="https://github.com/ipfs/kubo/releases"><img alt="GitHub release" src="https://img.shields.io/github/v/release/ipfs/kubo?filter=!*rc*"></a>
17
</p>
18
19
<hr />
20
21
-## What is Kubo?
22
-
23
-Kubo was the first IPFS implementation and is the most widely used one today. Implementing the *Interplanetary Filesystem* - the standard for content-addressing on the Web, interoperable with HTTP. Thus powered by future-proof data models and the libp2p for network communication. Kubo is written in Go.
24
-
25
-Featureset
26
-- Runs an IPFS-Node as a network service that is part of LAN and WAN DHT
27
-- Native support for UnixFS (most popular way to represent files and directories on IPFS)
28
-- [HTTP Gateway](https://specs.ipfs.tech/http-gateways/) (`/ipfs` and `/ipns`) functionality for trusted and [trustless](https://docs.ipfs.tech/reference/http/gateway/#trustless-verifiable-retrieval) content retrieval
29
-- [HTTP Routing V1](https://specs.ipfs.tech/routing/http-routing-v1/) (`/routing/v1`) client and server implementation for [delegated routing](./docs/delegated-routing.md) lookups
30
-- [HTTP Kubo RPC API](https://docs.ipfs.tech/reference/kubo/rpc/) (`/api/v0`) to access and control the daemon
31
-- [Command Line Interface](https://docs.ipfs.tech/reference/kubo/cli/) based on (`/api/v0`) RPC API
32
-- [WebUI](https://github.com/ipfs/ipfs-webui/#readme) to manage the Kubo node
33
-- [Content blocking](/docs/content-blocking.md) support for operators of public nodes
34
-
35
-### Other implementations
36
-
37
-See [List](https://docs.ipfs.tech/basics/ipfs-implementations/)
38
-
39
-## What is IPFS?
40
-
41
-IPFS is a global, versioned, peer-to-peer filesystem. It combines good ideas from previous systems such as Git, BitTorrent, Kademlia, SFS, and the Web. It is like a single BitTorrent swarm, exchanging git objects. IPFS provides an interface as simple as the HTTP web, but with permanence built-in. You can also mount the world at /ipfs.
42
-
43
-For more info see: https://docs.ipfs.tech/concepts/what-is-ipfs/
44
-
45
-Before opening an issue, consider using one of the following locations to ensure you are opening your thread in the right place:
46
- - kubo (previously named go-ipfs) _implementation_ bugs in [this repo](https://github.com/ipfs/kubo/issues).
47
- - Documentation issues in [ipfs/docs issues](https://github.com/ipfs/ipfs-docs/issues).
48
- - IPFS _design_ in [ipfs/specs issues](https://github.com/ipfs/specs/issues).
49
- - Exploration of new ideas in [ipfs/notes issues](https://github.com/ipfs/notes/issues).
50
- - Ask questions and meet the rest of the community at the [IPFS Forum](https://discuss.ipfs.tech).
51
- - Or [chat with us](https://docs.ipfs.tech/community/chat/).
52
-
53
-[](https://www.youtube.com/channel/UCdjsUXJ3QawK4O5L1kqqsew) [](https://twitter.com/IPFS)
54
-
55
-## Next milestones
56
-
57
-[Milestones on GitHub](https://github.com/ipfs/kubo/milestones)
58
-
59
-
60
-## Table of Contents
61
-
62
-- [What is Kubo?](#what-is-kubo)
63
-- [What is IPFS?](#what-is-ipfs)
64
-- [Next milestones](#next-milestones)
65
-- [Table of Contents](#table-of-contents)
66
-- [Security Issues](#security-issues)
67
-- [Install](#install)
68
- - [Minimal System Requirements](#minimal-system-requirements)
69
- - [Docker](#docker)
70
- - [Official prebuilt binaries](#official-prebuilt-binaries)
71
- - [Updating](#updating)
72
- - [Downloading builds using IPFS](#downloading-builds-using-ipfs)
73
- - [Unofficial Linux packages](#unofficial-linux-packages)
74
- - [ArchLinux](#arch-linux)
75
- - [Gentoo Linux](#gentoo-linux)
76
- - [Nix](#nix)
77
- - [Solus](#solus)
78
- - [openSUSE](#opensuse)
79
- - [Guix](#guix)
80
- - [Snap](#snap)
81
- - [Ubuntu PPA](#ubuntu-ppa)
82
- - [Fedora](#fedora-copr)
83
- - [Unofficial Windows packages](#unofficial-windows-packages)
84
- - [Chocolatey](#chocolatey)
85
- - [Scoop](#scoop)
86
- - [Unofficial MacOS packages](#unofficial-macos-packages)
87
- - [MacPorts](#macports)
88
- - [Nix](#nix-macos)
89
- - [Homebrew](#homebrew)
90
- - [Build from Source](#build-from-source)
91
- - [Install Go](#install-go)
92
- - [Download and Compile IPFS](#download-and-compile-ipfs)
93
- - [Cross Compiling](#cross-compiling)
94
- - [Troubleshooting](#troubleshooting)
95
-- [Getting Started](#getting-started)
96
- - [Usage](#usage)
97
- - [Some things to try](#some-things-to-try)
98
- - [Troubleshooting](#troubleshooting-1)
99
-- [Packages](#packages)
100
-- [Development](#development)
101
-- [Maintainer Info](#maintainer-info)
102
-- [Contributing](#contributing)
103
-- [License](#license)
104
-
105
-## Security Issues
106
-
107
-Please follow [`SECURITY.md`](SECURITY.md).
108
-
109
-## Install
110
-
111
-The canonical download instructions for IPFS are over at: https://docs.ipfs.tech/install/. It is **highly recommended** you follow those instructions if you are not interested in working on IPFS development.
112
-
113
-For production use, Release Docker images (below) are recommended.
114
-
115
-### Minimal System Requirements
116
-
117
-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).
118
-
119
-> [!IMPORTANT]
120
-> Larger pinsets require additional memory, with an estimated ~1 GiB of RAM per 20 million items for reproviding to the Amino DHT.
121
-
122
-> [!CAUTION]
123
-> 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.
124
-
125
-### Docker
126
-
127
-Official images are published at https://hub.docker.com/r/ipfs/kubo/: [](https://hub.docker.com/r/ipfs/kubo/)
128
-
129
-#### 🟢 Release Images
130
- - These are production grade images. Use them.
131
- - `latest` and [`release`](https://hub.docker.com/r/ipfs/kubo/tags?name=release) tags always point at [the latest stable release](https://github.com/ipfs/kubo/releases/latest). If you use this, remember to `docker pull` periodically to update.
132
- - [`vN.N.N`](https://hub.docker.com/r/ipfs/kubo/tags?name=v) points at a specific [release tag](https://github.com/ipfs/kubo/releases)
133
-
134
-#### 🟠 Developer Preview Images
135
- - These tags are used by developers for internal testing, not intended for end users or production use.
136
- - [`master-latest`](https://hub.docker.com/r/ipfs/kubo/tags?name=master-latest) always points at the `HEAD` of the [`master`](https://github.com/ipfs/kubo/commits/master/) branch
137
- - [`master-YYYY-DD-MM-GITSHA`](https://hub.docker.com/r/ipfs/kubo/tags?name=master-2) points at a specific commit from the `master` branch
138
-
139
-#### 🔴 Internal Staging Images
140
- - We use `staging` for testing arbitrary commits and experimental patches.
141
- - To build image for current HEAD, force push to `staging` via `git push origin HEAD:staging --force`)
142
- - [`staging-latest`](https://hub.docker.com/r/ipfs/kubo/tags?name=staging-latest) always points at the `HEAD` of the [`staging`](https://github.com/ipfs/kubo/commits/staging/) branch
143
- - [`staging-YYYY-DD-MM-GITSHA`](https://hub.docker.com/r/ipfs/kubo/tags?name=staging-2) points at a specific commit from the `staging` branch
144
-
145
-```console
146
-$ docker pull ipfs/kubo:latest
147
-$ docker run --rm -it --net=host ipfs/kubo:latest
148
-```
149
-
150
-To [customize your node](https://docs.ipfs.tech/install/run-ipfs-inside-docker/#customizing-your-node),
151
-pass necessary config via `-e` or by mounting scripts in the `/container-init.d`.
152
-
153
-Learn more at https://docs.ipfs.tech/install/run-ipfs-inside-docker/
154
-
155
-### Official prebuilt binaries
156
-
157
-The official binaries are published at https://dist.ipfs.tech#kubo:
158
-
159
-[](https://dist.ipfs.tech#kubo)
160
-
161
-From there:
162
-- Click the blue "Download Kubo" on the right side of the page.
163
-- Open/extract the archive.
164
-- Move kubo (`ipfs`) to your path (`install.sh` can do it for you).
165
-
166
-If you are unable to access [dist.ipfs.tech](https://dist.ipfs.tech#kubo), you can also download kubo from:
167
-- this project's GitHub [releases](https://github.com/ipfs/kubo/releases/latest) page
168
-- `/ipns/dist.ipfs.tech` at [dweb.link](https://dweb.link/ipns/dist.ipfs.tech#kubo) gateway
21
+<p align="center">
22
+<b><a href="#what-is-kubo">What is Kubo?</a></b> | <b><a href="#quick-taste">Quick Taste</a></b> | <b><a href="#install">Install</a></b> | <b><a href="#documentation">Documentation</a></b> | <b><a href="#development">Development</a></b> | <b><a href="#getting-help">Getting Help</a></b>
23
+</p>
24
170
-#### Updating
25
+## What is Kubo?
26
172
-##### Downloading builds using IPFS
27
+Kubo was the first [IPFS](https://docs.ipfs.tech/concepts/what-is-ipfs/) implementation and is the [most widely used one today](https://probelab.io/ipfs/topology/#chart-agent-types-avg). It takes an opinionated approach to content-addressing ([CIDs](https://docs.ipfs.tech/concepts/glossary/#cid), [DAGs](https://docs.ipfs.tech/concepts/glossary/#dag)) that maximizes interoperability: [UnixFS](https://docs.ipfs.tech/concepts/glossary/#unixfs) for files and directories, [HTTP Gateways](https://docs.ipfs.tech/concepts/glossary/#gateway) for web browsers, [Bitswap](https://docs.ipfs.tech/concepts/glossary/#bitswap) and [HTTP](https://specs.ipfs.tech/http-gateways/trustless-gateway/) for verifiable data transfer.
28
174
-List the available versions of Kubo implementation:
29
+**Features:**
30
176
-```console
177
-$ ipfs cat /ipns/dist.ipfs.tech/kubo/versions
178
-```
31
+- Runs an IPFS node as a network service (LAN [mDNS](https://github.com/libp2p/specs/blob/master/discovery/mdns.md) and WAN [Amino DHT](https://docs.ipfs.tech/concepts/glossary/#dht))
32
+- [Command-line interface](https://docs.ipfs.tech/reference/kubo/cli/) (`ipfs --help`)
33
+- [WebUI](https://github.com/ipfs/ipfs-webui/#readme) for node management
34
+- [HTTP Gateway](https://specs.ipfs.tech/http-gateways/) for trusted and [trustless](https://docs.ipfs.tech/reference/http/gateway/#trustless-verifiable-retrieval) content retrieval
35
+- [HTTP RPC API](https://docs.ipfs.tech/reference/kubo/rpc/) to control the daemon
36
+- [HTTP Routing V1](https://specs.ipfs.tech/routing/http-routing-v1/) client and server for [delegated routing](./docs/delegated-routing.md)
37
+- [Content blocking](./docs/content-blocking.md) for public node operators
38
180
-Then, to view available builds for a version from the previous command (`$VERSION`):
39
+**Other IPFS implementations:** [Helia](https://github.com/ipfs/helia) (JavaScript), [more...](https://docs.ipfs.tech/concepts/ipfs-implementations/)
40
182
-```console
183
-$ ipfs ls /ipns/dist.ipfs.tech/kubo/$VERSION
184
-```
41
+## Quick Taste
42
186
-To download a given build of a version:
43
+After [installing Kubo](#install), verify it works:
44
45
```console
189
-$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_darwin-amd64.tar.gz # darwin amd64 build
190
-$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_darwin-arm64.tar.gz # darwin arm64 build
191
-$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_freebsd-amd64.tar.gz # freebsd amd64 build
192
-$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_linux-amd64.tar.gz # linux amd64 build
193
-$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_linux-riscv64.tar.gz # linux riscv64 build
194
-$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_linux-arm64.tar.gz # linux arm64 build
195
-$ ipfs get /ipns/dist.ipfs.tech/kubo/$VERSION/kubo_$VERSION_windows-amd64.zip # windows amd64 build
196
-```
197
-
198
-### Unofficial Linux packages
199
-
200
-<a href="https://repology.org/project/kubo/versions">
201
- <img src="https://repology.org/badge/vertical-allrepos/kubo.svg" alt="Packaging status" align="right">
202
-</a>
203
-
204
-- [ArchLinux](#arch-linux)
205
-- [Gentoo Linux](#gentoo-linux)
206
-- [Nix](#nix-linux)
207
-- [Solus](#solus)
208
-- [openSUSE](#opensuse)
209
-- [Guix](#guix)
210
-- [Snap](#snap)
211
-- [Ubuntu PPA](#ubuntu-ppa)
212
-- [Fedora](#fedora-copr)
213
-
214
-#### Arch Linux
215
-
216
-[](https://wiki.archlinux.org/title/IPFS)
217
-
218
-```bash
219
-# pacman -S kubo
220
-```
221
-
222
-[](https://archlinux.org/packages/kubo/)
223
-
224
-#### <a name="gentoo-linux">Gentoo Linux</a>
225
-
226
-https://wiki.gentoo.org/wiki/Kubo
227
-
228
-```bash
229
-# emerge -a net-p2p/kubo
230
-```
231
-
232
-https://packages.gentoo.org/packages/net-p2p/kubo
233
-
234
-#### <a name="nix-linux">Nix</a>
235
-
236
-With the purely functional package manager [Nix](https://nixos.org/nix/) you can install kubo like this:
237
-
238
-```
239
-$ nix-env -i kubo
240
-```
241
-
242
-You can also install the Package by using its attribute name, which is also `kubo`.
46
+$ ipfs init
47
+generating ED25519 keypair...done
48
+peer identity: 12D3KooWGcSLQdLDBi2BvoP8WnpdHvhWPbxpGcqkf93rL2XMZK7R
49
244
-#### Solus
50
+$ ipfs daemon &
51
+Daemon is ready
52
246
-[Package for Solus](https://dev.getsol.us/source/kubo/repository/master/)
53
+$ echo "hello IPFS" | ipfs add -q --cid-version 1
54
+bafkreicouv3sksjuzxb3rbb6rziy6duakk2aikegsmtqtz5rsuppjorxsa
55
56
+$ ipfs cat bafkreicouv3sksjuzxb3rbb6rziy6duakk2aikegsmtqtz5rsuppjorxsa
57
+hello IPFS
58
```
249
-$ sudo eopkg install kubo
250
-```
251
-
252
-You can also install it through the Solus software center.
253
-
254
-#### openSUSE
255
-
256
-[Community Package for kubo](https://software.opensuse.org/package/kubo)
257
-
258
-#### Guix
259
-
260
-[Community Package for kubo](https://packages.guix.gnu.org/search/?query=kubo) is available.
261
-
262
-#### Snap
59
264
-No longer supported, see rationale in [kubo#8688](https://github.com/ipfs/kubo/issues/8688).
60
+Verify this CID is provided by your node to the IPFS network: <https://check.ipfs.network/?cid=bafkreicouv3sksjuzxb3rbb6rziy6duakk2aikegsmtqtz5rsuppjorxsa>
61
266
-#### Ubuntu PPA
62
+See `ipfs add --help` for all import options. Ready for more? Follow the [command-line quick start](https://docs.ipfs.tech/how-to/command-line-quick-start/).
63
268
-[PPA homepage](https://launchpad.net/~twdragon/+archive/ubuntu/ipfs) on Launchpad.
269
-
270
-##### Latest Ubuntu (>= 20.04 LTS)
271
-```sh
272
-sudo add-apt-repository ppa:twdragon/ipfs
273
-sudo apt update
274
-sudo apt install ipfs-kubo
275
-```
276
-
277
-### Fedora COPR
278
-
279
-[`taw00/ipfs-rpm`](https://github.com/taw00/ipfs-rpm)
280
-
281
-##### Any Ubuntu version
64
+## Install
65
283
-```sh
284
-sudo su
285
-echo 'deb https://ppa.launchpadcontent.net/twdragon/ipfs/ubuntu <<DISTRO>> main' >> /etc/apt/sources.list.d/ipfs
286
-echo 'deb-src https://ppa.launchpadcontent.net/twdragon/ipfs/ubuntu <<DISTRO>> main' >> /etc/apt/sources.list.d/ipfs
287
-exit
288
-sudo apt update
289
-sudo apt install ipfs-kubo
290
-```
291
-where `<<DISTRO>>` is the codename of your Ubuntu distribution (for example, `jammy` for 22.04 LTS). During the first installation the package maintenance script may automatically ask you about which networking profile, CPU accounting model, and/or existing node configuration file you want to use.
66
+Follow the [official installation guide](https://docs.ipfs.tech/install/command-line/), or choose: [prebuilt binary](#official-prebuilt-binaries) | [Docker](#docker) | [package manager](#package-managers) | [from source](#build-from-source).
67
293
-**NOTE**: this method also may work with any compatible Debian-based distro which has `libc6` inside, and APT as a package manager.
68
+Prefer a GUI? Try [IPFS Desktop](https://docs.ipfs.tech/install/ipfs-desktop/) and/or [IPFS Companion](https://docs.ipfs.tech/install/ipfs-companion/).
69
295
-### Unofficial Windows packages
70
+### Minimal System Requirements
71
297
-- [Chocolatey](#chocolatey)
298
-- [Scoop](#scoop)
72
+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).
73
300
-#### Chocolatey
74
+> [!IMPORTANT]
75
+> Larger pinsets require additional memory, with an estimated ~1 GiB of RAM per 20 million items for reproviding to the Amino DHT.
76
302
-No longer supported, see rationale in [kubo#9341](https://github.com/ipfs/kubo/issues/9341).
77
+> [!CAUTION]
78
+> 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.
79
304
-#### Scoop
80
+### Official Prebuilt Binaries
81
306
-Scoop provides kubo as `kubo` in its 'extras' bucket.
82
+Download from https://dist.ipfs.tech#kubo or [GitHub Releases](https://github.com/ipfs/kubo/releases/latest).
83
308
-```Powershell
309
-PS> scoop bucket add extras
310
-PS> scoop install kubo
311
-```
84
+### Docker
85
313
-### Unofficial macOS packages
86
+Official images are published at https://hub.docker.com/r/ipfs/kubo/: [](https://hub.docker.com/r/ipfs/kubo/)
87
315
-- [MacPorts](#macports)
316
-- [Nix](#nix-macos)
317
-- [Homebrew](#homebrew)
88
+#### 🟢 Release Images
89
319
-#### MacPorts
90
+Use these for production deployments.
91
321
-The package [ipfs](https://ports.macports.org/port/ipfs) currently points to kubo and is being maintained.
92
+- `latest` and [`release`](https://hub.docker.com/r/ipfs/kubo/tags?name=release) always point at [the latest stable release](https://github.com/ipfs/kubo/releases/latest)
93
+- [`vN.N.N`](https://hub.docker.com/r/ipfs/kubo/tags?name=v) points at a specific [release tag](https://github.com/ipfs/kubo/releases)
94
323
-```
324
-$ sudo port install ipfs
95
+```console
96
+$ docker pull ipfs/kubo:latest
97
+$ docker run --rm -it --net=host ipfs/kubo:latest
98
```
99
327
-#### <a name="nix-macos">Nix</a>
100
+To [customize your node](https://docs.ipfs.tech/install/run-ipfs-inside-docker/#customizing-your-node), pass config via `-e` or mount scripts in `/container-init.d`.
101
329
-In macOS you can use the purely functional package manager [Nix](https://nixos.org/nix/):
102
+#### 🟠 Developer Preview Images
103
331
-```
332
-$ nix-env -i kubo
333
-```
104
+For internal testing, not intended for production.
105
335
-You can also install the Package by using its attribute name, which is also `kubo`.
106
+- [`master-latest`](https://hub.docker.com/r/ipfs/kubo/tags?name=master-latest) points at `HEAD` of [`master`](https://github.com/ipfs/kubo/commits/master/)
107
+- [`master-YYYY-DD-MM-GITSHA`](https://hub.docker.com/r/ipfs/kubo/tags?name=master-2) points at a specific commit
108
337
-#### Homebrew
109
+#### 🔴 Internal Staging Images
110
339
-A Homebrew formula [ipfs](https://formulae.brew.sh/formula/ipfs) is maintained too.
111
+For testing arbitrary commits and experimental patches (force push to `staging` branch).
112
341
-```
342
-$ brew install --formula ipfs
343
-```
113
+- [`staging-latest`](https://hub.docker.com/r/ipfs/kubo/tags?name=staging-latest) points at `HEAD` of [`staging`](https://github.com/ipfs/kubo/commits/staging/)
114
+- [`staging-YYYY-DD-MM-GITSHA`](https://hub.docker.com/r/ipfs/kubo/tags?name=staging-2) points at a specific commit
115
116
### Build from Source
117
118
119
349
-kubo's build system requires Go and some standard POSIX build tools:
350
-
351
-* GNU make
352
-* Git
353
-* GCC (or some other go compatible C Compiler) (optional)
354
-
355
-To build without GCC, build with `CGO_ENABLED=0` (e.g., `make build CGO_ENABLED=0`).
356
-
357
-#### Install Go
358
-
359
-
360
-
361
-If you need to update: [Download latest version of Go](https://golang.org/dl/).
362
-
363
-You'll need to add Go's bin directories to your `$PATH` environment variable e.g., by adding these lines to your `/etc/profile` (for a system-wide installation) or `$HOME/.profile`:
364
-
365
-```
366
-export PATH=$PATH:/usr/local/go/bin
367
-export PATH=$PATH:$GOPATH/bin
368
-```
369
-
370
-(If you run into trouble, see the [Go install instructions](https://golang.org/doc/install)).
371
-
372
-#### Download and Compile IPFS
373
-
374
-```
375
-$ git clone https://github.com/ipfs/kubo.git
376
-
377
-$ cd kubo
378
-$ make install
379
-```
380
-
381
-Alternatively, you can run `make build` to build the kubo binary (storing it in `cmd/ipfs/ipfs`) without installing it.
382
-
383
-**NOTE:** If you get an error along the lines of "fatal error: stdlib.h: No such file or directory", you're missing a C compiler. Either re-run `make` with `CGO_ENABLED=0` or install GCC.
384
-
385
-##### Cross Compiling
386
-
387
-Compiling for a different platform is as simple as running:
388
-
389
-```
390
-make build GOOS=myTargetOS GOARCH=myTargetArchitecture
120
+```bash
121
+git clone https://github.com/ipfs/kubo.git
122
+cd kubo
123
+make build # creates cmd/ipfs/ipfs
124
+make install # installs to $GOPATH/bin/ipfs
125
```
126
393
-#### Troubleshooting
394
-
395
-- Separate [instructions are available for building on Windows](docs/windows.md).
396
-- `git` is required in order for `go get` to fetch all dependencies.
397
-- Package managers often contain out-of-date `golang` packages.
398
- Ensure that `go version` reports the minimum version required (see go.mod). See above for how to install go.
399
-- If you are interested in development, please install the development
400
-dependencies as well.
401
-- Shell command completions can be generated with one of the `ipfs commands completion` subcommands. Read [docs/command-completion.md](docs/command-completion.md) to learn more.
402
-- See the [misc folder](https://github.com/ipfs/kubo/tree/master/misc) for how to connect IPFS to systemd or whatever init system your distro uses.
127
+See the [Developer Guide](docs/developer-guide.md) for details, Windows instructions, and troubleshooting.
128
404
-## Getting Started
129
+### Package Managers
130
406
-### Usage
131
+Kubo is available in community-maintained packages across many operating systems, Linux distributions, and package managers. See [Repology](https://repology.org/project/kubo/versions) for the full list: [](https://repology.org/project/kubo/versions)
132
408
-[](https://docs.ipfs.tech/how-to/command-line-quick-start/)
409
-[](https://docs.ipfs.tech/reference/kubo/cli/)
133
+> [!WARNING]
134
+> 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](#build-from-source).
135
411
-To start using IPFS, you must first initialize IPFS's config files on your
412
-system, this is done with `ipfs init`. See `ipfs init --help` for information on
413
-the optional arguments it takes. After initialization is complete, you can use
414
-`ipfs mount`, `ipfs add` and any of the other commands to explore!
136
+#### Linux
137
416
-For detailed configuration options, see [docs/config.md](https://github.com/ipfs/kubo/blob/master/docs/config.md).
138
+| Distribution | Install | Version |
139
+|--------------|---------|---------|
140
+| Ubuntu | [PPA](https://launchpad.net/~twdragon/+archive/ubuntu/ipfs): `sudo apt install ipfs-kubo` | [](https://launchpad.net/~twdragon/+archive/ubuntu/ipfs) |
141
+| Arch | `pacman -S kubo` | [](https://archlinux.org/packages/extra/x86_64/kubo/) |
142
+| Fedora | [COPR](https://copr.fedorainfracloud.org/coprs/taw/ipfs/): `dnf install kubo` | [](https://copr.fedorainfracloud.org/coprs/taw/ipfs/) |
143
+| Nix | `nix-env -i kubo` | [](https://search.nixos.org/packages?query=kubo) |
144
+| Gentoo | `emerge -a net-p2p/kubo` | [](https://packages.gentoo.org/packages/net-p2p/kubo) |
145
+| openSUSE | `zypper install kubo` | [](https://software.opensuse.org/package/kubo) |
146
+| Solus | `sudo eopkg install kubo` | [](https://packages.getsol.us/shannon/k/kubo/) |
147
+| Guix | `guix install kubo` | [](https://packages.guix.gnu.org/packages/kubo/) |
148
+| _other_ | [See Repology for the full list](https://repology.org/project/kubo/versions) | |
149
418
-### Some things to try
150
+~~Snap~~ no longer supported ([#8688](https://github.com/ipfs/kubo/issues/8688))
151
420
-Basic proof of 'ipfs working' locally:
152
+#### macOS
153
422
- echo "hello world" > hello
423
- ipfs add hello
424
- # This should output a hash string that looks something like:
425
- # QmT78zSuBmuS4z925WZfrqQ1qHaJ56DQaTfyMUF7F8ff5o
426
- ipfs cat <that hash>
154
+| Manager | Install | Version |
155
+|---------|---------|---------|
156
+| Homebrew | `brew install ipfs` | [](https://formulae.brew.sh/formula/ipfs) |
157
+| MacPorts | `sudo port install ipfs` | [](https://ports.macports.org/port/ipfs/) |
158
+| Nix | `nix-env -i kubo` | [](https://search.nixos.org/packages?query=kubo) |
159
+| _other_ | [See Repology for the full list](https://repology.org/project/kubo/versions) | |
160
428
-### HTTP/RPC clients
161
+#### Windows
162
430
-For programmatic interaction with Kubo, see our [list of HTTP/RPC clients](docs/http-rpc-clients.md).
163
+| Manager | Install | Version |
164
+|---------|---------|---------|
165
+| Scoop | `scoop install kubo` | [](https://scoop.sh/#/apps?q=kubo) |
166
+| _other_ | [See Repology for the full list](https://repology.org/project/kubo/versions) | |
167
432
-### Troubleshooting
168
+~~Chocolatey~~ no longer supported ([#9341](https://github.com/ipfs/kubo/issues/9341))
169
434
-If you have previously installed IPFS before and you are running into problems getting a newer version to work, try deleting (or backing up somewhere else) your IPFS config directory (~/.ipfs by default) and rerunning `ipfs init`. This will reinitialize the config file to its defaults and clear out the local datastore of any bad entries.
170
+## Documentation
171
436
-For more information about configuration options, see [docs/config.md](https://github.com/ipfs/kubo/blob/master/docs/config.md).
437
-
438
-Please direct general questions and help requests to our [forums](https://discuss.ipfs.tech).
439
-
440
-If you believe you've found a bug, check the [issues list](https://github.com/ipfs/kubo/issues) and, if you don't see your problem there, either come talk to us on [Matrix chat](https://docs.ipfs.tech/community/chat/), or file an issue of your own!
441
-
442
-## Packages
443
-
444
-See [IPFS in GO](https://docs.ipfs.tech/reference/go/api/) documentation.
172
+| Topic | Description |
173
+|-------|-------------|
174
+| [Configuration](docs/config.md) | All config options reference |
175
+| [Environment variables](docs/environment-variables.md) | Runtime settings via env vars |
176
+| [Experimental features](docs/experimental-features.md) | Opt-in features in development |
177
+| [HTTP Gateway](docs/gateway.md) | Path, subdomain, and trustless gateway setup |
178
+| [HTTP RPC clients](docs/http-rpc-clients.md) | Client libraries for Go, JS |
179
+| [Delegated routing](docs/delegated-routing.md) | Multi-router and HTTP routing |
180
+| [Metrics & monitoring](docs/metrics.md) | Prometheus metrics |
181
+| [Content blocking](docs/content-blocking.md) | Denylist for public nodes |
182
+| [Customizing](docs/customizing.md) | Unsure if use Plugins, Boxo, or fork? |
183
+| [Debug guide](docs/debug-guide.md) | CPU profiles, memory analysis, tracing |
184
+| [Changelogs](docs/changelogs/) | Release notes for each version |
185
+| [All documentation](https://github.com/ipfs/kubo/tree/master/docs) | Full list of docs |
186
187
## Development
188
448
-See the [Developer Guide](docs/developer-guide.md) for build instructions, testing, architecture, and contribution workflow.
189
+See the [Developer Guide](docs/developer-guide.md) for build instructions, testing, and contribution workflow.
190
450
-## Maintainer Info
191
+## Getting Help
192
452
-Kubo is maintained by [Shipyard](https://ipshipyard.com/).
193
+- [IPFS Forum](https://discuss.ipfs.tech) - community support, questions, and discussion
194
+- [Community](https://docs.ipfs.tech/community/) - chat, events, and working groups
195
+- [GitHub Issues](https://github.com/ipfs/kubo/issues) - bug reports for Kubo specifically
196
+- [IPFS Docs Issues](https://github.com/ipfs/ipfs-docs/issues) - documentation issues
197
454
-* This repository is part of [Shipyard's GO Triage triage](https://ipshipyard.notion.site/IPFS-Go-Triage-Boxo-Kubo-Rainbow-0ddee6b7f28d412da7dabe4f9107c29a).
455
-* [Release Process](https://ipshipyard.notion.site/Kubo-Release-Process-6dba4f5755c9458ab5685eeb28173778)
198
+## Security Issues
199
200
+See [`SECURITY.md`](SECURITY.md).
201
202
## Contributing
203
204
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
205
462
-We ❤️ all [our contributors](docs/AUTHORS); this project wouldn’t be what it is without you! If you want to help out, please see [CONTRIBUTING.md](CONTRIBUTING.md).
206
+We welcome contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) and the [Developer Guide](docs/developer-guide.md).
207
464
-This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
208
+This repository follows the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
209
+
210
+## Maintainer Info
211
466
-Members of IPFS community provide Kubo support on [discussion forum category here](https://discuss.ipfs.tech/c/help/help-kubo/23).
212
+<a href="https://ipshipyard.com/"><img align="right" src="https://github.com/user-attachments/assets/39ed3504-bb71-47f6-9bf8-cb9a1698f272" /></a>
213
468
-Need help with IPFS itself? Learn where to get help and support at https://ipfs.tech/help.
214
+> [!NOTE]
215
+> Kubo is maintained by the [Shipyard](https://ipshipyard.com/) team.
216
+>
217
+> [Release Process](https://ipshipyard.notion.site/Kubo-Release-Process-6dba4f5755c9458ab5685eeb28173778)
218
219
## License
220
472
-This project is dual-licensed under Apache 2.0 and MIT terms:
221
+Dual-licensed under Apache 2.0 and MIT:
222
474
-- Apache License, Version 2.0, ([LICENSE-APACHE](https://github.com/ipfs/kubo/blob/master/LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
475
-- MIT license ([LICENSE-MIT](https://github.com/ipfs/kubo/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT)
223
+- [LICENSE-APACHE](LICENSE-APACHE)
224
+- [LICENSE-MIT](LICENSE-MIT)