You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 12, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: doc/config.md
+60-39Lines changed: 60 additions & 39 deletions
Original file line number
Diff line number
Diff line change
@@ -5,25 +5,34 @@ The js-ipfs config file is a JSON document located in the root directory of the
5
5
## Table of Contents
6
6
7
7
-[`Addresses`](#addresses)
8
+
-[`API`](#api)
9
+
-[`Delegates`](#delegates)
10
+
-[`Gateway`](#gateway)
11
+
-[`Swarm`](#swarm)
8
12
-[`Bootstrap`](#bootstrap)
9
13
-[`Datastore`](#datastore)
14
+
-[`Spec`](#spec)
10
15
-[`Discovery`](#discovery)
16
+
-[`MDNS`](#mdns)
17
+
-[`webRTCStar`](#webrtcstar)
11
18
-[`Identity`](#identity)
19
+
-[`PeerID`](#peerid)
20
+
-[`PrivKey`](#privkey)
12
21
-[`Keychain`](#keychain)
13
22
-[`Swarm`](#swarm)
14
-
23
+
-[`ConnMgr`](#connmgr)
15
24
16
25
## `Addresses`
17
26
Contains information about various listener addresses to be used by this node.
18
27
19
-
-`API`
28
+
#### - API
20
29
The IPFS daemon exposes an HTTP API that allows to control the node and run the same commands as you can do from the command line. It is defined on the [HTTP API Spec](https://docs.ipfs.io/reference/api/http).
21
30
22
31
[Multiaddr](https://github.com/multiformats/multiaddr/) or array of [Multiaddr](https://github.com/multiformats/multiaddr/) describing the address(es) to serve the HTTP API on.
23
32
24
33
Default: `/ip4/127.0.0.1/tcp/5002`
25
34
26
-
-`Delegates`
35
+
#### Delegates
27
36
Delegate peers are used to find peers and retrieve content from the network on your behalf.
28
37
29
38
Array of [Multiaddr](https://github.com/multiformats/multiaddr/) describing which addresses to use as delegate nodes, in order to create a delegate routers.
@@ -33,14 +42,14 @@ Contains information about various listener addresses to be used by this node.
33
42
[]
34
43
```
35
44
36
-
-`Gateway`
45
+
#### Gateway
37
46
A gateway is exposed by the IPFS daemon, which allows an easy way to access content from IPFS, using an IPFS path.
38
47
39
48
[Multiaddr](https://github.com/multiformats/multiaddr/) or array of [Multiaddr](https://github.com/multiformats/multiaddr/) describing the address(es) to serve the gateway on.
40
49
41
50
Default: `/ip4/127.0.0.1/tcp/9090`
42
51
43
-
-`Swarm`
52
+
#### Swarm
44
53
Array of [Multiaddr](https://github.com/multiformats/multiaddr/) describing which addresses to listen on for p2p swarm connections.
45
54
46
55
Default:
@@ -59,40 +68,40 @@ initiate a connection to the network.
59
68
Contains information related to the construction and operation of the on-disk
60
69
storage system.
61
70
62
-
-`Spec`
63
-
Spec defines the structure of the IPFS datastore. It is a composable structure, where each datastore is represented by a JSON object. Datastores can wrap other datastores to provide extra functionality (e.g. metrics, logging, or caching).
71
+
#### Spec
72
+
Spec defines the structure of the IPFS datastore. It is a composable structure, where each datastore is represented by a JSON object. Datastores can wrap other datastores to provide extra functionality (e.g. metrics, logging, or caching).
64
73
65
-
This can be changed manually, however, if you make any changes that require a different on-disk structure, you will need to run the [ipfs-ds-convert tool](https://github.com/ipfs/ipfs-ds-convert) to migrate data into the new structures.
74
+
This can be changed manually, however, if you make any changes that require a different on-disk structure, you will need to run the [ipfs-ds-convert tool](https://github.com/ipfs/ipfs-ds-convert) to migrate data into the new structures.
The unique PKI identity label for this configs peer. Set on init and never read, its merely here for convenience. IPFS will always generate the peerID from its keypair at runtime.
136
+
###`PeerID`
137
+
The unique PKI identity label for this configs peer. Set on init and never read, its merely here for convenience. IPFS will always generate the peerID from its keypair at runtime.
129
138
130
-
-`PrivKey`
131
-
The base64 encoded protobuf describing (and containing) the nodes private key.
139
+
###`PrivKey`
140
+
The base64 encoded protobuf describing (and containing) the nodes private key.
132
141
133
142
## `Keychain`
143
+
We can customize the key management and criptographically protected messages by changing the Keychain options. Those options are used for generating the derived encryption key (`DEK`). The `DEK` object, along with the passPhrase, is the input to a PBKDF2 function.
134
144
145
+
Default:
146
+
```json
147
+
{
148
+
"dek": {
149
+
"keyLength": 512/ 8,
150
+
"iterationCount": 1000,
151
+
"salt": "at least 16 characters long",
152
+
"hash": "sha2-512"
153
+
}
154
+
}
155
+
```
135
156
157
+
You can check the [parameter choice for pbkdf2/](https://cryptosense.com/parameter-choice-for-pbkdf2/) for more information.
136
158
137
159
## `Swarm`
138
160
@@ -160,7 +182,6 @@ The "basic" connection manager tries to keep between `LowWater` and `HighWater`
0 commit comments