You are browsing documentation for an outdated version. See the latest documentation here.

Enable the Dev Portal

If you’re running Kong Gateway with a database (either in traditional or hybrid mode), you can use the Dev Portal.

Dev Portals are tied to workspaces. Each workspace has a separate Dev Portal instance.

Enabling the Dev Portal exposes the following URLs:

  • The workspace’s Dev Portal URL. For example, for the default workspace, the URL is: http://localhost:8003/default.
  • Dev Portal files endpoint: http://localhost:8001/files
  • Public Dev Portal files API: http://localhost:8004/files

To enable the Dev Portal, you must first deploy a license.

Docker

Linux (kong.conf)

  1. In your Docker container, set the Portal URL and set KONG_PORTAL to on:

    1.  echo "KONG_PORTAL_GUI_HOST=localhost:8003 KONG_PORTAL=on kong reload exit" \
    2.    | docker exec -i kong-container-name /bin/sh

    Replace kong-container-name with your Kong Gateway container.

    The HOSTNAME for KONG_PORTAL_GUI_HOST should not be preceded by a protocol. For example, http://.

  2. Enable the Dev Portal for a workspace:

    1.  curl -i -X PATCH http://localhost:8001/workspaces/default \
    2.    --data "config.portal=true"

  3. Access the Dev Portal for the workspace using the URL specified in the KONG_PORTAL_GUI_HOST variable:

    1.  http://localhost:8003/default

  4. To enable the Dev Portal, the following property must be set in the Kong configuration file (kong.conf):

    1. portal = on

    Restart Kong Gateway for this value to take effect:

    1. kong reload

  5. Enable Dev Portal for a workspace using one of the following methods:

    Kong Manager

    Admin API

    1. Navigate to a workspace in Kong Manager.
    2. In the Dev Portal menu section, click Overview.
    3. Click the button to Enable Developer Portal.
    1. curl -i -X PATCH http://localhost:8001/workspaces/default \
    2.    --data "config.portal=true"