Skip to content

Commit 3b4e2e4

Browse files
authored
Merge pull request #12 from n0-computer/b5/moar_kubo_compat_notes
add kubo compat notes
2 parents 2bd8565 + f5b9abe commit 3b4e2e4

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

content/docs/iroh-and-kubo/_index.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,36 @@ template="docs/page.html"
66
section="iroh"
77
+++
88

9-
# Kubo Command Comparison
9+
# Feature Support
1010

11-
[kubo](https://github.com/ipfs/kubo) is the reference implementation for the IPFS protocol. The following table maps commands within kubo to their corresponding support in iroh flavors:
11+
[Iroh](https://iroh.computer) & [Kubo](https://docs.ipfs.tech) (formerly go-ipfs) are both implementations of [IPFS](https://ipfs.io).
12+
13+
| | Kubo | Iroh |
14+
| --- | --- | --- |
15+
| Language | go | rust |
16+
| License | dual MIT/Apache-2.0 | dual MIT/Apache-2.0 |
17+
| Project Start | Feb 2015 | April 2022 |
18+
19+
[kubo](https://github.com/ipfs/kubo) is the reference implementation for the IPFS protocol. Iroh doesn’t aim to implement all features that kubo supports. Instead iroh focuses on the most-used parts of the protocol that can be integrated into a performance sensitive context.
20+
21+
# Hash compatibility
22+
23+
UnixFS content created with kubo can be read by iroh, and vice versa. However, **content added to Iroh will not output the same hash as the same content created with kubo.** This is because Iroh uses different defaults for adding content.
24+
25+
# HTTP Gateway
26+
27+
What started as the [Kubo HTTP Gateway](https://docs.ipfs.tech/reference/http/gateway/) has been codified into a [specification](https://github.com/ipfs/specs/tree/main/http-gateways) which both iroh and kubo support. Iroh has the following caveats:
28+
29+
- iroh does not yet support [subdomain gateways](https://github.com/ipfs/specs/blob/main/http-gateways/SUBDOMAIN_GATEWAY.md)
30+
- HTML templates for items like UnixFS directories will differ when rendered with iroh
31+
32+
# Kubo RPC API
33+
34+
The [Kubo RPC API](https://docs.ipfs.tech/reference/kubo/rpc/) provides an HTTP an interface for controlling a kubo node. Iroh does not have the same API and instead uses the `iroh` command line client to issue requests that control iroh services.
35+
36+
# Detailed command comparison
37+
38+
The following table maps commands within kubo to their corresponding support in iroh:
1239

1340
<div>
1441
<div id="commands_table"></div>

0 commit comments

Comments
 (0)