Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add docker image with pre-installed dependencies.
  • Loading branch information
zhangh43 committed Mar 5, 2025
1 parent 1a94962 commit 1a4958b
Showing 1 changed file with 34 additions and 11 deletions.
45 changes: 34 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![GitHub Stars](https://img.shields.io/github/stars/eloqdata/eloqkv?style=social)](https://github.com/eloqdata/eloqkv/stargazers)
---

## 1. Overview
## Overview
EloqKV is a **Redis-compatible database** designed for developers who need **ACID transactions, tiered storage, and SQL-style syntax** — all while keeping Redis' simplicity.

**Why Choose EloqKV Over Redis?**
Expand All @@ -20,7 +20,7 @@ EloqKV is a **Redis-compatible database** designed for developers who need **ACI

---

## 2. Key Features
## Key Features

### 🛠️ **ACID Transactions with SQL-Style Syntax**
```redis
Expand Down Expand Up @@ -63,8 +63,22 @@ redis-cli -h eloqkv-server SET key "value" # Works out of the box!

---

## 3. Install with Docker
**1. Start a Single Node:**
## Deploy with Tarball
Download the EloqKV tarball from the [EloqData website](https://www.eloqdata.com/download/eloqkv).

Follow the [instruction guide](https://www.eloqdata.com/eloqkv/install-from-binary) to set up and run EloqKV on your local machine.

---

## Deploy with EloqCtl
EloqCtl is the cluster management tool for EloqKV.

To deploy an EloqKV cluster in production, download [EloqCtl](https://www.eloqdata.com/downloadeloqctl) and follow the [deployment guide](https://www.eloqdata.com/eloqsql/cluster-deployment).

---

## Run with Docker
**1. Start a Single Node using Docker:**
```bash
# Create subnet for containers.
docker network create --subnet=172.20.0.0/16 eloqnet
Expand All @@ -84,20 +98,29 @@ OK

---

## 4. Build from Source
## Build from Source

### 1. Initialize Submodules
Fetch the Transaction Service and its dependencies:

```
git submodule update --init --recursive
### 1. Install Dependencies:
Use our Docker image with pre-installed dependencies for a quick build and run of EloqKV.

```bash
docker pull eloqdata/eloq-build-ubuntu2404:latest
```

### 2. Install Dependencies:
Or, you can manually run the following script to install dependencies on your local machine.

```bash
bash scripts/install_dependency_ubuntu2404.sh
```

### 2. Initialize Submodules
Fetch the Transaction Service and its dependencies:

```
git submodule update --init --recursive
```

### 3. Build EloqKV
```bash
mkdir build
Expand All @@ -110,7 +133,7 @@ make install
### 4. Run EloqKV
```bash
cd install
./bin/eloqkv
./bin/eloqkv --port=6389
```

---
Expand Down

0 comments on commit 1a4958b

Please sign in to comment.