The official Docker Compose template for Kong Gateway.

Note The Kong Docker Compose file uses the v3.9 compose schema; as such, it requires Docker Engine version 20.10.0+.

Kong or Kong API Gateway is a cloud-native, platform-agnostic, scalable API Gateway distinguished for its high performance and extensibility via plugins.

• Kong's Official documentation can be found at docs.konghq.com.
• You can find the official Docker distribution for Kong on Docker Hub.

Kong Gateway can be deployed in different ways. This Docker Compose file provides support for running Kong in db-less mode, in which only a Kong container is spun up, or with a backing database. The default is db-less mode:

$ docker compose up -d

This command will result in a single Kong Docker container:

$ docker compose ps
NAME                IMAGE               COMMAND                  SERVICE             CREATED             STATUS                    PORTS
compose-kong-1      kong:latest         "/docker-entrypoint.…"   kong                38 seconds ago      Up 29 seconds (healthy)   0.0.0.0:8000->8000/tcp, 127.0.0.1:8001->8001/tcp, 0.0.0.0:8443->8443/tcp, 127.0.0.1:8444->8444/tcp
$ docker ps

Kong entities can be configured through the config/kong.yaml declarative config file. Its format is further described here.

You can also run Kong with a backing Postgres database:

$ KONG_DATABASE=postgres docker compose --profile database up -d

Which will result in two Docker containers running -- one for Kong itself, and another for the Postgres instance it uses to store its configuration entities:

$ docker compose ps
NAME                IMAGE               COMMAND                  SERVICE             CREATED              STATUS                        PORTS
compose-db-1        postgres:9.5        "docker-entrypoint.s…"   db                  About a minute ago   Up About a minute (healthy)   5432/tcp
compose-kong-1      kong:latest         "/docker-entrypoint.…"   kong                About a minute ago   Up About a minute (healthy)   0.0.0.0:8000->8000/tcp, 127.0.0.1:8001->8001/tcp, 0.0.0.0:8443->8443/tcp, 127.0.0.1:8444->8444/tcp

Kong will be available on port 8000 and 8001. You can customize the template with your own environment variables or datastore configuration.

If you have any problems with or questions about this image, please contact us through a GitHub issue.

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.