master
md 60 lines 2.02 KB
Rendered Raw
1 # Developer Documentation and Guides
2
3 If you're looking for User Documentation & Guides, visit [docs.ipfs.tech](https://docs.ipfs.tech/).
4
5 If you're experiencing an issue with IPFS, please [file an issue](https://github.com/ipfs/kubo/issues/new/choose) in this repository.
6
7 ## Configuration
8
9 - [Configuration reference](config.md)
10 - [Datastore configuration](datastores.md)
11 - [Experimental features](experimental-features.md)
12 - [Environment variables](environment-variables.md)
13
14 ## Running Kubo
15
16 - [Gateway configuration](gateway.md)
17 - [Delegated routing](delegated-routing.md)
18 - [Content blocking](content-blocking.md) (for public node operators)
19 - [libp2p resource management](libp2p-resource-management.md)
20 - [Mounting IPFS with FUSE](fuse.md)
21
22 ## Metrics & Monitoring
23
24 - [Prometheus metrics](metrics.md)
25 - [Telemetry plugin](telemetry.md)
26 - [Provider statistics](provide-stats.md)
27 - [Performance debugging](debug-guide.md)
28
29 ## Development
30
31 - **[Developer Guide](developer-guide.md)** - prerequisites, build, test, and contribute
32 - **[AGENTS.md](../AGENTS.md)** - instructions for AI coding agents
33 - 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)
34 - [Building on Windows](windows.md)
35 - [Customizing Kubo](customizing.md)
36 - [Installing plugins](plugins.md)
37 - [Release checklist](releases.md)
38
39 ## Guides
40
41 - [Transferring files over IPFS](file-transfer.md)
42 - [How to implement an API client](implement-api-bindings.md)
43 - [HTTP/RPC clients](http-rpc-clients.md)
44 - [Websocket transports](transports.md)
45 - [Command completion](command-completion.md)
46
47 ## Production
48
49 - [Reverse proxy setup](production/reverse-proxy.md)
50 - [Firewall setup (ufw)](production/firewall.md)
51
52 ## Specifications
53
54 - [Repository structure](specifications/repository.md)
55 - [Filesystem datastore](specifications/repository_fs.md)
56 - [Keystore](specifications/keystore.md)
57
58 ## Examples
59
60 - [Kubo as a library](examples/kubo-as-a-library/README.md)