Skip to content
Kong Gateway 2.8 Increases Security and Simplifies API Management.  —Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Konnect Cloud
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Kong Konnect Platform

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Request Demo
  • Kong Gateway
  • Konnect Cloud
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Kong Konnect Platform

  • Docs contribution guidelines
  • 1.12.x (latest)
  • 1.11.x
  • 1.10.x
  • 1.9.x
  • 1.8.x
  • 1.7.x
  • pre-1.7
    • Terminology
    • Architecture
    • Compatibility Promise
    • Getting Started with decK
    • Backup and Restore
    • Configuration as Code and GitOps
    • Distributed Configuration
    • Best Practices
    • Using decK with Kong Gateway (Enterprise)
    • Using Multiple Files to Store Configuration
    • De-duplicate Plugin Configuration
    • Set Up Object Defaults
    • Using environment variables with decK
    • deck completion
    • deck convert
    • deck diff
    • deck dump
    • deck ping
    • deck reset
    • deck sync
    • deck validate
    • deck version
    • deck konnect
    • deck konnect diff
    • deck konnect dump
    • deck konnect ping
    • deck konnect sync

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Prerequisites
  • macOS
  • Linux
  • Docker image
decK
1.10.x
  • Open Source
  • decK
You are browsing documentation for an outdated version. See the latest documentation here.

Installation

decK is entirely written in Go. The build process builds a single static binary, which makes it easy and convenient to install decK.

Prerequisites

You have installed Kong Gateway (OSS) >= 1.x or Kong Gateway >= 0.35.

You can follow along installation instructions based on your Operating System (OS):

macOS

If you are on macOS, install decK using brew:

$ brew tap kong/deck
$ brew install deck

Linux

If you are Linux, you can either use the Debian or RPM archive from the Github release page or install by downloading a compressed archive, which contains the binary:

$ curl -sL https://github.com/kong/deck/releases/download/v1.10.0/deck_1.10.0_linux_amd64.tar.gz -o deck.tar.gz
$ tar -xf deck.tar.gz -C /tmp
$ sudo cp /tmp/deck /usr/local/bin/

Docker image

If your workflow requires a Docker image, then you can use kong/deck Docker image from the official Docker hub:

docker pull kong/deck

You will have to mount the state files into the container as volumes so that decK can read the files during diff/sync procedures.

If you’re integrating decK into your CI system, you can either install decK into the system itself, use the Docker based environment, or pull the binaries hosted on Github in each job.

Thank you for your feedback.
Was this page useful?
  • Kong
    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
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2022