mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-21 10:27:46 +08:00
9539b4d8b8
- 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)
59 lines
1.9 KiB
Markdown
59 lines
1.9 KiB
Markdown
# Developer Documentation and Guides
|
|
|
|
If you're looking for User Documentation & Guides, visit [docs.ipfs.tech](https://docs.ipfs.tech/).
|
|
|
|
If you're experiencing an issue with IPFS, please [file an issue](https://github.com/ipfs/kubo/issues/new/choose) in this repository.
|
|
|
|
## Configuration
|
|
|
|
- [Configuration reference](config.md)
|
|
- [Datastore configuration](datastores.md)
|
|
- [Experimental features](experimental-features.md)
|
|
- [Environment variables](environment-variables.md)
|
|
|
|
## Running Kubo
|
|
|
|
- [Gateway configuration](gateway.md)
|
|
- [Delegated routing](delegated-routing.md)
|
|
- [Content blocking](content-blocking.md) (for public node operators)
|
|
- [libp2p resource management](libp2p-resource-management.md)
|
|
- [Mounting IPFS with FUSE](fuse.md)
|
|
|
|
## Metrics & Monitoring
|
|
|
|
- [Prometheus metrics](metrics.md)
|
|
- [Telemetry plugin](telemetry.md)
|
|
- [Provider statistics](provide-stats.md)
|
|
- [Performance debugging](debug-guide.md)
|
|
|
|
## Development
|
|
|
|
- **[Developer Guide](developer-guide.md)** - prerequisites, build, test, and contribute
|
|
- Contributing Guidelines [for IPFS projects](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and for [Go code specifically](https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md)
|
|
- [Building on Windows](windows.md)
|
|
- [Customizing Kubo](customizing.md)
|
|
- [Installing plugins](plugins.md)
|
|
- [Release checklist](releases.md)
|
|
|
|
## Guides
|
|
|
|
- [Transferring files over IPFS](file-transfer.md)
|
|
- [How to implement an API client](implement-api-bindings.md)
|
|
- [HTTP/RPC clients](http-rpc-clients.md)
|
|
- [Websocket transports](transports.md)
|
|
- [Command completion](command-completion.md)
|
|
|
|
## Production
|
|
|
|
- [Reverse proxy setup](production/reverse-proxy.md)
|
|
|
|
## Specifications
|
|
|
|
- [Repository structure](specifications/repository.md)
|
|
- [Filesystem datastore](specifications/repository_fs.md)
|
|
- [Keystore](specifications/keystore.md)
|
|
|
|
## Examples
|
|
|
|
- [Kubo as a library](examples/kubo-as-a-library/README.md)
|