Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update config doc with more info about pebble #10533

Merged
merged 3 commits into from
Oct 3, 2024
Merged

chore: update config doc with more info about pebble #10533

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01f724e
Update changelog with more info about Pebble
gammazero Oct 3, 2024
035a099
grammar
gammazero Oct 3, 2024
24807ab
discard changelog update
gammazero Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2426,10 +2426,11 @@ Pebble is a LevelDB/RocksDB inspired key-value store focused on performance and
You should use this datastore if:

- You need a datastore that is focused on performance.
- You need a datastore that is good for multi-terrabyte data sets.
- You need reliability by default, but may choose to disable WAL for maximum performance when reliability is not critical.
- This datastore is good for multi-terrabyte data sets.
- May benefit from tuning depending on read/write patterns and throughput.
- Performance is helped significantly by running on a system with plenty of memory.
- You want a datastore that does not need GC cycles and does not use more space than necessary
- You want a datastore that does not take several minutes to start with large repositories
- You want a datastore that performs well even with default settings, but can optimized by setting configuration to tune it for your specific needs.

> [!WARNING]
> This profile may only be applied when first initializing the node via `ipfs init --profile pebbleds`
Expand Down