Install Waypoint

5min
Waypoint

Waypoint uses both a client and a server to build, deploy, and release applications. This functionality is all available from a single binary.

Get Waypoint by downloading a pre-compiled waypoint binary or compiling it from source.

To install Waypoint, find the appropriate package for your system and download it as a zip archive.

After downloading Waypoint, unzip the package. Waypoint runs as a single binary named waypoint. Any other files in the package can be safely removed and Waypoint will still function.

Finally, make sure that the waypoint binary is available on your PATH. This process will differ depending on your operating system.

Print a colon-separated list of locations in your PATH.

$ echo $PATH

Move the Waypoint binary to one of the listed locations. This command assumes that the binary is currently in your downloads folder and that your PATH includes /usr/local/bin, but you can customize it if your locations are different.

$ mv ~/Downloads/waypoint /usr/local/bin/

For more detail about adding binaries to your path, see this Stack Overflow article.

Homebrew is a free and open-source package management system for Mac OS X. Install the official Waypoint formula from the terminal.

$ brew tap hashicorp/tap

Then install Waypoint.

$ brew install hashicorp/tap/waypoint

Note

This installs a signed binary and is automatically updated with every new official release.

To update to the latest, run

$ brew upgrade hashicorp/tap/waypoint

Scoop is a free and open-source package management system for Windows. Install Waypoint from the command-line.

$ scoop install waypoint

Note

The Scoop main bucket repository is NOT maintained by HashiCorp. The latest version of Waypoint is always available by manual installation.

HashiCorp officially maintains and signs packages for the following Linux distributions.

Add the HashiCorp GPG key.

$ curl -fsSL https://apt.releases.hashicorp.com/gpg | sudo apt-key add -

Add the official HashiCorp Linux repository.

$ sudo apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main"

Update and install.

$ sudo apt-get update && sudo apt-get install waypoint

Install yum-config-manager to manage your repositories.

$ sudo yum install -y yum-utils

Use yum-config-manager to add the official HashiCorp Linux repository.

$ sudo yum-config-manager --add-repo https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo

Install.

$ sudo yum -y install waypoint

Install dnf config-manager to manage your repositories.

$ sudo dnf install -y dnf-plugins-core

Use dnf config-manager to add the official HashiCorp Linux repository.

$ sudo dnf config-manager --add-repo https://rpm.releases.hashicorp.com/fedora/hashicorp.repo

Install.

$ sudo dnf -y install waypoint

Install yum-config-manager to manage your repositories.

$ sudo yum install -y yum-utils

Use yum-config-manager to add the official HashiCorp Linux repository.

$ sudo yum-config-manager --add-repo https://rpm.releases.hashicorp.com/AmazonLinux/hashicorp.repo

Install.

$ sudo yum -y install waypoint

Tip

Now that you have added the HashiCorp repository, you can install Terraform, Vault, Consul, Nomad and Packer with the same command.

One of the functions of the install task is that it creates a context that points to the newly created server with the appropriate authentication. This is how Waypoint knows the address of the server when you run other Waypoint commands.

Validate the installation

Validate the installation by running the waypoint command.

$ waypoint
Usage: waypoint [-version] [-help] [-autocomplete-(un)install] <command> [args]

Common commands:
    release      Release a deployment.
    up           Perform the build, deploy, and release steps for the app.
    build        Build a new versioned artifact from source.
...

5 tutorials

Get Started - Kubernetes
Build, deploy, and release applications to a Kubernetes cluster.
- Waypoint
5 tutorials

Get Started - Docker
Start using Waypoint in only a few minutes on a local Docker instance.
- Waypoint

Validate the installation

This tutorial also appears in: