Document updated on Mar 11, 2019
KrakenD API Gateway Installation Guide
KrakenD is a single binary file that does not require any external libraries to work. To install KrakenD choose your operative system in the downloads section or use the Docker image.
Installation
You can install (or just run) KrakenD using different options.
docker-compose up
!Docker
The easiest way to get started is by pulling and running the KrakenD image from the Docker Hub.
Running KrakenD using the Docker container
$docker run -p 8080:8080 -v $PWD:/etc/krakend/ devopsfaith/krakend run --config /etc/krakend/krakend.json
If you choose not to mount the volume (the -v
), a default krakend.json
serving a /__health
endpoint will be used. The volume expects to find a krakend.json
in the current directory (generate your first here).
AWS and Azure VM
See the downloads page for pre-built virtual machines in Azure and AWS.
Mac OS X
The Homebrew formula will download the source code, build the binary, and link the binary for you. The installation might take a while.
Install on Mac via Brew
$brew install krakend
After the installation completes go to Using KrakenD
Linux
CentOS, Oracle Linux, and Redhat (yum)
The installation process requires following these steps:
- Install the repo package
- Install the KrakenD package
- Start the KrakenD service
Paste this in the terminal:
Yum based
$rpm -Uvh https://repo.krakend.io/rpm/krakend-repo-0.2-0.x86_64.rpm
yum install -y krakend
systemctl start krakend
Fedora
Paste this in the terminal:
DNF based
$rpm -Uvh https://repo.krakend.io/rpm/krakend-repo-0.2-0.x86_64.rpm
dnf install -y krakend
systemctl start krakend
The current KrakenD version will run at least in Centos 7 and Fedora 24
Debian and Ubuntu
The installation process requires following these steps:
- Add the key
- Add the repo to the sources.list
- Update your package list
- Install the KrakenD service
Bottom line:
DEB based
$apt install -y ca-certificates gnupg
apt-key adv --keyserver keyserver.ubuntu.com --recv 5DE6FD698AD6FDD2
echo "deb https://repo.krakend.io/apt stable main" | tee /etc/apt/sources.list.d/krakend.list
apt-get update
apt-get install -y krakend
Minimum supported versions are Debian 8, and Ubuntu 16.x.
Generic Linux (tar.gz
)
You can also download the tar.gz
and decompress it anywhere. Instructions to check the SHA and PGP signature here.
Compile from source
As KrakenD is open source you can opt for building the binary. The binary you will produce is the same you can get in our download page, only that compiling it yourself always feels good!
Contribute to KrakenD Documentation. Improve this page »