# Installation

eKuiper provides docker image, binary packages and helm chart to install.

# Running eKuiper in Docker

Please make sure docker has installed before running.

Get docker image.
```
docker pull lfedge/ekuiper:x.x.x
```
1

Start docker container.

docker run -p 9081:9081 -d --name kuiper -e MQTT_SOURCE__DEFAULT__SERVER=tcp://broker.emqx.io:1883 lfedge/ekuiper:xxx

In this example, we specify the default MQTT broker via environment variable to broker.emqx.io, which is a public MQTT test server hosted by EMQ (opens new window).

For more configuration and docker image tags, please check lfedge/ekuiper in docker hub (opens new window).

# Running eKuiper with management console

eKuiper manager is a free eKuiper management web console which is provided as a docker image. We can use docker compose to run both eKuiper and eKuiper manager at once to ease the usage.

Please make sure docker compose has installed before running.

Create docker-compose.yaml file.

version: '3.4'

services:
manager:
   image: emqx/ekuiper-manager:x.x.x
   container_name: ekuiper-manager
   ports:
   - "9082:9082"
   restart: unless-stopped
   environment: 
     # setting default eKuiper service, works since 1.8.0
     DEFAULT_EKUIPER_ENDPOINT: "http://ekuiper:9081"
ekuiper:
   image: lfedge/ekuiper:x.x.x
   ports:
     - "9081:9081"
     - "127.0.0.1:20498:20498"
   container_name: ekuiper
   hostname: ekuiper
   restart: unless-stopped
   user: root
   volumes:
     - /tmp/data:/kuiper/data
     - /tmp/log:/kuiper/log
   environment:
     MQTT_SOURCE__DEFAULT__SERVER: "tcp://broker.emqx.io:1883"
     KUIPER__BASIC__CONSOLELOG: "true"
     KUIPER__BASIC__IGNORECASE: "false"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

Start docker-compose cluster.
```
$ docker-compose -p my_ekuiper up -d
```
1

Check docker images running status, make sure two containers are started.

$ docker ps
CONTAINER ID   IMAGE                         COMMAND                  CREATED              STATUS                  PORTS                                                NAMES
e2dbcd4c1f92   lfedge/ekuiper:latest          "/usr/bin/docker-ent…"   7 seconds ago        Up Less than a second   0.0.0.0:9081->9081/tcp, 127.0.0.1:20498->20498/tcp   ekuiper
fa7c33b3e114   emqx/ekuiper-manager:latest   "/usr/bin/docker-ent…"   About a minute ago   Up 59 seconds           0.0.0.0:9082->9082/tcp                               manager

1
2
3
4

Please check use of eKuiper management console to set up and configure the eKuiper manager.

# Install From Zip

eKuiper binary packages are released on below operating systems with AMD64, ARM and ARM64 support:

CentOS 7 (EL7)
CentOS 8 (EL8)
Raspbian 10
Debian 9
Debian 10
Ubuntu 16.04
Ubuntu 18.04
Ubuntu 20.04
macOS

For other operating systems such as Windows, users can compile from source code manually.

Download eKuiper zip or tar for your CPU architecture from ekuiper.org (opens new window) or Github (opens new window).
Unzip the installation file:
```
unzip kuiper-x.x.x-linux-amd64.zip
```
1
Start eKuiper.
```
$ bin/kuiperd
```
1
Remove eKuiper. Simply delete the eKuiper directory.

After installation, all the files are inside the unzipped directory. Please check installed directory structure for detail.

# Install from package

Download eKuiper package for your CPU architecture from ekuiper.org (opens new window) or Github (opens new window).

Install eKuiper.

DEB package:

# for debian/ubuntu
$ sudo apt install ./kuiper-x.x.x-linux-amd64.deb

1
2

RPM package:

# for CentOS
$ sudo rpm -ivh kuiper-x.x.x-linux-amd64.rpm

1
2

Start eKuiper.

quick start
```
$ sudo kuiperd
```
1
systemctl
```
sudo systemctl start kuiper
```
1

Remove eKuiper.

DEB:
```
sudo apt remove --purge kuiper
```
1
RPM:
```
sudo yum remove kuiper
```
1

When installing by package, the eKuiper folders are not in the same directory. The installation structure is as below:

/usr/lib/kuiper/bin
  kuiperd
  kuiper
/etc/kuiper
  ...
/var/lib/kuiper/data
  ...
/var/lib/kuiper/plugins
  ...
/var/log/kuiper
   ...

1
2
3
4
5
6
7
8
9
10
11

# Install via Helm (K8S、K3S)

Add helm repository.

 $ helm repo add emqx https://repos.emqx.io/charts
 $ helm repo update

1
2

Query eKuiper.

 $ helm search repo emqx
 NAME         CHART VERSION APP VERSION DESCRIPTION
 emqx/emqx    v4.0.0        v4.0.0      A Helm chart for EMQX
 emqx/emqx-ee v4.0.0        v4.0.0      A Helm chart for EMQX
 emqx/ekuiper  0.1.1         0.1.1       A lightweight IoT edge analytic software

1
2
3
4
5

Start eKuiper.

 $ helm install my-ekuiper emqx/ekuiper

View eKuiper status.

$ kubectl get pods
NAME         READY  STATUS    RESTARTS  AGE
my-ekuiper-0 1/1    Running   0         56s

1
2
3

# Compile from source code

Get the source code.

$ git clone https://github.com/lf-edge/ekuiper.git

Compile.
```
$ make
```
1

Start eKuiper.

$ cd _build/kuiper-x.x.x-linux-amd64/
$ bin/kuiperd

1
2

eKuiper allows to tailor the binary in compilation to get a customized feature set. As written by go, it also allows cross compilation. For detail, please check compilation.

# Installation structure

Below is the directory structure after installation.

bin
  kuiperd
  kuiper
etc
  ...
data
  ...
plugins
  ...
log
  ...

1
2
3
4
5
6
7
8
9
10
11

# bin

The bin directory includes all of executable files. Such as the kuiper server kuiperd and the cli client kuiper.

# etc

The etc directory contains the default configuration files of eKuiper. Such as the global configuration file kuiper.yaml and all the source configuration files such as mqtt_source.yaml.

# data

This folder saves the persisted definitions of streams and rules. It also contains any user defined configurations.

# plugins

eKuiper allows users to develop your own plugins, and put these plugins into this folder. See extension for more info for how to extend the eKuiper.

# log

All the log files are under this folder. The default log file name is stream.log.

← Run eKuiper with EdgeX Foundry Configuration →