Kong Gateway quickstart script reference

Uses: Kong Gateway AI Gateway
Related Documentation
Incompatible with
konnect

Kong offers a quickstart script that allows you to easily run a local instance of the latest version of Kong Gateway for testing purposes.

To run this quickstart you just need to start Docker and store your Kong license in the KONG_LICENSE_DATA environment variable. Once this is done, run this command to create the Docker containers for Kong Gateway and its database:

curl -Ls https://get.konghq.com/quickstart | bash -s --  \
          -e KONG_LICENSE_DATA

For more information about the configuration used for the quickstart, check out the full script.

Quickstart script parameters

If needed, you can pass different flags and parameters to the script. For example:

Description

Command example

Get information about the quickstart
curl -Ls https://get.konghq.com/quickstart | bash -s -- -h
Run in DB-less mode
curl -Ls https://get.konghq.com/quickstart | bash -s --  \
    -e KONG_LICENSE_DATA \
    -D
Enable Prometheus metrics
curl -Ls https://get.konghq.com/quickstart | bash -s --  \
    -e KONG_LICENSE_DATA \
    -m
Enable RBAC
curl -Ls https://get.konghq.com/quickstart | bash -s --  \
    -e KONG_LICENSE_DATA \
    -e KONG_ENFORCE_RBAC=on
Pass environment variables
curl -Ls https://get.konghq.com/quickstart | bash -s --  \
    -e KONG_LICENSE_DATA \
    -e AZURE_CLIENT_SECRET

AI Gateway quickstart v3.6+

Kong also provides an interactive AI quickstart script that launches a demo instance of Kong Gateway running AI Proxy:

curl -Ls https://get.konghq.com/ai | bash -s -- -e KONG_LICENSE_DATA

The script can either run a Kong Gateway instance in traditional mode or as a data plane instance for Konnect. You will be prompted to input an API key to configure authentication with an AI provider. This key will not be exposed outside of the host machine.

The script creates a Gateway Service with two Routes, and configures the AI Proxy plugin on those Routes based on the provider that you specify.

Check out the full script at https://get.konghq.com/ai to see which entities it generates, and access all of your Routes and Services by visiting either Gateway Manager in Konnect or Kong Manager at https://localhost:8002 in any browser.

Note: By default, local models are configured on the endpoint http://host.docker.internal:11434, which allows Kong Gateway running in Docker to connect to the host machine.

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!