github.com/mattyr/nomad@v0.3.3-0.20160919021406-3485a065154a/website/source/docs/install/index.html.md (about) 1 --- 2 layout: "docs" 3 page_title: "Install Nomad" 4 sidebar_current: "docs-install" 5 description: |- 6 Learn how to install Nomad. 7 --- 8 9 # Install Nomad 10 11 Installing Nomad is simple. There are two approaches to installing Nomad: 12 downloading a precompiled binary for your system, or installing from source. 13 14 Downloading a precompiled binary is easiest, and we provide downloads over 15 TLS along with SHA256 sums to verify the binary. 16 17 ## Precompiled Binaries 18 19 To install the precompiled binary, 20 [download](/downloads.html) the appropriate package for your system. 21 Nomad is currently packaged as a zip file. We do not have any near term 22 plans to provide system packages. 23 24 Once the zip is downloaded, unzip it into any directory. The 25 `nomad` binary inside is all that is necessary to run Nomad (or 26 `nomad.exe` for Windows). Any additional files, if any, aren't 27 required to run Nomad. 28 29 Copy the binary to anywhere on your system. If you intend to access it 30 from the command-line, make sure to place it somewhere on your `PATH`. 31 32 ## Compiling from Source 33 34 To compile from source, you will need [Go](https://golang.org) installed and 35 configured properly (including a `GOPATH` environment variable set), as well 36 as a copy of [`git`](https://www.git-scm.com/) in your `PATH`. 37 38 1. Clone the Nomad repository into your `GOPATH`: `mkdir -p $GOPATH/src/github.com/hashicorp && cd $GOPATH/src/github.com/hashicorp && git clone https://github.com/hashicorp/nomad.git && cd nomad` 39 40 1. Run `make bootstrap`. This will download and compile libraries and tools needed 41 to compile Nomad. 42 43 1. Run `make dev`. This will build Nomad for your current system and put 44 the binary in `./bin/` (relative to the git checkout). The `make dev` 45 target is just a shortcut that builds `nomad` for only your local build 46 environment (no cross-compiled targets). If you would like to 47 cross-compile Nomad for different platforms, just run `make`. 48 49 1. Run `make install`. This will install `./bin/nomad` into 50 `/usr/local/bin/nomad`. 51 52 ## Verifying the Installation 53 54 To verify Nomad is properly installed, execute the `nomad` binary on 55 your system. You should see help output. If you are executing it from 56 the command line, make sure it is on your `PATH` or you may get an error 57 about `nomad` not being found.