You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-8Lines changed: 25 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,6 +62,7 @@ Boxo powers [Kubo](https://github.com/ipfs/kubo), which is [the most popular IPF
62
62
so its code has been battle-tested on the IPFS network for years, and is well-understood by the community.
63
63
64
64
### Motivation
65
+
65
66
**TL;DR** The goal of this repo is to help people build things. Previously users struggled to find existing useful code or to figure out how to use what they did find. We observed many running Kubo and using its HTTP RPC API. This repo aims to do better. We're taking the libraries that many were already effectively relying on in production and making them more easily discoverable and usable.
66
67
67
68
The maintainers primarily aim to help people trying to build with IPFS in Go that were previously either giving up or relying on the [Kubo HTTP RPC API](https://docs.ipfs.tech/reference/kubo/rpc/). Some of these people will end up being better served by IPFS tooling in other languages (e.g., Javascript, Rust, Java, Python), but for those who are either looking to write in Go or to leverage the set of IPFS tooling we already have in Go we’d like to make their lives easier.
@@ -73,6 +74,7 @@ Boxo is not exhaustive nor comprehensive--there are plenty of useful IPFS protoc
73
74
More details can also be found in the [Rationale FAQ](./docs/FAQ.md#rationale-faq).
74
75
75
76
## Scope
77
+
76
78
### What kind of components does Boxo have?
77
79
78
80
Boxo includes high-quality components useful for interacting with IPFS protocols, public and private IPFS networks, and content-addressed data, such as:
@@ -86,20 +88,23 @@ Boxo includes high-quality components useful for interacting with IPFS protocols
86
88
Boxo aims to provide a cohesive interface into these components. Note that not all of the underlying components necessarily reside in this respository.
87
89
88
90
### Does Boxo == IPFS?
89
-
No. This repo houses some IPFS functionality written in Go that has been useful in practice, and is maintained by a group that has long term commitments to the IPFS project
90
91
91
-
### Is everything related to IPFS in the Go ecosystem in this repo?
92
+
No. This repo houses some IPFS functionality written in Go that has been useful in practice, and is maintained by a group that has long term commitments to the IPFS project
92
93
93
-
No. Not everything related to IPFS is intended to be in Boxo. View it as a starter toolbox (potentially among multiple). If you’d like to build an IPFS implementation with Go, here are some tools you might want that are maintained by a group that has long term commitments to the IPFS project. There are certainly repos that others maintain that aren't included here (e.g., ipfs/go-car) which are still useful to IPFS implementations. It's expected and fine for new IPFS functionality to be developed that won't be part of Boxo.
94
+
### Is everything related to IPFS in the Go ecosystem in this repo?
94
95
96
+
No. Not everything related to IPFS is intended to be in Boxo. View it as a starter toolbox (potentially among multiple). If you’d like to build an IPFS implementation with Go, here are some tools you might want that are maintained by a group that has long term commitments to the IPFS project. There are certainly repos that others maintain that aren't included here (e.g., ipfs/go-car) which are still useful to IPFS implementations. It's expected and fine for new IPFS functionality to be developed that won't be part of Boxo.
95
97
96
98
## Consuming
99
+
97
100
### Getting started
101
+
98
102
See [examples](./examples/README.md).
99
103
100
104
If you are migrating to Boxo, see [Migrating to Boxo](#migrating-to-boxo).
101
105
102
106
### Migrating to Boxo
107
+
103
108
Many Go modules under github.com/ipfs have moved here. Boxo provides a tool to ease this migration, which does most of the work for you:
104
109
105
110
*`cd` into the root directory of your module (where the `go.mod` file is)
@@ -116,10 +121,13 @@ We recommend upgrading to v0.8.0 first, and _then_ upgrading to the latest Boxo
116
121
If you encounter any challenges, please [open an issue](https://github.com/ipfs/boxo/issues/new/choose) and Boxo maintainers will help you.
117
122
118
123
### Deprecations & Breaking Changes
124
+
119
125
See [RELEASE.md](./RELEASE.md).
120
126
121
127
## Development
128
+
122
129
### Should I add my IPFS component to Boxo?
130
+
123
131
We happily accept external contributions! However, Boxo maintains a high quality bar, so code accepted into Boxo must meet some minimum maintenance criteria:
124
132
125
133
* Actively maintained
@@ -137,37 +145,46 @@ We happily accept external contributions! However, Boxo maintains a high quality
137
145
If you have some experimental component that you think would benefit the IPFS community, we suggest you build the component in your own repository until it's clear that there's community demand for it, and then open an issue/PR in this repository to discuss including it in Boxo.
138
146
139
147
### Release Process
148
+
140
149
See [RELEASE.md](./RELEASE.md).
141
150
142
151
### Why is the code coverage so bad?
143
152
144
153
The code coverage of this repo is not currently representative of the actual test coverage of this code. Much of the code in this repo is currently covered by integration tests in [Kubo](https://github.com/ipfs/kubo). We are in the process of moving those tests here, and as that continues the code coverage will significantly increase.
145
154
146
155
## General
156
+
147
157
### Help
148
158
149
159
If you have questions, feel free to open an issue. You can also find the Boxo maintainers in [Filecoin Slack](https://filecoin.io/slack/) at #Boxo-maintainers. (If you would like to engage via IPFS Discord or ipfs.io Matrix, please drop into the #ipfs-implementers channel/room or file an issue, and we'll get bridging from #Boxo-maintainers to these other chat platforms.)
150
160
151
161
### What is the response time for issues or PRs filed?
152
-
TODO: fill this in. New issues and PRs to this repo are usually looked at on a weekly basis as part of [Kubo triage](https://pl-strflt.notion.site/Kubo-Issue-Triage-Notes-7d4983e8cf294e07b3cc51b0c60ede9a).
162
+
163
+
New issues and PRs to this repo are usually looked at on a weekly basis as part of [Kubo triage](https://pl-strflt.notion.site/Kubo-Issue-Triage-Notes-7d4983e8cf294e07b3cc51b0c60ede9a). However, the response time may vary.
153
164
154
165
### What are some projects that depend on this project?
155
-
The exhaustive list is https://github.com/ipfs/boxo/network/dependents. Some notable projects include:
166
+
167
+
The exhaustive list is https://github.com/ipfs/boxo/network/dependents. Some notable projects include:
168
+
156
169
1.[Kubo](https://github.com/ipfs/kubo), an IPFS implementation in Go
157
170
2.[Lotus](https://github.com/filecoin-project/lotus), a Filecoin implementation in Go
158
-
3.[Bifrost Gateway](https://github.com/ipfs/bifrost-gateway), a dedicated IPFS gateway
171
+
6.[rainbow](https://github.com/ipfs/rainbow), a specialized IPFS gateway
159
172
4.[ipfs-check](https://github.com/ipfs-shipyard/ipfs-check), checks IPFS data availability
173
+
5.[someguy](https://github.com/ipfs-shipyard/someguy), a dedicated Delegated Routing V1 server and client
174
+
3.[Bifrost Gateway](https://github.com/ipfs/bifrost-gateway), a dedicated IPFS Gateway daemon backed by a remote datastore
160
175
161
176
### Governance and Access
162
-
See [CODEOWNERS](./docs/CODEOWNERS) for the current maintainers list. Governance for graduating additional maintainers hasn't been established. Repo permissions are all managed through [ipfs/github-mgmt](https://github.com/ipfs/github-mgmt).
177
+
178
+
See [CODEOWNERS](./docs/CODEOWNERS) for the current maintainers list. Governance for graduating additional maintainers hasn't been established. Repo permissions are all managed through [ipfs/github-mgmt](https://github.com/ipfs/github-mgmt).
163
179
164
180
### Why is this named "Boxo"?
181
+
165
182
See https://github.com/ipfs/boxo/issues/215.
166
183
167
184
### Additional Docs & FAQs
185
+
168
186
See [the wiki](https://github.com/ipfs/boxo/wiki).
169
187
170
188
### License
171
189
172
190
[SPDX-License-Identifier: Apache-2.0 OR MIT](LICENSE.md)
0 commit comments