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