Document updated on Oct 20, 2018
All the configuration that the KrakenD server needs to start and operate is a single configuration file. This file is referred to as
krakend.json through all the documentation.
krakend.json is just an alias, a convention, that we use everywhere. Your real configuration file can have any name, be stored anywhere, or split in many pieces.
Provided this simple configuration mechanism, the versioning and automation are very convenient. Any change in the API Gateway is always under the version control system, and the code controls the state of the gateway.
The configuration file can be written from scratch or reuse another existing file as a base, but the easiest way to write your first configuration file is by simply using the online configuration editor KrakenDesigner.
The Kraken Designer is a pure static page that does not send any of your configuration elsewhere, and as it happens with all our software, is also open sourced and you can download it and run it in your own web server. See the Krakendesigner repository.
Through all the documentation we refer to the configuration file as the
krakend.json file, but the configuration file can be written using
.hcl. For more information and recommendations see supported file formats.
Validate the syntax (not the logic) of your configuration file using the
krakend check command:
$krakend check --config ./krakend.toml --debug --lint
When the syntax is correct, you’ll see the message
Syntax OK!, otherwise the error is shown.
You can also start the service directly as this is done right before the server starts (except the linting).
Read more about
The documentation is only a piece of the help you can get! Whether you are looking for Open Source or Enterprise support, see more support channels that can help you.