From 253f99f061ad9da7aa55b828ff6586fea5c563e2 Mon Sep 17 00:00:00 2001 From: "@RubenKelevra" Date: Sat, 27 Mar 2021 21:10:18 +0100 Subject: [PATCH] config.md: fix typos/improve wording --- docs/config.md | 43 +++++++++++++++++++++---------------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/config.md b/docs/config.md index 87a2ea14c..0a9b66063 100644 --- a/docs/config.md +++ b/docs/config.md @@ -8,7 +8,7 @@ config file at runtime. ## Profiles Configuration profiles allow to tweak configuration quickly. Profiles can be -applied with `--profile` flag to `ipfs init` or with the `ipfs config profile +applied with the `--profile` flag to `ipfs init` or with the `ipfs config profile apply` command. When a profile is applied a backup of the configuration file will be created in `$IPFS_PATH`. @@ -22,7 +22,7 @@ documented in `ipfs config profile --help`. - `randomports` - Use a random port number for swarm. + Use a random port number for the incoming swarm connections. - `default-datastore` @@ -35,7 +35,7 @@ documented in `ipfs config profile --help`. - `local-discovery` Sets default values to fields affected by the server - profile, enables discovery in local networks. + profile enables discovery in local networks. - `test` @@ -56,7 +56,7 @@ documented in `ipfs config profile --help`. - You need a very simple and very reliable datastore and you trust your filesystem. This datastore stores each block as a separate file in the - underlying filesystem so it's unlikely to loose data unless there's an issue + underlying filesystem so it's unlikely to lose data unless there's an issue with the underlying file system. - You need to run garbage collection on a small (<= 10GiB) datastore. The default datastore, badger, can leave several gigabytes of data behind when @@ -258,7 +258,7 @@ Type: `strings` (multiaddrs) ### `Addresses.Swarm` -Array of multiaddrs describing which addresses to listen on for p2p swarm +An array of multiaddrs describing which addresses to listen on for p2p swarm connections. Supported Transports: @@ -289,7 +289,7 @@ Default: `[]` Type: `array[string]` (multiaddrs) ### `Addresses.NoAnnounce` -Array of swarm addresses not to announce to the network. +An array of swarm addresses not to announce to the network. Default: `[]` @@ -363,8 +363,7 @@ Type: `duration` (when `0`/unset, the default value is used) ## `Bootstrap` -Bootstrap is an array of multiaddrs of trusted nodes to connect to in order to -initiate a connection to the network. +Bootstrap is an array of multiaddrs of trusted nodes that your node connects to, to fetch other nodes of the network on startup. Default: The ipfs.io bootstrap nodes @@ -405,7 +404,7 @@ Type: `duration` (an empty string means the default value) ### `Datastore.HashOnRead` -A boolean value. If set to true, all block reads from disk will be hashed and +A boolean value. If set to true, all block reads from the disk will be hashed and verified. This will cause increased CPU utilization. Default: `false` @@ -416,13 +415,13 @@ Type: `bool` A number representing the size in bytes of the blockstore's [bloom filter](https://en.wikipedia.org/wiki/Bloom_filter). A value of zero represents -the feature being disabled. +the feature is disabled. This site generates useful graphs for various bloom filter values: You may use it to find a preferred optimal value, where `m` is `BloomFilterSize` in bits. Remember to convert the value `m` from bits, into bytes for use as `BloomFilterSize` in the -config file. For example, for 1,000,000 blocks, expecting a 1% false positive +config file. For example, for 1,000,000 blocks, expecting a 1% false-positive rate, you'd end up with a filter size of 9592955 bits, so for `BloomFilterSize` we'd want to use 1199120 bytes. As of writing, [7 hash functions](https://github.com/ipfs/go-ipfs-blockstore/blob/547442836ade055cc114b562a3cc193d4e57c884/caching.go#L22) @@ -496,7 +495,7 @@ Type: `bool` #### `Discovery.MDNS.Interval` -A number of seconds to wait between discovery checks. +The number of seconds between discovery checks. Default: `5` @@ -518,8 +517,8 @@ Type: `bool` ### `Gateway.NoDNSLink` A boolean to configure whether DNSLink lookup for value in `Host` HTTP header -should be performed. If DNSLink is present, content path stored in the DNS TXT -record becomes the `/` and respective payload is returned to the client. +should be performed. If DNSLink is present, the content path stored in the DNS TXT +record becomes the `/` and the respective payload is returned to the client. Default: `false` @@ -567,7 +566,7 @@ Type: `bool` **DEPRECATED:** see [go-ipfs#7702](https://github.com/ipfs/go-ipfs/issues/7702)