coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-25 04:17:44 +08:00
Code Issues Actions 14 Packages Projects Releases Wiki Activity
04d1369a63
kubo/docs
History
Jesse Bouwman cb189c7b78 go mod tidy ipfs library example 
The code example for using IPFS as a library doesn't run unless indirect dependencies are updated:

```
$ go version
go version go1.17 linux/amd64
$ uname -a
Linux home 4.19.0-17-amd64 #1 SMP Debian 4.19.194-3 (2021-07-18) x86_64 GNU/Linux
$ go run main.go
go: github.com/ipfs/go-ipfs@v0.9.1 requires
	github.com/ipfs/go-bitswap@v0.4.0: missing go.sum entry; to add it:
	go mod download github.com/ipfs/go-bitswap
go: github.com/ipfs/go-ipfs@v0.9.1 requires
	github.com/ipfs/go-bitswap@v0.4.0: missing go.sum entry; to add it:
	go mod download github.com/ipfs/go-bitswap
```

Remedied by:

```
$ go mod tidy
$ go run main.go
-- Getting an IPFS node running --
Spawning node on a temporary repo
    ...
```

Also, require go version 1.16, otherwise, example can fail under go
1.15 with errors like:

```
go build github.com/lucas-clemente/quic-go/internal/qtls:
    build constraints exclude all Go files in
    /home/jbouwman/go/pkg/mod/github.com/lucas-clemente/quic-go@v0.23.0/internal/qtls
```
2021-08-30 09:00:39 -07:00
..
examples go mod tidy ipfs library example 2021-08-30 09:00:39 -07:00
production doc: document reverse proxy bug 2020-06-15 17:01:40 -07:00
add-code-flow.md Added link to doc in README.md 2019-01-15 21:08:37 -05:00
AUTHORS Updated authors doc 2016-08-18 11:54:48 -07:00
cli-http-api-core-diagram.png docs: README refresh, add cli-http-api-core diagram 2018-08-22 16:09:51 -07:00
command-completion.md doc(completion): suggest eval instead of writing a file 2021-07-01 08:46:52 -07:00
config.md support bitswap configurability (#8268) 2021-08-18 14:15:16 -04:00
datastores.md docs(datastore): fixup some notes on sync safety 2020-04-27 15:19:49 -07:00
debug-guide.md fix: spelling 2021-07-21 20:45:45 -07:00
developer-certificate-of-origin Add developer certificate of origin document 2017-06-26 15:36:35 -07:00
EARLY_TESTERS.md docs: add pacman.store (@RubenKelevra) to the early testers 2020-05-26 16:07:36 +02:00
environment-variables.md fix: macos notarized fs-repo-migrations (#8333) 2021-08-12 18:52:23 +02:00
experimental-features.md docs: added experimental features documentation on the Accelerated DHT Client and batched providing system 2021-05-14 01:47:48 -07:00
file-transfer.md quic: remove experimental status and add it to the default config 2020-05-22 04:54:19 +02:00
fuse.md Added additional note about killing the daemon 2020-04-01 20:40:56 -07:00
gateway.md feat(gateway): ?filename with download=true 2020-09-16 22:15:18 +02:00
generate-authors.sh added AUTHORS file 2015-02-11 07:42:21 -08:00
implement-api-bindings.md docs: fix inconsistent capitalization of "API". 2018-12-06 12:13:41 -05:00
PATCH_RELEASE_TEMPLATE.md Create PATCH_RELEASE_TEMPLATE.md 2021-07-20 17:00:16 -07:00
plugins.md stop using deprecated Go flag -i 2021-05-15 17:27:52 -07:00
README.md docs: link remaining docs available, guide people to the right locations 2019-10-01 17:23:47 +03:00
RELEASE_ISSUE_TEMPLATE.md doc: document security fix policy 2021-03-18 12:02:36 -07:00
releases.md doc: document security fix policy 2021-03-18 12:02:36 -07:00
snap.md docs: add notes on snap build and publish 2020-10-12 18:13:09 +01:00
transports.md doc: update documentation for /ipfs -> /p2p multiaddr switch 2019-12-14 19:39:59 +01:00
windows.md doc: remove mentions of gx 2019-06-05 16:11:01 -07:00

README.md

Developer Documentation and Guides

If you are looking for User Documentation & Guides, please visit docs.ipfs.io.

If you’re experiencing an issue with IPFS, please follow our issue guide when filing an issue!

Otherwise, check out the following guides to using and developing IPFS:

Developing go-ipfs

Guides

Advanced User Guides

Other