krakend/krakend-ee repository overview

This is the official Docker container for KrakenD Enterprise (open-source image⁠ also available)

To use all Enterprise features, you need a valid LICENSE file.

📖 Documentation⁠ | 🔑 Get a trial LICENSE⁠

⁠What is this image?

With this KrakenD image, you can easily expose multiple backend services through a single API endpoint, handle high volumes of requests and traffic with minimal latency, and support multiple protocols and API specifications such as REST, GraphQL, and gRPC.

Fine-grained access controls such as rate limiting, authentication, and authorization are also a key feature of KrakenD. It also allows you to aggregate and transform data from multiple backend services and cache responses to improve the performance of your API.

We know that ease of use and flexibility are also important to you. KrakenD is designed to be easy to use, even for teams with limited API gateway experience.

This KrakenD docker image is based on Alpine and offers a small image size.

⁠Run it!

To simply test KrakenD (no configuration neither LICENSE) do:

docker run -p 8080:8080 krakend/krakend-ee

Then you can access the health endpoint:

curl HTTP://localhost:8080/__health

To add your KrakenD configuration mount a volume to /etc/krakend. Inside the volume you need at least the krakend.json file and the LICENSE file.

Generate your krakend.json here⁠ or use a docker-compose demo environment⁠

Enjoy KrakenD!

Documentation⁠

⁠Examples

The following are several examples of running krakend. By default the command run is executed, but you can pass other commands and flags at the end of the run command.

The configuration files are taken from current directory ($PWD). It is expected to find at least the file krakend.json and the LICENSE file.

⁠Show the help:

docker run -it krakend/krakend-ee --help

⁠Pull the image and run KrakenD (default parameters):

Runs KrakenD with the configuration file krakend.json found in the volume:

docker pull krakend/krakend-ee
docker run -p 8080:8080 -v $PWD:/etc/krakend/ krakend/krakend-ee

⁠Run with the /__debug endpoint enabled:

Runs KrakenD with the configuration file (-c) myconfig.json, andd enables the debug endpoint⁠ (flag -d):

docker run -p 8080:8080 -v "${PWD}:/etc/krakend/" krakend/krakend-ee run -d -c myconfig.json

⁠Check the syntax of the configuration file

Validate a configuration file⁠ with the check command:

docker run -it -p 8080:8080 -v $PWD:/etc/krakend/ krakend/krakend-ee check -tlc krakend.json

Flags -t (test routes) + l (linter) + c (config path).

Enjoy KrakenD!

And any questions please let us know via your support channel. If you don't have a LICENSE, please contact us⁠