Install Kong Gateway on Ubuntu

You are browsing documentation for an older version. See the latest documentation here.

Install Kong Gateway on Ubuntu

The Kong Gateway software is governed by the Kong Software License Agreement. Kong is licensed under an Apache 2.0 license.

This page guides you through installing Kong Gateway in traditional mode, where it acts as both the control plane and data plane. Running in this mode may have a small performance impact.

We recommend using Konnect as your control plane to allow your data plane to run at maximum performance and decrease your deployment complexity.

Prerequisites

A supported system with root or root-equivalent access.
(Enterprise only) A license.json file from Kong

Once you have everything you need, choose an installation path:

Quickstart: Install script for a Kong Gateway package and PostgreSQL database
Advanced installation: Choose your own pieces to install

Notes:

Kong Gateway supports running on AWS Graviton processors. It can run in all AWS Regions where AWS Graviton is supported.
In July of 2023, Kong announced that package hosting was shifting from download.konghq.com to https://cloudsmith.io/~kong/repos. Read more about it in this blog post!

Installation

The quickest way to get started with Kong Gateway is using the install script:

Kong Gateway

Kong Gateway (OSS)

bash <(curl -sS https://get.konghq.com/install) -v 3.7.1.2

bash <(curl -sS https://get.konghq.com/install) -p kong -v 3.7.1

This script detects your operating system and automatically installs the correct package. It also installs a PostgreSQL database and bootstraps Kong Gateway for you.

If you’d prefer to install just the Kong Gateway package, see the Package Install section.

Verify install

Once the script completes, run the following in the same terminal window:

curl -i http://localhost:8001

You should receive a 200 status code.

Next steps

Once Kong Gateway is running, you may want to do the following:

Optional: Add your Enterprise license
Enable Kong Manager:
- Kong Manager Enterprise
- Kong Manager OSS
Create services and routes

Advanced installation

Package install

You can install Kong Gateway by downloading an installation package or using the APT repository.

The following steps install the package only, without a data store. You will need to set one up after installation.

Package

APT repository

Install Kong Gateway on Ubuntu from the command line.

Download the Kong package.

We currently package Kong Gateway for Ubuntu Focal and Jammy. The following command assumes you’re running jammy. If you are using a different release, replace jammy with $(lsb_release -sc) or the release name in the command below. To check your release name, run lsb_release -sc.

Kong Gateway

Kong Gateway (OSS)

curl -Lo kong-enterprise-edition-3.7.1.2.deb "https://packages.konghq.com/public/gateway-37/deb/ubuntu/pool/jammy/main/k/ko/kong-enterprise-edition_3.7.1.2/kong-enterprise-edition_3.7.1.2_$(dpkg --print-architecture).deb"

curl -Lo kong-3.7.1.deb "https://packages.konghq.com/public/gateway-37/deb/ubuntu/pool/jammy/main/k/ko/kong_3.7.1/kong_3.7.1_$(dpkg --print-architecture).deb"

Install the package:

Kong Gateway

Kong Gateway (OSS)

sudo apt install -y ./kong-enterprise-edition-3.7.1.2.deb

sudo apt install -y ./kong-3.7.1.deb

Install the APT repository from the command line.

Set up the Kong APT repository.

 curl -1sLf "https://packages.konghq.com/public/gateway-37/gpg.C05D9BEAEB9E8E18.key" |  gpg --dearmor | sudo tee /usr/share/keyrings/kong-gateway-37-archive-keyring.gpg > /dev/null
 curl -1sLf "https://packages.konghq.com/public/gateway-37/config.deb.txt?distro=ubuntu&codename=jammy" | sudo tee /etc/apt/sources.list.d/kong-gateway-37.list > /dev/null

Update the repository:
```
 sudo apt-get update
```

Install Kong:

Kong Gateway

Kong Gateway (OSS)

sudo apt-get install -y kong-enterprise-edition=3.7.1.2

sudo apt-get install -y kong=3.7.1

Optional: Prevent accidental upgrades by marking the package as hold:

Kong Gateway

Kong Gateway (OSS)
```
sudo apt-mark hold kong-enterprise-edition
```
```
sudo apt-mark hold kong
```

Next steps

Before starting Kong Gateway, set up a data store and update the kong.conf.default configuration property file with a reference to your data store.

Depending on your desired environment, also see the following guides:

Optional: Add your Enterprise license
Enable Kong Manager:
- Kong Manager Enterprise
- Kong Manager OSS

You can also check out Kong Gateway’s series of Getting Started guides to learn how get the most out of Kong Gateway.

Uninstall package

Stop Kong Gateway:

kong stop

Kong Gateway

Kong Gateway (OSS)

To uninstall the package, run:

sudo apt remove kong-enterprise-edition

To uninstall the package, run:

sudo apt remove kong