luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

website: cleanup install docs

Browse source
This commit is contained in:
Armon Dadgar 2015-09-19 12:10:55 -07:00
parent d31202a7ad
commit d0cc32db8b
1 changed files with 8 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
website/source/docs/install/index.html.md
View file

@ -12,15 +12,7 @@ Installing Nomad is simple. There are two approaches to installing Nomad:
downloading a precompiled binary for your system, or installing from source. downloading a precompiled binary for your system, or installing from source.
Downloading a precompiled binary is easiest, and we provide downloads over Downloading a precompiled binary is easiest, and we provide downloads over
TLS along with SHA256 sums to verify the binary is what we say it is. We TLS along with SHA256 sums to verify the binary.
also distribute a PGP signature with the SHA256 sums that can be verified.
However, we use a 3rd party storage host, and some people feel that
due to the importance of security with Nomad, they'd rather compile it
from source.
For this reason, we also document on this page how to compile Nomad
from source, from the same versions of all dependent libraries that
we used for the official builds.
## Precompiled Binaries ## Precompiled Binaries
@ -30,8 +22,8 @@ Nomad is currently packaged as a zip file. We don't have any near term
plans to provide system packages. plans to provide system packages.
Once the zip is downloaded, unzip it into any directory. The Once the zip is downloaded, unzip it into any directory. The
`vault` binary inside is all that is necessary to run Nomad (or `nomad` binary inside is all that is necessary to run Nomad (or
`vault.exe` for Windows). Any additional files, if any, aren't `nomad.exe` for Windows). Any additional files, if any, aren't
required to run Nomad. required to run Nomad.
Copy the binary to anywhere on your system. If you intend to access it Copy the binary to anywhere on your system. If you intend to access it
@ -42,22 +34,18 @@ from the command-line, make sure to place it somewhere on your `PATH`.
To compile from source, you'll need [Go](https://golang.org) installed To compile from source, you'll need [Go](https://golang.org) installed
and configured properly. You'll also need Git. and configured properly. You'll also need Git.
1. Clone the Nomad repository into your GOPATH: https://github.com/hashicorp/vault 1. Clone the Nomad repository into your GOPATH: https://github.com/hashicorp/nomad
1. Verify that the file `$GOPATH/src/github.com/hashicorp/vault/main.go` 1. Verify that the file `$GOPATH/src/github.com/hashicorp/nomad/main.go`
exists. If it doesn't, then you didn't clone Nomad into the proper exists. If it doesn't, then you didn't clone Nomad into the proper
path. path.
1. Run `make dev`. This will build Nomad for your current system 1. Run `make`. This will build Nomad for your current system
and put the binary in `bin` (relative to the git checkout). and put the binary in `bin` (relative to the git checkout).
~> **Note:** All the dependencies of Nomad are vendored and the command
above will use these vendored binaries. This is to avoid malicious
upstream dependencies if possible.
## Verifying the Installation ## Verifying the Installation
To verify Nomad is properly installed, execute the `vault` binary on To verify Nomad is properly installed, execute the `nomad` binary on
your system. You should see help output. If you are executing it from 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 the command line, make sure it is on your PATH or you may get an error
about `vault` not being found. about `nomad` not being found.