0ba9fc4ede
Introduce (optional) pruning of historical data - a pruned node will continue to answer queries for historical data up to `MIN_EPOCHS_FOR_BLOCK_REQUESTS` epochs, or roughly 5 months, capping typical database usage at around 60-70gb. To enable pruning, add `--history=prune` to the command line - on the first start, old data will be cleared (which may take a while) - after that, data is pruned continuously. When pruning an existing database, the database will not shrink - instead, the freed space is recycled as the node continues to run - to free up space, perform a trusted node sync with a fresh database. When switching on archive mode in a pruned node, history is retained from that point onwards. History pruning is scheduled to be enabled by default in a future release. In this PR, `minimal` mode from #4419 is not implemented meaning retention periods for states and blocks are always the same - depending on user demand, a future PR may implement `minimal` as well. |
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| CNAME | ||
| README.md | ||
| mkdocs.yml | ||
README.md
The Nimbus Guide is written using markdown and material for mkdocs.
See the Makefile for setup.
The guide is divided into several sections - broadly:
- Guides - walk-throughs that allow the user to get started with a specific area of the client
- How-to:s - short pages that show the user how to solve a specific problem or perform a specific task
- Reference - pages describing how specific parts of Nimbus work, reference-style
- "Other" - explanations of concepts, background etc.
Resources
- material for mkdocs - doc generator
- divio - useful resource diving into the above section structure