open-nomad/website/pages/docs/install/index.mdx

72 lines
2.2 KiB
Plaintext
Raw Normal View History

2015-09-12 00:01:02 +00:00
---
layout: docs
2020-02-06 23:45:31 +00:00
page_title: Installing Nomad
sidebar_title: Installing Nomad
description: Learn how to install Nomad.
2015-09-12 00:01:02 +00:00
---
# Installing 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:
2020-02-06 23:45:31 +00:00
1. Using a [precompiled binary](#precompiled-binaries)
1. Installing [from source](#from-source)
2015-09-12 00:01:02 +00:00
Downloading a precompiled binary is easiest, and we provide downloads over
TLS along with SHA-256 sums to verify the binary.
2015-09-12 00:01:02 +00:00
2020-03-26 20:21:24 +00:00
## Precompiled Binaries ((#precompiled-binaries))
2015-09-12 00:01:02 +00:00
To install the precompiled binary,
2020-02-06 23:45:31 +00:00
[download](/downloads) the appropriate package for your system.
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
`nomad` (or `nomad.exe` for Windows) binary inside is all that is
necessary to run Nomad. Any additional files, if any, are not
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`.
2020-03-26 20:21:24 +00:00
## Compiling from Source ((#from-source))
2015-09-12 00:01:02 +00:00
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`.
2015-09-12 00:01:02 +00:00
2020-02-06 23:45:31 +00:00
1. Clone the Nomad repository from GitHub into your `GOPATH`:
2020-02-06 23:45:31 +00:00
```shell
$ mkdir -p $GOPATH/src/github.com/hashicorp && cd $_
$ git clone https://github.com/hashicorp/nomad.git
$ cd nomad
```
2015-09-12 00:01:02 +00:00
2020-02-06 23:45:31 +00:00
1. Bootstrap the project. This will download and compile libraries and tools
needed to compile Nomad:
2020-02-06 23:45:31 +00:00
```shell
$ make bootstrap
```
2020-02-06 23:45:31 +00:00
1. Build Nomad 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 `nomad` for only your local build environment (no
cross-compiled targets).
2020-02-06 23:45:31 +00:00
```shell
$ make dev
```
2015-09-12 00:01:02 +00:00
## Verifying the Installation
To verify Nomad is properly installed, run `nomad -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 `nomad` not being found.
2020-05-01 20:02:21 +00:00
```shell-sessionnomad -v
```