kongadmin

v0.8.3

Published

3 years ago

Kong admin GUI

Downloads

0High
0Medium
0Low

pantsel

sails.js backend REST API JWT JSON Web Token Passport.js

More than just another GUI to KONG Admin API

Konga is not an official app. No affiliation with Mashape.

Site and working demo here

Summary

Discussions & Support

If you need to discuss anything Konga related, we have a chatroom on Gitter:

Features

Manage all Kong Admin API Objects.
Import Consumers from remote sources (Databases, files, APIs etc.).
Manage multiple Kong Nodes.
Backup, restore and migrate Kong Nodes using Snapshots.
Monitor Node and API states using health checks.
Email notifications.
Multiple users.
Easy database integration (MySQL, postgresSQL, MongoDB, SQL Server).

Compatibility

Konga is compatible with Kong 0.9.x,0.10.x

Prerequisites

A running Kong installation
Nodejs
Npm
Gulp
Bower

Used libraries

Sails.js, http://sailsjs.org/
AngularJS, https://angularjs.org/
Bootstrap, http://getbootstrap.com/

Installation

Install npm and node.js. Instructions can be found here.

Install bower, gulp and sails packages.

Configuration

You can configure your application to use your environment specified settings.

There is an example configuration file on following path.

Just copy this to /config/local.js and make necessary changes to it. Note that this local.js file is in .gitignore so it won't go to VCS at any point.

Databases Integration

Konga is bundled with It's own persistence mechanism for storing users and configuration.

A local persistent object store is used by default, which works great as a bundled, starter database (with the strict caveat that it is for non-production use only).

The application also supports some of the most popular databases out of the box:

MySQL
MongoDB
PostgresSQL
SQL Server

In order to use them, in your /config/local.js replace

with

See Sails adapters for further configuration

Note :

In case of MySQL, PostgresSQL or SQL Server adapters, you will need to create a database named konga_database manually and run the app in development mode the first time.

Then kill the process and start Konga as you would in production mode. Konga will not create the database or tables in production mode.

Running Konga

Development

Konga GUI will be available at http://localhost:1337

Production

Konga GUI will be available at http://localhost:1337

Production Docker Image

The following instructions assume that you have a running Kong instance following the instructions from Kong's docker hub

To use one of the supported databases

The GUI will be available at http://{your server's public ip}:1337 Login, go to settings -> new node and add http://kong:8001 for Kong Admin URL.

Login

Admin login: admin | password: adminadminadmin

Demo user login: demo | password: demodemodemo

Upgrading

In some cases a newer version of Konga may introduce new db tables, collections or changes in schemas. The only thing you need to do is to start Konga in dev mode once so that the migrations will be applied. Then stop the app and run it again in production mode.

FAQ

1. Getting blank page with Uncaught ReferenceError: angular is not defined

In some cases when running npm install, the bower dependencies are not installed properly. You will need to cd into your project's root directory and install them manually by typing

2. Can't add/edit some plugin properties.

When a plugin property is an array, the input is handled by a chip component. You will need to press enter after every value you type in so that the component assigns it to an array index. See issue #48 for reference.