KrakenD Enterprise 2.0 released! Read the Release notes »

Documentation

Recent changes

You are viewing a previous version of KrakenD Community Edition (v1.3) , go to the latest version

Running KrakenD server. The krakend run command

To start KrakenD, you need to invoke the run command with the path to the configuration file. You can also specify the port (defaults to 8080)

Command to start KrakenD 
$krakend run -c krakend.json 
# or 
krakend run --config /path/to/krakend.json 
# or 
krakend run --config /path/to/krakend.json -p 8080 

The krakend run command with no flags will remind you that you need the path to the configuration file:

Missing configuration file 
$krakend run 
Please, provide the path to your config file 

Show the help:

Run command help 
$krakend run -h 
 
`7MMF' `YMM'                  `7MM                         `7MM"""Yb. 
  MM   .M'                      MM                           MM    `Yb. 
  MM .d"     `7Mb,od8 ,6"Yb.    MM  ,MP'.gP"Ya `7MMpMMMb.    MM     `Mb 
  MMMMM.       MM' "'8)   MM    MM ;Y  ,M'   Yb  MM    MM    MM      MM 
  MM  VMA      MM     ,pm9MM    MM;Mm  8M""""""  MM    MM    MM     ,MP 
  MM   `MM.    MM    8M   MM    MM `Mb.YM.    ,  MM    MM    MM    ,dP' 
.JMML.   MMb..JMML.  `Moo9^Yo..JMML. YA.`Mbmmd'.JMML  JMML..JMMmmmdP' 
_______________________________________________________________________ 
 
Version: 1.3 
 
The API Gateway builder 
 
Usage: 
  krakend [command] 
 
Available Commands: 
  check       Validates that the configuration file is valid. 
  help        Help about any command 
  run         Run the KrakenD server. 
 
Flags: 
  -c, --config string   Path to the configuration filename 
  -d, --debug           Enable the debug 
  -h, --help            help for krakend 
 
Use "krakend [command] --help" for more information about a command. 

Example

The most common way of starting the service is:

Start krakend 
$krakend run --config krakend.json 

To start the KrakenD service in a different port (the port can be set in the configuration file as well):

Start in a custom port 
$krakend run --config path/to/krakend.json --port 8888 

In development and testing phase increase the verbosity of the logs

Unresolved issues?

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.

See all support channels

We use cookies to understand how you use our site and to improve your overall experience. By continuing to use our site, you accept our Privacy Policy. More information