# kong-dashboard

> Web UI for managing Kong gateway

Latest version **3.6.0** (published 2019-03-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install kong-dashboard
pnpm add kong-dashboard
yarn add kong-dashboard
bun add kong-dashboard
```

Provides the command `kong-dashboard`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.6.0 |
| Published | 2019-03-17 |
| First published | 2015-11-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.0.0 |
| Dependencies | 10 |
| Unpacked size | 1.7 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2163 |
| Maintainers | pgbi |
| Keywords | UI, kong, gateway |

## Links

- npm: https://www.npmjs.com/package/kong-dashboard
- Repository: https://github.com/PGBI/kong-dashboard
- Homepage: https://github.com/PGBI/kong-dashboard#readme
- Issues: https://github.com/PGBI/kong-dashboard/issues
- npm.io page: https://npm.io/package/kong-dashboard

## Dependencies (10)

- [koa](https://npm.io/package/koa.md) ^2.3.0
- [chalk](https://npm.io/package/chalk.md) ^2.1.0
- [yargs](https://npm.io/package/yargs.md) ^8.0.2
- [semver](https://npm.io/package/semver.md) ^5.4.1
- [request](https://npm.io/package/request.md) ^2.88.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [koa-mount](https://npm.io/package/koa-mount.md) ^2.0.0
- [basic-auth](https://npm.io/package/basic-auth.md) ^2.0.0
- [koa-static](https://npm.io/package/koa-static.md) ^3.0.0
- [koa-bodyparser](https://npm.io/package/koa-bodyparser.md) ^3.2.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 3.6.0 (latest) — 2019-03-17
- 3.5.0 — 2018-09-15
- 3.4.1 — 2018-09-06
- 3.4.0 — 2018-09-06
- 3.3.0 — 2018-05-12
- 3.2.0 — 2018-03-15
- 3.1.0 — 2018-01-28
- 3.0.1 — 2017-12-14
- 3.0.0 — 2017-11-28
- 2.4.0 — 2017-11-24
- 2.3.1 — 2017-10-16
- 2.3.0 — 2017-10-05
- 2.2.1 — 2017-09-25
- 2.2.0 — 2017-08-09
- 2.1.1 — 2017-05-23
- … 11 more at https://npm.io/package/kong-dashboard/versions

## README

# Kong Dashboard

[![Build Status](https://travis-ci.org/PGBI/kong-dashboard.svg?branch=3.0)](https://travis-ci.org/PGBI/kong-dashboard)

[**Kong**](https://getkong.org/) 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 GUI that will let you manage your Kong Gateway setup.

## Compatibility matrix

| Kong-Dashboard versions | Kong versions | Node versions |
|--------------|------------------------------|--------------|
| 1.x.x        | >= 0.6, < 0.10 |              |
| 2.x.x        | 0.10           |              |
| 3.0.x        | >= 0.9, <0.12  | >= 6.0.0     |
| 3.1.x, 3.2.x | >= 0.9, <0.13  | >= 6.0.0     |
| 3.3.x, 3.4.x | >= 0.9, <0.14  | >= 6.0.0     |
| 3.5.x        | >= 0.9, <0.15  | >= 6.0.0     |    
| 3.6.x        | >= 0.9, <2.0.0 | >= 6.0.0     |    

Notes:
* Kong Dashboard 3.3.0 is only partially compatible with Kong 0.13. It does not support the new Service and Route
objects introduced in Kong 0.13.

## Prerequisites

You will need:

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

## Installation

### Using npm

```bash
# Install Kong Dashboard
npm install -g kong-dashboard

# Start Kong Dashboard
kong-dashboard start --kong-url http://kong:8001

# Start Kong Dashboard on a custom port
kong-dashboard start \
  --kong-url http://kong:8001 \
  --port [port]

# Start Kong Dashboard with basic auth
kong-dashboard start \
  --kong-url http://kong:8001 \
  --basic-auth user1=password1 user2=password2

# See full list of start options
kong-dashboard start --help
```

### Using Docker

[![](https://images.microbadger.com/badges/image/pgbi/kong-dashboard.svg)](https://microbadger.com/images/pgbi/kong-dashboard "Get your own image badge on microbadger.com")

```bash
# Start Kong Dashboard
docker run --rm -p 8080:8080 pgbi/kong-dashboard start --kong-url http://kong:8001

# Start Kong Dashboard on a custom port
docker run --rm -p [port]:8080 pgbi/kong-dashboard start --kong-url http://kong:8001

# Start Kong Dashboard with basic auth
docker run --rm -p 8080:8080 pgbi/kong-dashboard start \
  --kong-url http://kong:8001
  --basic-auth user1=password1 user2=password2

# See full list of start options
docker run --rm -p 8080:8080 pgbi/kong-dashboard start --help
```

## Use

You can now browse Kong Dashboard at http://localhost:8080

# Contributing

If you consider contributing to Kong Dashboard by reporting a bug, or submitting a patch, please checkout the
[contribution document](./CONTRIBUTING.md) for guidance.

---
_Source: https://npm.io/package/kong-dashboard · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._