More than just another GUI to KONG Admin API

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

Summary

• Discussions & Support
• Features
• Compatibility
• Prerequisites
• Used libraries
• Installation
• Configuration
• Running Konga
• More Kong related stuff
• License

Discussions & Support

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

Features

• Manage APIs and plugins
• Manage consumers, groups and credentials
• Mass import consumers from :
  • CSV document
  • Google Spreadsheets
  • MySQL
  • MongoDB
  • more underway...
• Multiple nodes management
• GUI level authentication
• Multiple users (Only admin and user roles for now)

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.

$ npm install bower gulp sails -g
$ git clone https://github.com/pantsel/konga.git
$ cd konga
$ npm install

Configuration

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

There is an example configuration file on following path.

/config/local_example.js

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.

Running Konga

Development

$ npm start

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

Production

$ npm run production

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

Production Docker Image

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

$ docker pull pantsel/konga
$ docker run -p 1338:1338 
             --link kong:kong
             --name konga
             pantsel/konga

The GUI will be available at http://{your server's public ip}:1338 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

More Kong related stuff

• Kong Admin proxy
• Kong Middleman plugin

ToDo

• Complete tests
• Add more consumer import adapters (?)
• Write a detailed Wiki
• Move API to it's own module so that it can be lifted on a different port - See kong-admin-proxy

Author

Panagis Tselentis

License

The MIT License (MIT)
=====================

Copyright (c) 2015 Panagis Tselentis

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.