2015-09-12 00:01:02 +00:00
|
|
|
---
|
|
|
|
layout: "docs"
|
2015-09-17 23:33:37 +00:00
|
|
|
page_title: "Install Nomad"
|
2015-09-12 00:01:02 +00:00
|
|
|
sidebar_current: "docs-install"
|
|
|
|
description: |-
|
2015-09-17 23:33:37 +00:00
|
|
|
Learn how to install Nomad.
|
2015-09-12 00:01:02 +00:00
|
|
|
---
|
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
# Install Nomad
|
2015-09-12 00:01:02 +00:00
|
|
|
|
2015-09-17 23:33:37 +00:00
|
|
|
Installing Nomad is simple. There are two approaches to installing Nomad:
|
2015-09-12 00:01:02 +00:00
|
|
|
downloading a precompiled binary for your system, or installing from source.
|
|
|
|
|
|
|
|
Downloading a precompiled binary is easiest, and we provide downloads over
|
2015-09-19 19:10:55 +00:00
|
|
|
TLS along with SHA256 sums to verify the binary.
|
2015-09-12 00:01:02 +00:00
|
|
|
|
|
|
|
## Precompiled Binaries
|
|
|
|
|
|
|
|
To install the precompiled binary,
|
|
|
|
[download](/downloads.html) the appropriate package for your system.
|
2015-09-20 20:37:22 +00:00
|
|
|
Nomad is currently packaged as a zip file. We do not have any near term
|
2015-09-12 00:01:02 +00:00
|
|
|
plans to provide system packages.
|
|
|
|
|
|
|
|
Once the zip is downloaded, unzip it into any directory. The
|
2015-09-19 19:10:55 +00:00
|
|
|
`nomad` binary inside is all that is necessary to run Nomad (or
|
|
|
|
`nomad.exe` for Windows). Any additional files, if any, aren't
|
2015-09-17 23:33:37 +00:00
|
|
|
required to run Nomad.
|
2015-09-12 00:01:02 +00:00
|
|
|
|
|
|
|
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
|
|
|
|
|
2015-09-20 20:37:22 +00:00
|
|
|
To compile from source, you will need [Go](https://golang.org) installed
|
|
|
|
and configured properly. you will also need Git.
|
2015-09-12 00:01:02 +00:00
|
|
|
|
2015-09-19 19:10:55 +00:00
|
|
|
1. Clone the Nomad repository into your GOPATH: https://github.com/hashicorp/nomad
|
2015-09-12 00:01:02 +00:00
|
|
|
|
2015-09-19 19:10:55 +00:00
|
|
|
1. Verify that the file `$GOPATH/src/github.com/hashicorp/nomad/main.go`
|
2015-09-20 20:37:22 +00:00
|
|
|
exists. If it does not, then you did not clone Nomad into the proper
|
2015-09-12 00:01:02 +00:00
|
|
|
path.
|
|
|
|
|
2016-06-06 17:33:54 +00:00
|
|
|
1. Run `make bootstrap`. This will download and compile libraries and tools needed
|
|
|
|
to compile Nomad.
|
|
|
|
|
2015-09-19 19:10:55 +00:00
|
|
|
1. Run `make`. This will build Nomad for your current system
|
2015-09-12 00:01:02 +00:00
|
|
|
and put the binary in `bin` (relative to the git checkout).
|
|
|
|
|
|
|
|
## Verifying the Installation
|
|
|
|
|
2015-09-19 19:10:55 +00:00
|
|
|
To verify Nomad is properly installed, execute the `nomad` binary on
|
2015-09-12 00:01:02 +00:00
|
|
|
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
|
2015-09-19 19:10:55 +00:00
|
|
|
about `nomad` not being found.
|