From 75b235d05cc2bcbec52fa7843bc348332461ad94 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Magiera?= Date: Sun, 29 Oct 2017 20:54:07 +0100 Subject: [PATCH] config docs: Move profile section to the top MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit License: MIT Signed-off-by: Ɓukasz Magiera --- docs/config.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/config.md b/docs/config.md index e1da0da9b..bae5ed80a 100644 --- a/docs/config.md +++ b/docs/config.md @@ -4,6 +4,20 @@ The go-ipfs config file is a json document. It is read once at node instantiatio 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. + +- `server` profile +Recommended for nodes with public IPv4 address, disables host and content +discovery in local networks. + +- `test` profile +Reduces external interference, useful for running ipfs in test environments. +Note that with these settings node won't be able to talk to the rest of the +network without manual bootstrap. + ## Table of Contents - [`Addresses`](#addresses) @@ -17,7 +31,6 @@ on a running daemon do not read the config file at runtime. - [`Mounts`](#mounts) - [`Reprovider`](#reprovider) - [`Swarm`](#swarm) -- [`Profiles`](#profiles) ## `Addresses` 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. HighWater is the number of connections that, when exceeded, will trigger a connection GC operation. - `GracePeriod` GracePeriod is a time duration that new connections are immune from being closed by the connection manager. - -## 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. - -- `server` profile -Recommended for nodes with public IPv4 address, disables host and content -discovery in local networks. - -- `test` profile -Reduces external interference, useful for running ipfs in test environments. -Note that with these settings node won't be able to talk to the rest of the -network without manual bootstrap.