packer-cn/website/source/docs/install/index.html.md

67 lines
2.2 KiB
Markdown
Raw Normal View History

---
2017-06-14 21:04:16 -04:00
description: |
Installing Packer is simple. You can download a precompiled binary or compile
from source. This page details both methods.
layout: docs
page_title: Install
2017-06-14 21:04:16 -04:00
sidebar_current: 'docs-install'
---
# Install Packer
Installing Packer is simple. There are two approaches to installing Packer:
2017-06-14 21:04:16 -04:00
1. Using a [precompiled binary](#precompiled-binaries)
2017-06-14 21:04:16 -04:00
2. Installing [from source](#compiling-from-source)
Downloading a precompiled binary is easiest, and we provide downloads over TLS
along with SHA256 sums to verify the binary. We also distribute a PGP signature
with the SHA256 sums that can be verified.
## Precompiled Binaries
To install the precompiled binary, [download](/downloads.html) the appropriate
package for your system. Packer is currently packaged as a zip file. We do not
have any near term plans to provide system packages.
Once the zip is downloaded, unzip it into any directory. The `packer` binary
inside is all that is necessary to run Packer (or `packer.exe` for Windows). Any
additional files, if any, aren't required to run Packer.
Copy the binary to anywhere on your system. If you intend to access it from the
command-line, make sure to place it somewhere on your `PATH`.
## Compiling from Source
To compile from source, you will need [Go](https://golang.org) installed and
configured properly (including a `GOPATH` environment variable set), as well
as a copy of [`git`](https://www.git-scm.com/) in your `PATH`.
2017-06-14 21:04:16 -04:00
1. Clone the Packer repository from GitHub into your `GOPATH`:
2017-06-14 21:04:16 -04:00
``` shell
2017-06-28 21:54:47 -04:00
$ mkdir -p $GOPATH/src/github.com/hashicorp && cd $_
$ git clone https://github.com/hashicorp/packer.git
$ cd packer
```
2017-06-28 21:54:47 -04:00
2. Build Packer for your current system and put the
2017-06-14 21:04:16 -04:00
binary in `./bin/` (relative to the git checkout). The `make dev` target is
just a shortcut that builds `packer` for only your local build environment (no
cross-compiled targets).
2017-06-14 21:04:16 -04:00
``` shell
$ make dev
```
## Verifying the Installation
To verify Packer is properly installed, run `packer -v` on your system. You
should see help output. If you are executing it from the command line, make sure
it is on your PATH or you may get an error about Packer not being found.
2017-06-14 21:04:16 -04:00
``` shell
$ packer -v
```