Skip to content

Themes, components, and utilities to help you get started with the Kong Dev Portal.

Notifications You must be signed in to change notification settings

Kong/kong-portal-templates

Repository files navigation

Kong Developer Portal Templates

Developer Portal Template Files for Kong Enterprise Edition

IMPORTANT: These templates are not compatible with Konnect. Only the on-premise enterprise version of Kong is compatible.

NOTE: These templates are for use with Kong Developer Portal v1.3 and above. Please checkout https://github.com/Kong/kong-portal-templates/master-legacy for v0.36.* and below.

Requirements

Installation

First install the Kong Portal CLI, then follow these instructions:

$ git clone git@github.com:Kong/kong-portal-templates.git
$ cd kong-portal-templates
$ portal deploy default

Workspaces

Path: workspaces/<workspace-name>

Workspaces are a way to segment entities within Kong. Each workspace contains one portal each with it's own content and themes.

Each Workspace follows the following structure:

CLI Configuration

Path: workspaces/<workspace-name>/cli.conf.yaml

Workspace CLI configuration file is used by the Kong Portal CLI tool, see CLI configuration documentation for more details.

Portal Configuration

Path: workspaces/<workspace-name>/portal.conf.yaml

Workspace specific portal configuration.

Values declared here will take priority over both theme.conf.yaml and values defined in your Kong kong.conf.

Templates Documentation

Template Updates

To integrate updates from this repo into your portal, see the doc at updating.md

Libraries Used