Skip to content

Commit

Permalink
docs: Improve config documentation
Browse files Browse the repository at this point in the history
License: MIT
Signed-off-by: Matt Joiner <[email protected]>
  • Loading branch information
anacrolix committed Dec 10, 2018
1 parent d3a488e commit ed26059
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions docs/config.md
Original file line number Diff line number Diff line change
@@ -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.),
Expand Down

0 comments on commit ed26059

Please sign in to comment.