Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PGBI/kong-dashboard
Dashboard for managing Kong gateway
https://github.com/PGBI/kong-dashboard
kong kong-dashboard kong-gateway
Last synced: 3 months ago
JSON representation
Dashboard for managing Kong gateway
- Host: GitHub
- URL: https://github.com/PGBI/kong-dashboard
- Owner: PGBI
- License: mit
- Created: 2015-11-13T05:17:02.000Z (about 9 years ago)
- Default Branch: 3.0
- Last Pushed: 2020-10-22T09:43:21.000Z (over 4 years ago)
- Last Synced: 2024-07-30T20:39:42.573Z (6 months ago)
- Topics: kong, kong-dashboard, kong-gateway
- Language: JavaScript
- Homepage:
- Size: 898 KB
- Stars: 2,176
- Watchers: 87
- Forks: 391
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kong - Kong Dashboard - Dashboard for managing Kong gateway (Tools / GUI)
- starred-awesome - kong-dashboard - Dashboard for managing Kong gateway (JavaScript)
README
# Kong Dashboard
[](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://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.