Getting started

Run Kvrocks with Docker

1. Follow Docker's installation instructions to install Docker.
2. Pull the latest image and start a container:

docker run -it -p 6666:6666 apache/kvrocks

Now you can use the redis-cli to run the kvrocks server as Redis on port 6666:

redis-cli -p 6666

Build and run Kvrocks from source

Install dependencies

CentOS/RedHat

sudo yum install -y epel-release
sudo yum install -y git gcc gcc-c++ make cmake autoconf automake libtool which

Ubuntu/Debian

sudo apt update
sudo apt install gcc g++ make cmake autoconf automake libtool

macOS

brew install autoconf automake libtool cmake

Compile Kvrocks from source

git clone https://github.com/apache/incubator-kvrocks.git
cd incubator-kvrocks
./x.py build # `./x.py build -h` to check more options;
             # especially, `./x.py build --ghproxy` will fetch dependencies via ghproxy.com.

The binary file kvrocks will be generated at build dir if everything goes well.

Run the Kvrocks server by:

./build/kvrocks

Now you can use the redis-cli to run the kvrocks server as Redis on port 6666:

redis-cli -p 6666