Capitalized acronyms, add ToC
License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Jul 19, 2016 at 12:40 UTC
ca0c68991d97af617e314be13ef0d19d61118bc5
1 file changed
+22
-6
docs/config.md
+22
-6
@@ -1,13 +1,29 @@
1
# The go-ipfs config file
2
+
3
The go-ipfs config file is a json document. It is read once at node instantiation,
4
either for an offline command, or for starting the daemon. Commands that execute on
5
a running daemon do not read the config file at runtime.
6
7
+## Table of Contents
8
+
9
+- [`Addresses`](#addresses)
10
+- [`API`](#api)
11
+- [`Bootstrap`](#bootstrap)
12
+- [`Datastore`](#datastore)
13
+- [`Discovery`](#discovery)
14
+- [`Gateway`](#gateway)
15
+- [`Identity`](#identity)
16
+- [`Ipns`](#ipns)
17
+- [`Mounts`](#mounts)
18
+- [`SupernodeRouting`](#supernoderouting)
19
+- [`Swarm`](#swarm)
20
+- [`Tour`](#tour)
21
+
22
## `Addresses`
23
Contains information about various listener addresses to be used by this node.
24
25
- `API`
10
-Multiaddr describing the address to serve the local http api on.
26
+Multiaddr describing the address to serve the local HTTP API on.
27
28
Default: `/ip4/127.0.0.1/tcp/4001`
29
@@ -28,10 +44,10 @@ Default:
44
```
45
46
## `API`
31
-Contains information used by the api gateway.
47
+Contains information used by the API gateway.
48
49
- `HTTPHeaders`
34
-Map of http headers to set on responses from the API http server.
50
+Map of HTTP headers to set on responses from the API HTTP server.
51
52
Example:
53
```json
@@ -107,7 +123,7 @@ A number of seconds to wait between discovery checks.
123
124
125
## `Gateway`
110
-Options for the http gateway.
126
+Options for the HTTP gateway.
127
128
- `HTTPHeaders`
129
Headers to set on gateway responses.
@@ -165,7 +181,7 @@ The number of entries to store in an LRU cache of resolved ipns entries. Entries
181
Default: `128`
182
183
## `Mounts`
168
-Fuse mount point configuration options.
184
+FUSE mount point configuration options.
185
186
- `IPFS`
187
Mountpoint for `/ipfs/`.
@@ -174,7 +190,7 @@ Mountpoint for `/ipfs/`.
190
Mountpoint for `/ipns/`.
191
192
- `FuseAllowOther`
177
-Sets the fuse allow other option on the mountpoint.
193
+Sets the FUSE allow other option on the mountpoint.
194
195
## `SupernodeRouting`
196
Deprecated.