opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-07-01 02:30:39 +08:00
Code Issues Projects Releases Wiki Activity

config docs: Move profile section to the top

Browse Source 
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
This commit is contained in:
Łukasz Magiera
2017-10-29 20:54:07 +01:00
parent ed8817961e
commit 75b235d05c
1 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/config.md
View File

@ -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 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. 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 ## Table of Contents
- [`Addresses`](#addresses) - [`Addresses`](#addresses)
@ -17,7 +31,6 @@ on a running daemon do not read the config file at runtime.
- [`Mounts`](#mounts) - [`Mounts`](#mounts)
- [`Reprovider`](#reprovider) - [`Reprovider`](#reprovider)
- [`Swarm`](#swarm) - [`Swarm`](#swarm)
- [`Profiles`](#profiles)
## `Addresses` ## `Addresses`
Contains information about various listener addresses to be used by this node. 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. HighWater is the number of connections that, when exceeded, will trigger a connection GC operation.
- `GracePeriod` - `GracePeriod`
GracePeriod is a time duration that new connections are immune from being closed by the connection manager. 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.