config docs: Move profile section to the top
License: MIT Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
Łukasz Magiera committed
Oct 29, 2017 at 20:54 UTC
75b235d05cc2bcbec52fa7843bc348332461ad94
1 file changed
+14
-15
docs/config.md
+14
-15
@@ -4,6 +4,20 @@ The go-ipfs config file is a json document. It is read once at node instantiatio
4
either for an offline command, or when starting the daemon. Commands that execute
5
on a running daemon do not read the config file at runtime.
6
7
+#### Profiles
8
+Configuration profiles allow to tweak configuration quickly. Profiles can be
9
+applied with `--profile` flag to `ipfs init` or with `ipfs config profile apply`
10
+command.
11
+
12
+- `server` profile
13
+Recommended for nodes with public IPv4 address, disables host and content
14
+discovery in local networks.
15
+
16
+- `test` profile
17
+Reduces external interference, useful for running ipfs in test environments.
18
+Note that with these settings node won't be able to talk to the rest of the
19
+network without manual bootstrap.
20
+
21
## Table of Contents
22
23
- [`Addresses`](#addresses)
@@ -17,7 +31,6 @@ on a running daemon do not read the config file at runtime.
31
- [`Mounts`](#mounts)
32
- [`Reprovider`](#reprovider)
33
- [`Swarm`](#swarm)
20
-- [`Profiles`](#profiles)
34
35
## `Addresses`
36
Contains information about various listener addresses to be used by this node.
@@ -288,17 +301,3 @@ LowWater is the minimum number of connections to maintain.
301
HighWater is the number of connections that, when exceeded, will trigger a connection GC operation.
302
- `GracePeriod`
303
GracePeriod is a time duration that new connections are immune from being closed by the connection manager.
291
-
292
-## Profiles
293
-Configuration profiles allow to tweak configuration quickly. Profiles can be
294
-applied with `--profile` flag to `ipfs init` or with `ipfs config profile apply`
295
-command.
296
-
297
-- `server` profile
298
-Recommended for nodes with public IPv4 address, disables host and content
299
-discovery in local networks.
300
-
301
-- `test` profile
302
-Reduces external interference, useful for running ipfs in test environments.
303
-Note that with these settings node won't be able to talk to the rest of the
304
-network without manual bootstrap.