mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-21 18:37:45 +08:00
- docs/README.md: restructure to surface 20+ previously undiscoverable docs - docs/README.md: fix broken github-issue-guide.md link (file was removed) - docs/add-code-flow.md: rewrite with current code flow and mermaid diagrams - docs/customizing.md, docs/gateway.md: use specs.ipfs.tech URLs - README.md: fix orphan #nix anchor, use go.dev links, link to contributors graph - remove stale docs/AUTHORS and docs/generate-authors.sh (last updated 2016) |
||
|---|---|---|
| .. | ||
| changelogs | ||
| examples | ||
| logo | ||
| production | ||
| specifications | ||
| add-code-flow.md | ||
| cli-http-api-core-diagram.png | ||
| command-completion.md | ||
| config.md | ||
| content-blocking.md | ||
| customizing.md | ||
| datastores.md | ||
| debug-guide.md | ||
| delegated-routing.md | ||
| developer-certificate-of-origin | ||
| developer-guide.md | ||
| EARLY_TESTERS.md | ||
| environment-variables.md | ||
| experimental-features.md | ||
| file-transfer.md | ||
| fuse.md | ||
| gateway.md | ||
| http-rpc-clients.md | ||
| implement-api-bindings.md | ||
| libp2p-resource-management.md | ||
| metrics.md | ||
| p2p-tunnels.md | ||
| plugins.md | ||
| provide-stats.md | ||
| README.md | ||
| RELEASE_CHECKLIST.md | ||
| RELEASE_ISSUE_TEMPLATE.md | ||
| releases_thunderdome.md | ||
| releases.md | ||
| telemetry.md | ||
| transports.md | ||
| windows.md | ||
Developer Documentation and Guides
If you're looking for User Documentation & Guides, visit docs.ipfs.tech.
If you're experiencing an issue with IPFS, please file an issue in this repository.
Configuration
Running Kubo
- Gateway configuration
- Delegated routing
- Content blocking (for public node operators)
- libp2p resource management
- Mounting IPFS with FUSE
Metrics & Monitoring
Development
- Developer Guide - prerequisites, build, test, and contribute
- Contributing Guidelines for IPFS projects and for Go code specifically
- Building on Windows
- Customizing Kubo
- Installing plugins
- Release checklist
Guides
- Transferring files over IPFS
- How to implement an API client
- HTTP/RPC clients
- Websocket transports
- Command completion