docs: Improve config documentation
License: MIT Signed-off-by: Matt Joiner <anacrolix@gmail.com>
Matt Joiner committed
Dec 10, 2018 at 19:06 UTC
ed260599ba2ecdbe79ae90c9e2174f5c76d0bf23
1 file changed
+9
-6
docs/config.md
+9
-6
@@ -1,16 +1,19 @@
1
# The go-ipfs config file
2
3
-The go-ipfs config file is a json document. It is read once at node instantiation,
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.
3
+The go-ipfs config file is a JSON document located at `$IPFS_PATH/config`. It
4
+is read once at node instantiation, either for an offline command, or when
5
+starting the daemon. Commands that execute on a running daemon do not read the
6
+config file at runtime.
7
8
#### Profiles
9
+
10
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. When a profile is applied a backup of the configuration file will
11
-be created in $IPFS_PATH
11
+applied with `--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
15
Available profiles:
16
+
17
- `server`
18
19
Recommended for nodes with public IPv4 address (servers, VPSes, etc.),