• 0.10, 0.10.3, latest (Dockerfile)
• 0.9, 0.9.9 (Dockerfile)

• Where to get help:
  the Docker Community Forums, the Docker Community Slack, or Stack Overflow

• Where to file issues:
  https://github.com/Mashape/kong/issues

• Maintained by:
  the Mashape Docker Maintainers

• Published image artifact details:
  repo-info repo's repos/kong/ directory (history)
  (image metadata, transfer size, etc)

• Image updates:
  official-images PRs with label library/kong
  official-images repo's library/kong file (history)

• Source of this description:
  docs repo's kong/ directory (history)

• Supported Docker versions:
  the latest release (down to 1.6 on a best-effort basis)

Kong was built to secure, manage and extend Microservices & APIs. If you're building for web, mobile or IoT (Internet of Things) you will likely end up needing to implement common functionality on top of your actual software. Kong can help by acting as a gateway for any HTTP resource while providing logging, authentication and other functionality through plugins.

Powered by NGINX and Cassandra with a focus on high performance and reliability, Kong runs in production at Mashape where it has handled billions of API requests for over ten thousand APIs.

Kong's documentation can be found at getkong.org/docs.

First, Kong requires a running Cassandra 2.2.x or PostgreSQL 9.4/9.5 cluster before it starts. You can either use the official Cassandra/PostgreSQL containers, or use your own.

It's up to you to decide which datastore between Cassandra or PostgreSQL you want to use, since Kong supports both.

Start a Cassandra container by executing:

$ docker run -d --name kong-database \
                -p 9042:9042 \
                cassandra:2.2

Start a PostgreSQL container by executing:

docker run -d --name kong-database \
                -p 5432:5432 \
                -e "POSTGRES_USER=kong" \
                -e "POSTGRES_DB=kong" \
                postgres:9.4

Once the database is running, we can start a Kong container and link it to the database container, and configuring the KONG_DATABASE environment variable with either cassandra or postgres depending on which database you decided to use:

$ docker run -d --name kong \
    --link kong-database:kong-database \
    -e "KONG_DATABASE=cassandra" \
    -e "KONG_CASSANDRA_CONTACT_POINTS=kong-database" \
    -e "KONG_PG_HOST=kong-database" \
    -p 8000:8000 \
    -p 8443:8443 \
    -p 8001:8001 \
    -p 7946:7946 \
    -p 7946:7946/udp \
    kong

If everything went well, and if you created your container with the default ports, Kong should be listening on your host's 8000 ([proxy][http://getkong.org/docs/latest/configuration/#proxy_port]), 8443 (proxy SSL) and 8001 (admin api) ports. Port 7946 (cluster) is being used only by other Kong nodes.

You can now read the docs at getkong.org/docs to learn more about Kong.

You can override any property of the Kong configuration file with environment variables. Just prepend any Kong configuration property with the KONG_ prefix, for example:

$ docker run -d --name kong \
    -e "KONG_LOG_LEVEL=info" \
    -e "KONG_CUSTOM_PLUGINS=helloworld" \
    -e "KONG_PG_HOST=1.1.1.1" \
    -p 8000:8000 \
    -p 8443:8443 \
    -p 8001:8001 \
    -p 7946:7946 \
    -p 7946:7946/udp \
    kong

If you change your custom configuration, you can reload Kong (without downtime) by issuing:

$ docker exec -it kong kong reload

This will run the kong reload command in your container.

View license information for the software contained in this image.