From 8c7a1f5b219a99525d42bd2ffa0ff3b0ebba04d4 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Thu, 28 Oct 2021 17:11:31 +0200 Subject: [PATCH] docs(config): fix links and headers License: MIT Signed-off-by: Marcin Rataj --- docs/config.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/config.md b/docs/config.md index 99eb212b263b..549ae325f2b8 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1283,9 +1283,8 @@ Enables "automatic relay user" mode for this node. Your node will automatically _use_ public relays from the network if it detects that it cannot be reached from the public internet (e.g., it's behind a firewall) and get a `/p2p-circuit` address from a public relay. -This is likely the feature you're looking for. -See also: +This is likely the feature you're looking for, but see also: - [`Swarm.RelayService.Enabled`](#swarmrelayserviceenabled) if your node should act as a limited relay for other peers - Docs: [Libp2p Circuit Relay](https://docs.libp2p.io/concepts/circuit-relay/) @@ -1296,15 +1295,13 @@ Type: `bool` ### `Swarm.RelayService` Configuration options for the relay service that can be provided to _other_ peers -on the network. -- Docs: [Libp2p Circuit Relay](https://docs.libp2p.io/concepts/circuit-relay/) -- Specs: [Circuit Relay v2](https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md) +on the network ([Circuit Relay v2](https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md)). Default: `{}` Type: `object` -### `Swarm.RelayService.Enabled` +#### `Swarm.RelayService.Enabled` Enables providing `/p2p-circuit` v2 relay service to other peers on the network. @@ -1406,7 +1403,7 @@ Type: `optionalInteger` **REMOVED** -Replaced with [`Swarm.RelayService.Enabled`][]. +Replaced with [`Swarm.RelayService.Enabled`][#swarmrelayserviceenabled]. ### `Swarm.DisableRelay` @@ -1424,7 +1421,7 @@ Type: `bool` **REMOVED** -Please use [`AutoNAT.ServiceMode`][]. +Please use [`AutoNAT.ServiceMode`][#autonatservicemode]. ### `Swarm.ConnMgr`