Skip to content

Commit d32f539

Browse files
authored
Clarify preload behavior
Preload is confusing because it happens on both add and get, and because it isn't documented anywhere in depth. This clarifies what happens a bit. We should also write out the behavior in more detail like with circuit relay above (possibly in the form of a tutorial for setting up your own preload node) see also ipfs#1459 (comment)
1 parent c73bd2f commit d32f539

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ Configure circuit relay (see the [circuit relay tutorial](https://github.com/ipf
290290
|------|---------|
291291
| object | `{ enabled: true, addresses: [...] }` |
292292

293-
Configure external nodes that will preload content added to this node.
293+
Configure remote preload nodes. The remote will preload content added on this node, and also attempt to preload objects requested by this node.
294294

295295
- `enabled` (boolean): Enable content preloading (Default: `true`)
296296
- `addresses` (array): Multiaddr API addresses of nodes that should preload content. **NOTE:** nodes specified here should also be added to your node's bootstrap address list at [`config.Boostrap`](#optionsconfig).

0 commit comments

Comments
 (0)