From 4117dc809cdd3d661493cc9b1b040ffb5894d9c6 Mon Sep 17 00:00:00 2001 From: Pavan Kumar Motaparthi Date: Mon, 13 Nov 2023 12:18:50 -0600 Subject: [PATCH] Updated README.md Based on the customer feedback, where they felt it is hard for any new Kong users to understand the differences between OSS and Enterprise. Because the difference of image naming conventions is not documented anywhere. Made the following updates to highlight the differences. --- compose/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/compose/README.md b/compose/README.md index 5799c89d..a3ec0338 100644 --- a/compose/README.md +++ b/compose/README.md @@ -16,6 +16,12 @@ Gateway distinguished for its high performance and extensibility via plugins. ## How to use this Compose file +**Note** +- Kong image [kong](https://hub.docker.com/_/kong) used in `docker-compose.yaml` is the open source image. +- To use Kong Enterprise Edition following image [kong/kong-gateway](https://hub.docker.com/r/kong/kong-gateway) should be used. + - A `license.json` file from Kong is required to leverage enterprise features. + - For additional information, please refer to [docs](https://docs.konghq.com/gateway/latest/install/docker/) + Kong Gateway can be deployed in different ways. This Docker Compose file provides support for running Kong in [db-less][kong-docs-dbless] mode, in which only a Kong container is spun up, or with a backing database. The default is db-less mode: