Skip to content

Commit

Permalink
docs: remove "Compile with RocksDB support" (cometbft#2814)
Browse files Browse the repository at this point in the history
until we have settled on a single database - cometbft#1039. Note I still think
RocksDB is faster even thought I don't have data to back it up. Anyway,
I don't think we should "endorse" any database in the meantime.

Refs
cometbft#2786 (comment)
  • Loading branch information
melekes authored Apr 15, 2024
1 parent 0caf4a0 commit 44bc624
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 48 deletions.
5 changes: 1 addition & 4 deletions docs/explanation/core/running-in-production.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@ order: 4
## Database

By default, CometBFT uses the `syndtr/goleveldb` package for its in-process
key-value database. If you want maximal performance, it may be best to install
RocksDB and compile CometBFT to use that using
`make build COMETBFT_BUILD_OPTIONS=rocksdb`. See the [install
instructions](../introduction/install.md) for details.
key-value database.

CometBFT keeps multiple distinct databases in the `$CMTHOME/data`:

Expand Down
44 changes: 0 additions & 44 deletions docs/tutorials/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,47 +79,3 @@ To upgrade, run
git pull origin main
make install
```

## Compile with RocksDB support

Install [RocksDB](https://github.com/facebook/rocksdb/blob/main/INSTALL.md).

Ubuntu:

```sh
sudo apt-get update

git clone https://github.com/facebook/rocksdb.git
cd rocksdb

DEBUG_LEVEL=0 make shared_lib install-shared

export LD_LIBRARY_PATH=/usr/local/lib
```

OSX:

```sh
brew install rocksdb
```

Set a database backend to `rocksdb`:

```toml
# config/config.toml
db_backend = "rocksdb"
```

To install CometBFT, run:

```sh
make install COMETBFT_BUILD_OPTIONS=rocksdb
```

or run:

```sh
make build COMETBFT_BUILD_OPTIONS=rocksdb
```

which puts the binary in `./build`.

0 comments on commit 44bc624

Please sign in to comment.