tikv/tikv Installation Guide

⚡

Automated Install (Recommended)

Quick installation instructions for tikv/tikv. This is the fastest way to complete project installation and setup.

Install via curl

curl -fsSL https://hexmos.com/ipm-install | bash && 
ipm i tikv/tikv

Install via PowerShell

iwr https://hexmos.com/ipm-install-ps -UseBasicParsing | iex; 
ipm i tikv/tikv

Install via npx

npx @hexmos/ipm i tikv/tikv

Prerequisites

Go

language

Version: 1.18.0+ (or latest stable version)

Rust

language

Version: 1.54.0+ (or latest stable version)

Docker

system_tool

For containerizing the TiKV deployment.

Git

system_tool

Used for cloning the repository and managing Git branches.

Python 3.5+

language

Version: 3.5.0+ (or latest stable version)

Node.js

system_tool

For running the TiKV client and server.

Manual Installation Methods

Binary Installation

curl -O https://tiup-mirrors.pingcap.com/tikv-$TIKV_VERSION-$GOOS-$GOARCH.tar.gz && tar -xzf tikv-$TIKV_VERSION-$GOOS-$GOARCH.tar.gz

curl -O https://tiup-mirrors.pingcap.com/pd-$TIKV_VERSION-$GOOS-$GOARCH.tar.gz && tar -xzf pd-$TIKV_VERSION-$GOOS-$GOARCH.tar.gz

./tikv-server --pd-endpoints="127.0.0.1:2379" --addr="127.0.0.1:20160" --data-dir=/tmp/tikv/data --log-file=/tmp/tikv/log/tikv.log

./pd-server --name=pd --data-dir=/tmp/pd/data --client-urls="http://127.0.0.1:2379" --peer-urls="http://127.0.0.1:2380" --initial-cluster="pd=http://127.0.0.1:2380" --log-file=/tmp/pd/log/pd.log

Post Installation Steps

Start the TiKV server: `./tikv-server`
Connect to the TiKV cluster using a client like `tiup-client` (see https://tikv.org/docs/4.0/reference/clients/go/) or your preferred method.
Verify that TiKV is running by checking the status of the server: `ps aux | grep tikv`.

← Back to server All Installation Guides