config.md: fix typos/improve wording
@RubenKelevra committed
Mar 27, 2021 at 21:10 UTC
253f99f061ad9da7aa55b828ff6586fea5c563e2
1 file changed
+21
-22
docs/config.md
+21
-22
@@ -8,7 +8,7 @@ config file at runtime.
8
## Profiles
9
10
Configuration profiles allow to tweak configuration quickly. Profiles can be
11
-applied with `--profile` flag to `ipfs init` or with the `ipfs config profile
11
+applied with the `--profile` flag to `ipfs init` or with the `ipfs config profile
12
apply` command. When a profile is applied a backup of the configuration file
13
will be created in `$IPFS_PATH`.
14
@@ -22,7 +22,7 @@ documented in `ipfs config profile --help`.
22
23
- `randomports`
24
25
- Use a random port number for swarm.
25
+ Use a random port number for the incoming swarm connections.
26
27
- `default-datastore`
28
@@ -35,7 +35,7 @@ documented in `ipfs config profile --help`.
35
- `local-discovery`
36
37
Sets default values to fields affected by the server
38
- profile, enables discovery in local networks.
38
+ profile enables discovery in local networks.
39
40
- `test`
41
@@ -56,7 +56,7 @@ documented in `ipfs config profile --help`.
56
57
- You need a very simple and very reliable datastore and you trust your
58
filesystem. This datastore stores each block as a separate file in the
59
- underlying filesystem so it's unlikely to loose data unless there's an issue
59
+ underlying filesystem so it's unlikely to lose data unless there's an issue
60
with the underlying file system.
61
- You need to run garbage collection on a small (<= 10GiB) datastore. The
62
default datastore, badger, can leave several gigabytes of data behind when
@@ -258,7 +258,7 @@ Type: `strings` (multiaddrs)
258
259
### `Addresses.Swarm`
260
261
-Array of multiaddrs describing which addresses to listen on for p2p swarm
261
+An array of multiaddrs describing which addresses to listen on for p2p swarm
262
connections.
263
264
Supported Transports:
@@ -289,7 +289,7 @@ Default: `[]`
289
Type: `array[string]` (multiaddrs)
290
291
### `Addresses.NoAnnounce`
292
-Array of swarm addresses not to announce to the network.
292
+An array of swarm addresses not to announce to the network.
293
294
Default: `[]`
295
@@ -363,8 +363,7 @@ Type: `duration` (when `0`/unset, the default value is used)
363
364
## `Bootstrap`
365
366
-Bootstrap is an array of multiaddrs of trusted nodes to connect to in order to
367
-initiate a connection to the network.
366
+Bootstrap is an array of multiaddrs of trusted nodes that your node connects to, to fetch other nodes of the network on startup.
367
368
Default: The ipfs.io bootstrap nodes
369
@@ -405,7 +404,7 @@ Type: `duration` (an empty string means the default value)
404
405
### `Datastore.HashOnRead`
406
408
-A boolean value. If set to true, all block reads from disk will be hashed and
407
+A boolean value. If set to true, all block reads from the disk will be hashed and
408
verified. This will cause increased CPU utilization.
409
410
Default: `false`
@@ -416,13 +415,13 @@ Type: `bool`
415
416
A number representing the size in bytes of the blockstore's [bloom
417
filter](https://en.wikipedia.org/wiki/Bloom_filter). A value of zero represents
419
-the feature being disabled.
418
+the feature is disabled.
419
420
This site generates useful graphs for various bloom filter values:
421
<https://hur.st/bloomfilter/?n=1e6&p=0.01&m=&k=7> You may use it to find a
422
preferred optimal value, where `m` is `BloomFilterSize` in bits. Remember to
423
convert the value `m` from bits, into bytes for use as `BloomFilterSize` in the
425
-config file. For example, for 1,000,000 blocks, expecting a 1% false positive
424
+config file. For example, for 1,000,000 blocks, expecting a 1% false-positive
425
rate, you'd end up with a filter size of 9592955 bits, so for `BloomFilterSize`
426
we'd want to use 1199120 bytes. As of writing, [7 hash
427
functions](https://github.com/ipfs/go-ipfs-blockstore/blob/547442836ade055cc114b562a3cc193d4e57c884/caching.go#L22)
@@ -496,7 +495,7 @@ Type: `bool`
495
496
#### `Discovery.MDNS.Interval`
497
499
-A number of seconds to wait between discovery checks.
498
+The number of seconds between discovery checks.
499
500
Default: `5`
501
@@ -518,8 +517,8 @@ Type: `bool`
517
### `Gateway.NoDNSLink`
518
519
A boolean to configure whether DNSLink lookup for value in `Host` HTTP header
521
-should be performed. If DNSLink is present, content path stored in the DNS TXT
522
-record becomes the `/` and respective payload is returned to the client.
520
+should be performed. If DNSLink is present, the content path stored in the DNS TXT
521
+record becomes the `/` and the respective payload is returned to the client.
522
523
Default: `false`
524
@@ -567,7 +566,7 @@ Type: `bool`
566
**DEPRECATED:** see [go-ipfs#7702](https://github.com/ipfs/go-ipfs/issues/7702)
567
568
<!--
570
-Array of acceptable url paths that a client can specify in X-Ipfs-Path-Prefix
569
+An array of acceptable url paths that a client can specify in X-Ipfs-Path-Prefix
570
header.
571
572
The X-Ipfs-Path-Prefix header is used to specify a base path to prepend to links
@@ -611,7 +610,7 @@ Examples:
610
611
#### `Gateway.PublicGateways: Paths`
612
614
-Array of paths that should be exposed on the hostname.
613
+An array of paths that are exposed on the hostname.
614
615
Example:
616
```json
@@ -779,7 +778,7 @@ Type: `string` (peer ID)
778
779
### `Identity.PrivKey`
780
782
-The base64 encoded protobuf describing (and containing) the nodes private key.
781
+The base64 encoded protobuf describing (and containing) the node's private key.
782
783
Type: `string` (base64 encoded)
784
@@ -850,19 +849,19 @@ Type: `string` (filesystem path)
849
850
### `Mounts.FuseAllowOther`
851
853
-Sets the FUSE allow other option on the mountpoint.
852
+Sets the 'FUSE allow other'-option on the mount point.
853
854
## `Pinning`
855
856
Pinning configures the options available for pinning content
858
-(i.e. keeping content longer term instead of as temporarily cached storage).
857
+(i.e. keeping content longer-term instead of as temporarily cached storage).
858
859
### `Pinning.RemoteServices`
860
861
`RemoteServices` maps a name for a remote pinning service to its configuration.
862
863
A remote pinning service is a remote service that exposes an API for managing
865
-that service's interest in longer term data storage.
864
+that service's interest in long-term data storage.
865
866
The exposed API conforms to the specification defined at
867
https://ipfs.github.io/pinning-services-api-spec/
@@ -1004,7 +1003,7 @@ When a node is added to the set of peered nodes, go-ipfs will:
1003
Peering can be asymmetric or symmetric:
1004
1005
* When symmetric, the connection will be protected by both nodes and will likely
1007
- be vary stable.
1006
+ be very stable.
1007
* When asymmetric, only one node (the node that configured peering) will protect
1008
the connection and attempt to re-connect to the peered node on disconnect. If
1009
the peered node is under heavy load and/or has a low connection limit, the
@@ -1087,7 +1086,7 @@ When the DHT is enabled, it can operate in two modes: client and server.
1086
respond to requests from other peers (both requests to store records and
1087
requests to retrieve records).
1088
* In client mode, your node will query the DHT as a client but will not respond
1090
- to requests from other peers. This mode is less resource intensive than server
1089
+ to requests from other peers. This mode is less resource-intensive than server
1090
mode.
1091
1092
When `Routing.Type` is set to `dht`, your node will start as a DHT client, and