docs: clarify Gateway.ExposeRoutingAPI (#10337)

* docs: clarify Gateway.ExposeRoutingAPI Closes #10195 * Apply suggestions from code review Co-authored-by: Daniel Norman <[email protected]> --------- Co-authored-by: Henrique Dias <[email protected]> Co-authored-by: Daniel Norman <[email protected]>
ipfs · Feb 9, 2024 · 68f9556 · 68f9556
1 parent eb7f663
commit 68f9556
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/docs/config.md b/docs/config.md
@@ -762,11 +762,15 @@ Type: `flag`
 
 ### `Gateway.ExposeRoutingAPI`
 
-An optional flag to expose Kubo `Routing` system on the gateway port as a [Routing
-V1](https://specs.ipfs.tech/routing/routing-v1/) endpoint.  This only affects your
-local gateway, at `127.0.0.1`.
-
-This endpoint can be used by other Kubo instance, as illustrated in [`delegated_routing_v1_http_proxy_test.go`](https://github.com/ipfs/kubo/blob/master/test/cli/delegated_routing_v1_http_proxy_test.go).
+An optional flag to expose Kubo `Routing` system on the gateway port
+as an [HTTP `/routing/v1`](https://specs.ipfs.tech/routing/routing-v1/) endpoint on `127.0.0.1`.
+Use reverse proxy to expose it on a different hostname.
+
+This endpoint can be used by other Kubo instances, as illustrated in
+[`delegated_routing_v1_http_proxy_test.go`](https://github.com/ipfs/kubo/blob/master/test/cli/delegated_routing_v1_http_proxy_test.go).
+Kubo will filter out routing results which are not actionable, for example, all
+graphsync providers will be skipped. If you need a generic pass-through, see
+standalone router implementation named [someguy](https://github.com/ipfs/someguy).
 
 Default: `false`