Mukan Erkin Törük
ef24c0b67e
Some checks are pending
docker-build-cometbft / vars (push) Waiting to run
docker-build-cometbft / build-images (amd64, ubuntu-24.04) (push) Blocked by required conditions
docker-build-cometbft / build-images (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
docker-build-cometbft / merge-images (push) Blocked by required conditions
docker-build-e2e-node / vars (push) Waiting to run
docker-build-e2e-node / build-images (amd64, ubuntu-24.04) (push) Blocked by required conditions
docker-build-e2e-node / build-images (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
docker-build-e2e-node / merge-images (push) Blocked by required conditions
125 lines
2.3 KiB
Markdown
125 lines
2.3 KiB
Markdown
---
|
|
order: 3
|
|
---
|
|
|
|
# Install CometBFT
|
|
|
|
## From Go Package
|
|
|
|
Install the latest version of CometBFT's Go package:
|
|
|
|
```sh
|
|
go install github.com/cometbft/cometbft/cmd/cometbft@latest
|
|
```
|
|
|
|
Install a specific version of CometBFT's Go package:
|
|
|
|
```sh
|
|
go install github.com/cometbft/cometbft/cmd/cometbft@v0.38
|
|
```
|
|
|
|
## From Binary
|
|
|
|
To download pre-built binaries, see the [releases page](https://github.com/cometbft/cometbft/releases).
|
|
|
|
## From Source
|
|
|
|
You'll need `go` [installed](https://golang.org/doc/install) and the required
|
|
environment variables set, which can be done with the following commands:
|
|
|
|
```sh
|
|
echo export GOPATH=\"\$HOME/go\" >> ~/.bash_profile
|
|
echo export PATH=\"\$PATH:\$GOPATH/bin\" >> ~/.bash_profile
|
|
```
|
|
|
|
### Get Source Code
|
|
|
|
```sh
|
|
git clone https://github.com/cometbft/cometbft.git
|
|
cd cometbft
|
|
```
|
|
|
|
### Compile
|
|
|
|
```sh
|
|
make install
|
|
```
|
|
|
|
to put the binary in `$GOPATH/bin` or use:
|
|
|
|
```sh
|
|
make build
|
|
```
|
|
|
|
to put the binary in `./build`.
|
|
|
|
_DISCLAIMER_ The binary of CometBFT is build/installed without the DWARF
|
|
symbol table. If you would like to build/install CometBFT with the DWARF
|
|
symbol and debug information, remove `-s -w` from `BUILD_FLAGS` in the make
|
|
file.
|
|
|
|
The latest CometBFT is now installed. You can verify the installation by
|
|
running:
|
|
|
|
```sh
|
|
cometbft version
|
|
```
|
|
|
|
## Reinstall
|
|
|
|
If you already have CometBFT installed, and you make updates, simply
|
|
|
|
```sh
|
|
make install
|
|
```
|
|
|
|
To upgrade, run
|
|
|
|
```sh
|
|
git pull origin main
|
|
make install
|
|
```
|
|
|
|
## Compile with CLevelDB support
|
|
|
|
Install [LevelDB](https://github.com/google/leveldb) (minimum version is 1.7).
|
|
|
|
Install LevelDB with snappy (optionally). Below are commands for Ubuntu:
|
|
|
|
```sh
|
|
sudo apt-get update
|
|
sudo apt install build-essential
|
|
|
|
sudo apt-get install libsnappy-dev
|
|
|
|
wget https://github.com/google/leveldb/archive/v1.23.tar.gz && \
|
|
tar -zxvf v1.23.tar.gz && \
|
|
cd leveldb-1.23/ && \
|
|
make && \
|
|
sudo cp -r out-static/lib* out-shared/lib* /usr/local/lib/ && \
|
|
cd include/ && \
|
|
sudo cp -r leveldb /usr/local/include/ && \
|
|
sudo ldconfig && \
|
|
rm -f v1.23.tar.gz
|
|
```
|
|
|
|
Set a database backend to `cleveldb`:
|
|
|
|
```toml
|
|
# config/config.toml
|
|
db_backend = "cleveldb"
|
|
```
|
|
|
|
To install CometBFT, run:
|
|
|
|
```sh
|
|
CGO_LDFLAGS="-lsnappy" make install COMETBFT_BUILD_OPTIONS=cleveldb
|
|
```
|
|
|
|
or run:
|
|
|
|
```sh
|
|
CGO_LDFLAGS="-lsnappy" make build COMETBFT_BUILD_OPTIONS=cleveldb
|
|
```
|
|
|
|
which puts the binary in `./build`.
|