Skip to content

We're Hiring!
Docs
Plugin Hub
Support
Community
Kong Academy

Get a Demo Start Free Trial

Kong Gateway
Kong Konnect
Kong Mesh
Plugin Hub
decK
Kubernetes Ingress Controller
Insomnia
Kuma

Docs contribution guidelines

3.2.x (latest)
3.1.x
3.0.x
2.8.x
2.7.x
2.6.x
Older Enterprise versions (2.1-2.5)
Older OSS versions (2.1-2.5)
Archive (pre-2.1)

Introduction
- Overview of Kong Gateway
- Support
- Stability
- Release Notes
- Key Concepts
  - Services
  - Routes
    
    Overview
    
    Configure Routes with Expressions
  - Upstreams
  - Plugins
- How Kong Works
- Glossary

Get Started with Kong

Kong in Production
- Deployment Topologies
  - Overview
  - Hybrid Mode
    
    Overview
    
    Deploy Kong Gateway in Hybrid mode
  - DB-less Deployment
  - Traditional
- Installation Options
  - Overview
  - Kubernetes
    
    Helm
    
    OpenShift with Helm
    
    kubectl apply
    
    Kubernetes Deployment Options
  - Docker
    
    Using docker run
    
    Build your own Docker images
  - Linux
    
    Amazon Linux
    
    Debian
    
    Red Hat
    
    Ubuntu
- Running Kong
- Access Control
- Licenses
- Networking
- Kong Configuration File
- Environment Variables
- Serving a Website and APIs from Kong
- Monitoring
  - Overview
  - Prometheus
  - StatsD
  - Datadog
- Tracing
- Resource Sizing Guidelines
- Security Update Process
- Blue-Green Deployments
- Canary Deployments
- Clustering Reference
- Logging
- Upgrade and Migration
  - Upgrade Kong Gateway 3.x.x
  - Migrate from OSS to Enterprise

Kong Enterprise
- Overview
- Kong Vitals
- Secrets Management
  - Overview
  - Getting Started
  - Advanced Usage
  - Backends
    
    Overview
    
    Environment Variables
    
    AWS Secrets Manager
    
    Google Secrets Manager
    
    Hashicorp Vault
  - How-To
    
    Securing the Database with AWS Secrets Manager
  - Reference Format
- Dynamic Plugin Ordering
  - Overview
  - Get Started with Dynamic Plugin Ordering
- Dev Portal
  - Overview
  - Enable the Dev Portal
  - Publish an OpenAPI Spec
  - Structure and File Types
  - Themes Files
  - Working with Templates
  - Using the Editor
  - Authentication and Authorization
    
    Basic Auth
    
    Key Auth
    
    OIDC
    
    Sessions
    
    Adding Custom Registration Fields
    
    Manage Developers
    
    Developer Roles and Content Permissions
  - Application Registration
    
    Authorization Provider Strategy
    
    Enable Application Registration
    
    Enable Key Authentication for Application Registration
    
    Enable External Authentication
    
    External OAuth2 Support
    
    Set up Okta and Kong for External Oauth
    
    Set up Azure AD and Kong for External Authentication
    
    Manage Applications
  - Customize Dev Portal
    
    Theme Editing
    
    Migrating Templates Between Workspaces
    
    Markdown Rendering Module
    
    Customizing Portal Emails
    
    Adding and Using JavaScript Assets
    
    Single Page App in Dev Portal
    
    Alternate OpenAPI Renderer
  - SMTP
  - Workspaces
  - Helpers CLI
  - Portal API Documentation
- Audit Logging
- Keyring and Data Encryption
- Workspaces
- Consumer Groups
- Event Hooks
- Configure Data Plane Resilience
- About Control Plane Outage Management
- FIPS 140-2

Kong Manager
- Overview
- Enable Kong Manager
- Get Started with Kong Manager
- Authentication and Authorization
  - Overview
  - Create a Super Admin
  - Workspaces and Teams
  - Reset Passwords and RBAC Tokens
  - Basic Auth
  - LDAP
    
    Configure LDAP
    
    LDAP Service Directory Mapping
  - OIDC
    
    Configure OIDC
    
    OIDC Authenticated Group Mapping
  - Sessions
  - RBAC
    
    Overview
    
    Enable RBAC
    
    Add a Role and Permissions
    
    Create a User
    
    Create an Admin
- Networking Configuration
- Workspaces
- Create Consumer Groups
- Sending Email

Develop Custom Plugins
- Overview
- File Structure
- Implementing Custom Logic
- Plugin Configuration
- Accessing the Data Store
- Storing Custom Entities
- Caching Custom Entities
- Extending the Admin API
- Writing Tests
- (un)Installing your Plugin
- Plugin Development Kit
- Plugins in Other Languages

Kong Plugins
- Overview
- Authentication
  - Open ID Connect Plugin
    
    Overview
    
    OpenID Connect with Curity
    
    OpenID Connect with Azure AD
    
    OpenID Connect with Google
    
    OpenID Connect with Okta
    
    OpenID Connect with Auth0
    
    OpenID Connect with Cognito
  - Authentication Reference
  - Allow Multiple Authentication Plugins
- Rate Limiting Plugin
- Request Transformer
  - Add a Body Value
- GraphQL
- gRPC
  - gRPC Plugins
  - Configure a gRPC service

Admin API
- Overview
- Information Routes
- Health Routes
- Tags
- Debug Routes
- Services
- Routes
- Consumers
- Plugins
- Certificates
- CA Certificates
- SNIs
- Upstreams
- Targets
- Vaults
- Keys
- Licenses
- Workspaces
- RBAC
- Admins
- Developers
- Consumer Groups
- Event Hooks
- Keyring and Data Encryption
- Audit Logs

Reference

report-issue Report an issue

enterprise-switcher-icon Switch to OSS

Packages
Kubernetes
Docker

Kong Gateway

3.2.x (latest)

Home
Kong Gateway
Install
Installation Options

Installation Options

Kong can be installed on many different systems. From bare metal, to virtual machines, and cloud native Kubernetes environments, Kong is a low-demand, high-performing API gateway.

Packages

Kubernetes

Kubernetes (YAML Manifests)

Kubernetes (Helm)

Docker

Debian (bullseye-slim)

Thank you for your feedback.

Was this page useful?

THE CLOUD CONNECTIVITY COMPANY

Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.
- Company
- Customers
- Events
- Investors
- Careers Hiring!
- Partners
- Press
- Contact
Products
Resources
- eBooks
- Webinars
- Briefs
- Blog
- API Gateway
- Microservices
Open Source
Solutions

Terms•Privacy

© Kong Inc. 2023