KrakenD Enterprise 2.0 released! Read the Release notes »

Documentation

Recent changes

Running KrakenD

After installing KrakenD, you can start using KrakenD by typing krakend. To see all the options of krakend, type krakend -h or krakend <COMMAND> -h. For instance, the krakend run help is:

The krakend command 
$krakend 
 
╓▄█                          ▄▄▌                               ╓██████▄µ 
▐███  ▄███╨▐███▄██H╗██████▄  ║██▌ ,▄███╨ ▄██████▄  ▓██▌█████▄  ███▀╙╙▀▀███╕ 
▐███▄███▀  ▐█████▀"╙▀▀"╙▀███ ║███▄███┘  ███▀""▀███ ████▀╙▀███H ███     ╙███ 
▐██████▌   ▐███⌐  ,▄████████M║██████▄  ║██████████M███▌   ███H ███     ,███ 
▐███╨▀███µ ▐███   ███▌  ,███M║███╙▀███  ███▄```▄▄` ███▌   ███H ███,,,╓▄███▀ 
▐███  ╙███▄▐███   ╙█████████M║██▌  ╙███▄`▀███████╨ ███▌   ███H █████████▀ 
                     ``                     `'` 
 
Version: 2.0.2 
 
The API Gateway builder 
 
Usage: 
  krakend [command] 
 
Available Commands: 
  check       Validates that the configuration file is valid. 
  generate    Generates static content for several functionalities. See subcommands. 
  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. 

To start the server, invoke the krakend run command. The command will require a configuration file with your API definition. You can create your first krakend.json file using the KrakenDesigner if you prefer a UI.

Make sure KrakenD can find a krakend.json and a LICENSE file.

To get started right away, you can paste the following content inside a krakend.json file:

{
    "$schema": "https://www.krakend.io/schema/v3.json",
    "version": 3
}

And then you can start KrakenD:

Command to start KrakenD 
$krakend run --accept-eula -c krakend.json 

Or if you use Docker:

Running KrakenD using the Docker container 
$docker run -p 8080:8080 -v "$PWD:/etc/krakend/" 052351007912.dkr.ecr.us-east-1.amazonaws.com/krakend-ee:2.0.2 run --config /etc/krakend/krakend.json --accept-eula 

Now KrakenD is listening on 8080, and you can see it working under http://localhost:8080/__health.

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.

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