News KrakenD CE v2.12 released

Community Documentation

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

Document updated on Oct 28, 2016

Running KrakenD server

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:

Run command help 

$krakend run -h

╓▄█                          ▄▄▌                               ╓██████▄µ
▐███  ▄███╨▐███▄██H╗██████▄  ║██▌ ,▄███╨ ▄██████▄  ▓██▌█████▄  ███▀╙╙▀▀███╕
▐███▄███▀  ▐█████▀"╙▀▀"╙▀███ ║███▄███┘  ███▀""▀███ ████▀╙▀███H ███     ╙███
▐██████▌   ▐███⌐  ,▄████████M║██████▄  ║██████████M███▌   ███H ███     ,███
▐███╨▀███µ ▐███   ███▌  ,███M║███╙▀███  ███▄```▄▄` ███▌   ███H ███,,,╓▄███▀
▐███  ╙███▄▐███   ╙█████████M║██▌  ╙███▄`▀███████╨ ███▌   ███H █████████▀
                     ``                     `'`

Version: v2.0

The API Gateway builder

Usage:
  krakend [command]

Available Commands:
  check         Validates that the configuration file is valid.
  check-plugin  Check the compatibility with the plugin deps.
  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.

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 -c krakend.json

Or if you use Docker:

Command to start KrakenD with Docker 

$docker run -p "8080:8080" -v $PWD:/etc/krakend/ krakend:v2.0 run -c /etc/krakend/krakend.json

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.

See all support channels