Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
docs: clarify preload behavior (#1583)
Browse files Browse the repository at this point in the history
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 #1459 (comment)
  • Loading branch information
parkan authored and Alan Shaw committed Sep 20, 2018
1 parent c73bd2f commit 542737b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ Configure circuit relay (see the [circuit relay tutorial](https://github.com/ipf
|------|---------|
| object | `{ enabled: true, addresses: [...] }` |

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

- `enabled` (boolean): Enable content preloading (Default: `true`)
- `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).
Expand Down

0 comments on commit 542737b

Please sign in to comment.