Kong Dashboard

Kong is a scalable, open source API Layer (also known as a API Gateway, or API Middleware). Kong runs in front of any RESTful API and provide functionalities and services such as requests routing, authentication, rate limiting, etc.

Kong dashboard is a UI tool that will let you manage your Kong Gateway setup.

Compatibility

Current version of Kong dashboard is compatible with Kong 0.6.x, 0.7.x, 0.8.x and 0.9.x.

Presentation

Click thumbnails to enlarge.

Managing APIs

Managing Consumers

Managin Plugins

Prerequisites

You will need:

1. a running Kong gateway. https://getkong.org/install/
2. nodejs and npm.

Installation

With Npm

# Install Kong Dashboard
npm install -g kong-dashboard

# Start Kong Dashboard
kong-dashboard start

# To start Kong Dashboard on a custom port
kong-dashboard start -p [port]

# To start Kong Dashboard with basic auth
kong-dashboard start -a user=password

# You can set basic auth user with environment variables
# Do not set -a parameter or this will be overwritten
set kong-dashboard-name=admin && set kong-dashboard-pass=password && kong-dashboard start

From sources

# Pull repository
git clone https://github.com/PGBI/kong-dashboard.git
cd kong-dashboard

# Build Kong Dashboard
npm install

# Start Kong Dashboard
npm start

# To start Kong Dashboard on a custom port or with basic auth
npm start -- [-p port] [-a user=password]

With Docker

# Start Kong Dashboard
docker run -d -p 8080:8080 pgbi/kong-dashboard

# Start Kong Dashboard on a custom port
docker run -d -p [port]:8080 pgbi/kong-dashboard

# Start Kong Dashboard with basic auth
docker run -d -p 8080:8080 pgbi/kong-dashboard npm start -- -a user=password

With Vagrant

# Pull repository
git clone https://github.com/PGBI/kong-dashboard.git
cd kong-dashboard

# Start VM
vagrant up

Configuration

When browsing Kong-Dashboard, you will be asked to provide the URL of your Kong node.

If you're hosting Kong on your local machine, the "Kong node URL" is not "http://localhost:8001". It will be your machine/LAN IP, for example: "http://192.168.x.x:8001"

Use

You can now browse your kong dashboard at http://localhost:8080