Merge pull request #6364 from hashicorp/do_6354

we should only have an installation guide in one place, to keep it up…
This commit is contained in:
M. Marsh 2018-06-11 12:04:15 -07:00 committed by GitHub
commit 9d97365522
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 45 additions and 66 deletions

View File

@ -9,58 +9,5 @@ sidebar_current: 'docs-install'
# Install Packer
Installing Packer is simple. There are two approaches to installing Packer:
1. Using a [precompiled binary](#precompiled-binaries)
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` before /usr/sbin.
## 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`.
1. Clone the Packer repository from GitHub into your `GOPATH`:
``` shell
$ mkdir -p $GOPATH/src/github.com/hashicorp && cd $_
$ git clone https://github.com/hashicorp/packer.git
$ cd packer
```
2. Build Packer for your current system and put the
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).
``` 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.
``` shell
$ packer -v
```
For detailed instructions on how to install Packer, see [this page](/intro/getting-started/install.html) in our
getting-started guide.

View File

@ -10,24 +10,33 @@ description: |-
advanced users.
---
# Install Packer
# Install Options
Packer must first be installed on the machine you want to run it on. To make
installation easier, Packer is distributed as a [binary package](/downloads.html)
for all supported platforms and architectures. This page will not cover how to
compile Packer from source, as that is covered in the
[README](https://github.com/hashicorp/packer/blob/master/README.md) and is only
recommended for advanced users.
Packer may be installed in the following ways:
## Installing Packer
1. Using a [precompiled binary](#precompiled-binaries); We release binaries
for all supported platforms and architectures. This method is recommended for
most users.
To install packer, first find the [appropriate package](/downloads.html) for
your system and download it. Packer is packaged as a "zip" file.
2. Installing [from source](#compiling-from-source) This method is only
recommended for advanced users.
3. An unoffical [alternative installation method](#alternative-installation-methods)
## 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.
Next, unzip the downloaded package into a directory where Packer will be
installed. On Unix systems, `~/packer` or `/usr/local/packer` is generally good,
depending on whether you want to restrict the install to just your user or
install it system-wide. On Windows systems, you can put it wherever you'd like.
install it system-wide. If you intend to access it from the command-line, make
sure to place it somewhere on your `PATH` before `/usr/sbin`. On Windows
systems, you can put it wherever you'd like. The `packer` (or `packer.exe` for
Windows) binary inside is all that is necessary to run Packer. Any additional
files aren't required to run Packer.
After unzipping the package, the directory should contain a single binary
program called `packer`. The final step to
@ -38,6 +47,29 @@ for instructions on setting the PATH on Linux and Mac. [This
page](https://stackoverflow.com/questions/1618280/where-can-i-set-path-to-make-exe-on-windows)
contains instructions for setting the PATH on Windows.
## Compiling from Source
To compile from source, you will need [Go](https://golang.org) installed and
configured properly as well as a copy of [`git`](https://www.git-scm.com/)
in your `PATH`.
1. Clone the Packer repository from GitHub into your `GOPATH`:
``` shell
$ mkdir -p $(go enc GOPATH)/src/github.com/hashicorp && cd $_
$ git clone https://github.com/hashicorp/packer.git
$ cd packer
```
2. Build Packer for your current system and put the
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).
``` shell
$ make dev
```
## Verifying the Installation
After installing Packer, verify the installation worked by opening a new command