Skip to content

Commit

Permalink
config docs: Move profile section to the top
Browse files Browse the repository at this point in the history
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
  • Loading branch information
magik6k committed Oct 29, 2017
1 parent 30745e9 commit c875c01
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.
Expand Down Expand Up @@ -278,17 +291,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.

0 comments on commit c875c01

Please sign in to comment.