Skip to content

Commit 879f479

Browse files
authored
docs: fix muxer selection doc and UPnP config (#1848)
- Reinstates muxer selection header - Restores code fence abouve UPnP section.
1 parent f427cfc commit 879f479

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/CONFIGURATION.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,6 @@ Some available stream multiplexers are:
9393

9494
Some transports such as WebRTC and WebTransport come with their own built-in stream multiplexing capabilities.
9595

96-
If you configure multiple muxers for use in your application, js-libp2p will choose the first muxer in the list. Therefore, ordering matters.
97-
9896
If none of the available stream multiplexers fulfills your needs, you can create a libp2p compatible stream multiplexer. A libp2p multiplexer just needs to be compliant with the [Stream Muxer Interface](https://github.com/libp2p/js-interfaces/tree/master/src/stream-muxer).
9997

10098
If you want to know more about libp2p stream multiplexing, you should read the following content:
@@ -103,6 +101,10 @@ If you want to know more about libp2p stream multiplexing, you should read the f
103101
- https://github.com/libp2p/specs/tree/master/connections
104102
- https://github.com/libp2p/specs/tree/master/mplex
105103

104+
#### Muxer Selection
105+
106+
If you configure multiple muxers for use in your application, js-libp2p will choose the first muxer in the list. Therefore, ordering matters.
107+
106108
### Connection Encryption
107109

108110
> A connection encryption mechanism must be used, in order to ensure all exchanged data between two peers is encrypted.
@@ -590,7 +592,7 @@ Libp2p allows you to setup a secure keychain to manage your keys. The keychain c
590592
| pass | `string` | Passphrase to use in the keychain (minimum of 20 characters). |
591593
| dek | `DEKConfig` | the default options for generating the derived encryption key, which, along with the passphrase are input to the PBKDF2 function. For more info see: https://github.com/libp2p/js-libp2p-keychain |
592594

593-
The keychain will store keys encrypted in the datastore which default is an in memory datastore. If you want to store the keys on disc you need to initialize libp2p with a suitable datastore implementation.
595+
The keychain will store keys encrypted in the datastore which default is an in memory datastore. If you want to store the keys on disc you need to initialize libp2p with a suitable datastore implementation.
594596

595597
```js
596598
import { createLibp2p } from 'libp2p'
@@ -982,7 +984,7 @@ const node = await createLibp2p({
982984
})
983985
}
984986
})
985-
987+
```
986988

987989
#### Configuring UPnP NAT Traversal
988990

0 commit comments

Comments
 (0)