From ed260599ba2ecdbe79ae90c9e2174f5c76d0bf23 Mon Sep 17 00:00:00 2001 From: Matt Joiner Date: Mon, 10 Dec 2018 19:06:00 +1100 Subject: [PATCH] docs: Improve config documentation License: MIT Signed-off-by: Matt Joiner --- docs/config.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/config.md b/docs/config.md index 029e5e47c..616f8a472 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,16 +1,19 @@ # The go-ipfs config file -The go-ipfs config file is a json document. It is read once at node instantiation, -either for an offline command, or when starting the daemon. Commands that execute -on a running daemon do not read the config file at runtime. +The go-ipfs config file is a JSON document located at `$IPFS_PATH/config`. It +is read once at node instantiation, either for an offline command, or when +starting the daemon. Commands that execute on a running daemon do not read the +config file at runtime. #### Profiles + Configuration profiles allow to tweak configuration quickly. Profiles can be -applied with `--profile` flag to `ipfs init` or with `ipfs config profile apply` -command. When a profile is applied a backup of the configuration file will -be created in $IPFS_PATH +applied with `--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`. Available profiles: + - `server` Recommended for nodes with public IPv4 address (servers, VPSes, etc.),