Installing Envoy¶

The Envoy project provides a number of pre-built Docker images for both amd64 and arm64 architectures.

The Get Envoy project also maintains a number of binaries and repositories to accommodate many popular distributions.

If you are installing on Mac OSX, you can install natively with brew.

Once you have installed Envoy, check out the quick start guide for more information on getting your Envoy proxy up and running.

Install Envoy on Debian GNU/Linux¶

You can install Envoy on Debian using Get Envoy.

$ sudo apt update
$ sudo apt install apt-transport-https ca-certificates curl gnupg2 software-properties-common
$ curl -sL 'https://getenvoy.io/gpg' | sudo apt-key add -
$ # verify the key
$ apt-key fingerprint 6FF974DB | grep "5270 CEAC"
$ sudo add-apt-repository "deb [arch=amd64] https://dl.bintray.com/tetrate/getenvoy-deb $(lsb_release -cs) stable"
$ sudo apt update
$ sudo apt install getenvoy-envoy

Tip

To add the nightly repository instead, replace the word stable with nightly, when adding the apt repository.

Install Envoy on Ubuntu Linux¶

You can install Envoy on Ubuntu using Get Envoy.

$ sudo apt update
$ sudo apt install apt-transport-https ca-certificates curl gnupg-agent software-properties-common
$ curl -sL 'https://getenvoy.io/gpg' | sudo apt-key add -
$ # verify the key
$ apt-key fingerprint 6FF974DB | grep "5270 CEAC"
$ sudo add-apt-repository "deb [arch=amd64] https://dl.bintray.com/tetrate/getenvoy-deb $(lsb_release -cs) stable"
$ sudo apt update
$ sudo apt install -y getenvoy-envoy

Tip

To add the nightly repository instead, replace the word stable with nightly, when adding the apt repository.

Install Envoy on CentOS Linux¶

You can install Envoy on CentOS using Get Envoy.

$ sudo yum install yum-utils
$ sudo yum-config-manager --add-repo https://getenvoy.io/linux/centos/tetrate-getenvoy.repo
$ sudo yum install getenvoy-envoy

Tip

You can enable/disable nightly using yum-config-manager:

$ sudo yum-config-manager --enable tetrate-getenvoy-nightly
$ sudo yum-config-manager --disable tetrate-getenvoy-nightly

Install Envoy on Redhat Enterprise Linux (RHEL)¶

You can install Envoy on Redhat Enterprise Linux (RHEL) using Get Envoy.

$ sudo yum install yum-utils
$ sudo yum-config-manager --add-repo https://getenvoy.io/linux/rhel/tetrate-getenvoy.repo
$ sudo yum install getenvoy-envoy

Tip

You can enable/disable nightly using yum-config-manager:

$ sudo yum-config-manager --enable tetrate-getenvoy-nightly
$ sudo yum-config-manager --disable tetrate-getenvoy-nightly

Install Envoy on Mac OSX¶

You can install Envoy on Mac OSX using the official brew repositories, or from Get Envoy.

$ brew update
$ brew install envoy

$ brew tap tetratelabs/getenvoy
$ brew install envoy

Tip

You can install the nightly version from Get Envoy by adding the --HEAD flag to the install command.

Install Envoy on Windows¶

You can run Envoy using the official Windows development Docker image.

$ docker pull envoyproxy/envoy-windows-dev:latest
$ docker run --rm envoyproxy/envoy-windows-dev:latest --version

Install Envoy using Docker¶

You can run Envoy using the official Docker images, or by using images provided by Get Envoy.

The following commands will pull and show the Envoy version of current images.

$ docker pull envoyproxy/envoy:v1.18.3
$ docker run --rm envoyproxy/envoy:v1.18.3 --version

$ docker pull getenvoy/envoy:stable
$ docker run --rm getenvoy/envoy:stable --version

Tip

To use the nightly version from Get Envoy replace the word stable with nightly in the above commands.

Pre-built Envoy Docker images¶

The following table shows the available Docker images

		stable	stable	main	main
Docker image	Description	amd64	arm64	amd64	arm64
envoyproxy/envoy	Release binary with symbols stripped on top of an Ubuntu Bionic base.	v1.18-latest	v1.18-latest
envoyproxy/envoy-alpine	Release binary with symbols stripped on top of a glibc alpine base.	v1.18-latest
envoyproxy/envoy-debug	Release binary with debug symbols on top of an Ubuntu Bionic base.	v1.18-latest	v1.18-latest
envoyproxy/envoy-dev	Release binary with symbols stripped on top of an Ubuntu Bionic base.			latest	latest
envoyproxy/envoy-alpine-dev	Release binary with symbols stripped on top of a glibc alpine base.			latest
envoyproxy/envoy-debug-dev	Release binary with debug symbols on top of an Ubuntu Bionic base.			latest	latest
envoyproxy/envoy-windows-dev	Release binary with symbols stripped on top of a Windows 1809 base.			latest
envoyproxy/envoy-build-ubuntu	Build image which includes tools for building multi-arch Envoy and containers.			See Docker Hub	See Docker Hub

Note

In the above repositories, we tag a vX.Y-latest image for each security/stable release line.

In the above dev repositories, the latest tag points to a container including the last Envoy build on main that passed tests.

The Envoy project considers main to be release candidate quality at all times, and many organizations track and deploy main in production. We encourage you to do the same so that issues can be reported as early as possible in the development process.

The envoy-build-ubuntu image does not contain a working Envoy server, but can be used for building Envoy and related containers. This image requires 4-5GB of available disk space to use.