Repository files navigation

Installation |Provide feedback |Ask a question |Contributing |Blog

Kong Manager OSS, afree andopen-source UI forKong, the world's most used open source API Gateway.

Built and maintained with ❤️ by the team at Kong.

Kong Manager OSS allows you to view and edit all Kong Gateway objects using the admin API. It interacts directly with the Kong admin API and does not require a separate database.

Important: Kong Manager OSS is only compatible in Kong Gateway 3.4+

Kong Manager OSS is bundled with Kong Gateway, seeGetting Started for information on how to use it. To run Kong Manager OSS locally, please see thecontributing section.

To use Kong Manager OSS you'll need a running Kong Gateway instance. This can be a local instance or running on a remote server.

The quickest way to get started is using the quickstart script:

curl -Ls https://get.konghq.com/quickstart| bash -s -- -i kong -t latest

Finally, visithttps://localhost:8002 to view Kong Manager.

Kong Manager OSS is intended to be a local testing tool. However, you can also use it on a public server.

If running Kong Manger OSS on a public server, ensure that ports8001 and8002 are only accessible to your IP address

To access Kong Manager OSS from a remote machine, ensure thatadmin_listen andadmin_gui_listen are binding to0.0.0.0 rather than127.0.0.1 inkong.conf and restart your Kong Gateway instance.

You've been using the admin API just fine for years. Why would you want to use a UI?

Kong Manager OSS is a great way to see your Kong Gateway configuration at glance. You can see the routes and plugins configured on a service and drill in to the configuration of each in a single click.

In addition, the plugin configuration UI provides instructions for each configuration option. You can configure a plugin using the UI with helpful tooltips before runningdeck dump to see the final configuration values.

Kong Manager OSS is written in JavaScript. It uses Vue for it's UI components, andpnpm for managing dependencies. To build Kong Manager OSS locally please ensure that you havenode.js 18+ andpnpm installed.

You'll also need a running Kong Gateway instance. Seelocal testing for a one-line solution. Alternatively, you canbuild Kong Gateway from source.

Once Kong Gateway is running, run the following command to start the development server:

pnpm&& pnpm serve

Kong Manager OSS is now available athttp://localhost:8080