docs: clarify Gateway.ExposeRoutingAPI (#10337)
* docs: clarify Gateway.ExposeRoutingAPI Closes #10195 * Apply suggestions from code review Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com> --------- Co-authored-by: Henrique Dias <mail@hacdias.com> Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>
Marcin Rataj committed
Feb 9, 2024 at 16:07 UTC
68f955664a43a760c886bf772d7923bf063e3830
1 file changed
+9
-5
docs/config.md
+9
-5
@@ -762,11 +762,15 @@ Type: `flag`
762
763
### `Gateway.ExposeRoutingAPI`
764
765
-An optional flag to expose Kubo `Routing` system on the gateway port as a [Routing
766
-V1](https://specs.ipfs.tech/routing/routing-v1/) endpoint. This only affects your
767
-local gateway, at `127.0.0.1`.
768
-
769
-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).
765
+An optional flag to expose Kubo `Routing` system on the gateway port
766
+as an [HTTP `/routing/v1`](https://specs.ipfs.tech/routing/routing-v1/) endpoint on `127.0.0.1`.
767
+Use reverse proxy to expose it on a different hostname.
768
+
769
+This endpoint can be used by other Kubo instances, as illustrated in
770
+[`delegated_routing_v1_http_proxy_test.go`](https://github.com/ipfs/kubo/blob/master/test/cli/delegated_routing_v1_http_proxy_test.go).
771
+Kubo will filter out routing results which are not actionable, for example, all
772
+graphsync providers will be skipped. If you need a generic pass-through, see
773
+standalone router implementation named [someguy](https://github.com/ipfs/someguy).
774
775
Default: `false`
776