Running Multiple Dev Portals with Workspaces

    A snapshot of every Dev Portal within an instance of Kong can be viewed via the Kong Manager’s Dev Portals top navigation tab.

    This page details:

    • Whether a Dev Portal in a given Workspace is enabled or disabled
    • A link to set up the Dev Portal if it is not enabled
    • A link to each Dev Portal’s homepage
    • Whether or not each Dev Portal is authenticated (indicated by a lock icon in the upper right corner of each card)

    Enable a Workspace’s Dev Portal

    As with the default Workspace, when an additional Workspace is created, its associated Dev Portal is until it’s manually enabled.

    This can be done from the Kong Manager by clicking the Set up Dev Portal button located on the Dev Portals Overview page, or by navigating directly to a Workspace’s Dev Portal Settings page via the sidebar and toggling the Dev Portal Switch, or by sending the following cURL request:

    The URL of each Dev Portal is automatically configured on initialization and is determined by four properties:

    1. The property
    2. The portal_gui_host property
    3. Whether the property is enabled or disabled

    Example URL with subdomains disabled:

    Example URL with subdomains enabled: http://example-workspace.localhost:8003

    Override Default Settings

    On initialization, the Dev Portal will be configured using the defined in Kong’s configuration file.

    Note: You can only enable a Dev Portal for a Workspace if the Dev Portal feature has been enabled for Kong Gateway.

    These settings can be manually overridden in the Dev Portals Settings tab in the Kong Manager or by patching the setting directly.

    On initialization of a Workspace’s Dev Portal, a copy of the default Dev Portal files will be made and inserted into the new Dev Portal. This allows for the easy transference of a customized Dev Portal theme and allows default to act as a ‘master template’ – however, the Dev Portal will not continue to sync changes from the default Dev Portal after it is first enabled.

    Developer Access