@cryptotaxi247 / kubo / commits / d7a1bdae8

add newer config options and reformat

License: MIT Signed-off-by: Jeromy <why@ipfs.io>

Jeromy committed Jul 17, 2016 at 09:18 UTC d7a1bdae8ea60658ed75523a6f09b277816b7f24
1 file changed +35 -27
docs/config.md
+35 -27
@@ -6,17 +6,17 @@ a running daemon do not read the config file at runtime.
6 ## `Addresses`
7 Contains information about various listener addresses to be used by this node.
8
9 -### `API`
9 +- `API`
10 Multiaddr describing the address to serve the local http api on.
11
12 Default: `/ip4/127.0.0.1/tcp/4001`
13
14 -### `Gateway`
14 +- `Gateway`
15 Multiaddr describing the address to serve the local gateway on.
16
17 Default: `/ip4/127.0.0.1/tcp/8080`
18
19 -### `Swarm`
19 +- `Swarm`
20 Array of multiaddrs describing which addresses to listen on for p2p swarm connections.
21
22 Default:
@@ -30,7 +30,7 @@ Default:
30 ## `API`
31 Contains information used by the api gateway.
32
33 -### `HTTPHeaders`
33 +- `HTTPHeaders`
34 Map of http headers to set on responses from the API http server.
35
36 Example:
@@ -52,56 +52,64 @@ Default: The ipfs.io bootstrap nodes
52 Contains information related to the construction and operation of the on-disk
53 storage system.
54
55 -### `Type`
55 +- `Type`
56 Denotes overall datastore type. The only currently valid option is `leveldb`.
57
58 Default: `leveldb`
59
60 -### `Path`
60 +- `Path`
61 Path to the leveldb datastore directory. Set during init to either `$IPFS_PATH/datastore`, or `$HOME/.ipfs/datastore` if `$IPFS_PATH` is unset.
62
63 -### `StorageMax`
63 +- `StorageMax`
64 An upper limit on the total size of the ipfs repository's datastore. Writes to the datastore will begin to fail once this limit is reached.
65
66 Default: `10GB`
67
68 -### `StorageGCWatermark`
68 +- `StorageGCWatermark`
69 The percentage of the `StorageMax` value at which a garbage collection will be triggered automatically if the daemon was run with automatic gc enabled (that option defaults to false currently).
70
71 Default: `90`
72
73 -### `GCPeriod`
73 +- `GCPeriod`
74 A time duration specifying how frequently to run a garbage collection. Only used if automatic gc is enabled.
75
76 Default: `1h`
77
78 -### `NoSync` *!*
78 +- `NoSync` *!*
79 A boolean value denoting whether or not to disable sanity syncing in the flatfs datastore code. Setting this to true may significantly improve performance, but be careful using it as if the daemon is killed before a write is synchronized to disk, there is a chance of data loss.
80
81 Default: `false`
82
83 -### `Params`
83 +- `HashOnRead`
84 +A boolean value. If set to true, all block reads from disk will be hashed and verified. This will cause increased CPU utilization.
85 +
86 +- `BloomFilterSize`
87 +A number representing the size in bits of the blockstore's bloom filter. A value of zero represents the feature being disabled.
88 +
89 +Default: `0`
90 +
91 +- `Params`
92 Extra parameters for datastore construction, not currently used.
93
94 ## `Discovery`
95 Contains options for configuring ipfs node discovery mechanisms.
96
89 -### `MDNS`
97 +- `MDNS`
98 Options for multicast dns peer discovery.
99
92 -#### `Enabled`
100 + - `Enabled`
101 A boolean value for whether or not mdns should be active.
102
103 Default: `true`
104
97 -#### `Interval`
105 + - `Interval`
106 A number of seconds to wait between discovery checks.
107
108
109 ## `Gateway`
110 Options for the http gateway.
111
104 -### `HTTPHeaders`
112 +- `HTTPHeaders`
113 Headers to set on gateway responses.
114
115 Default:
@@ -119,39 +127,39 @@ Default:
127 }
128 ```
129
122 -### `RootRedirect`
130 +- `RootRedirect`
131 A url to redirect requests for `/` to.
132
133 Default: `""`
134
127 -### `Writeable`
135 +- `Writeable`
136 A boolean to configure whether the gateway is writeable or not.
137
138 Default: `false`
139
132 -### `PathPrefixes`
140 +- `PathPrefixes`
141 TODO
142
143 Default: `[]`
144
145 ## `Identity`
146
139 -### `PeerID`
147 +- `PeerID`
148 The unique PKI identity label for this configs peer. Set on init and never read, its merely here for convenience. Ipfs will always generate the peerID from its keypair at runtime.
149
142 -### `PrivKey`
150 +- `PrivKey`
151 The base64 encoded protobuf describing (and containing) the nodes private key.
152
153 ## `Ipns`
154
147 -### `RepublishPeriod`
155 +- `RepublishPeriod`
156 A time duration specifying how frequently to republish ipns records to ensure they stay fresh on the network. If unset, we default to 12 hours.
157
150 -### `RecordLifetime`
158 +- `RecordLifetime`
159 A time duration specifying the value to set on ipns records for their validity lifetime.
160 If unset, we default to 24 hours.
161
154 -### `ResolveCacheSize`
162 +- `ResolveCacheSize`
163 The number of entries to store in an LRU cache of resolved ipns entries. Entries will be kept cached until their lifetime is expired.
164
165 Default: `128`
@@ -159,13 +167,13 @@ Default: `128`
167 ## `Mounts`
168 Fuse mount point configuration options.
169
162 -### `IPFS`
170 +- `IPFS`
171 Mountpoint for `/ipfs/`.
172
165 -### `IPNS`
173 +- `IPNS`
174 Mountpoint for `/ipns/`.
175
168 -### `FuseAllowOther`
176 +- `FuseAllowOther`
177 Sets the fuse allow other option on the mountpoint.
178
179 ## `SupernodeRouting`
@@ -174,7 +182,7 @@ Deprecated.
182 ## `Swarm`
183 Options for configuring the swarm.
184
177 -### `AddrFilters`
185 +- `AddrFilters`
186 An array of address filters (multiaddr netmasks) to filter dials to.
187 See https://github.com/ipfs/go-ipfs/issues/1226#issuecomment-120494604 for more information.
188