github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Website: cleanups for intro/getting-started/install.html

pull/749/head
Ryan Breen 2015-03-02 08:31:32 -05:00
parent 3f971e694b
commit 4207a63a03
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
website/source/intro/getting-started/install.html.markdown
View File

@ -3,12 +3,12 @@ layout: "intro"
page_title: "Installing Consul" page_title: "Installing Consul"
sidebar_current: "gettingstarted-install" sidebar_current: "gettingstarted-install"
description: |- description: |-
Consul must first be installed on every node that will be a member of a Consul cluster. To make installation easy, Consul is distributed as a binary package for all supported platforms and architectures. This page will not cover how to compile Consul from source. Consul must first be installed on every node that will be a member of the Consul cluster. To make installation easy, Consul is distributed as a binary package for all supported platforms and architectures. This page will not cover how to compile Consul from source.
--- ---
# Install Consul # Install Consul
Consul must first be installed on every node that will be a member of a Consul must first be installed on every node that will be a member of the
Consul cluster. To make installation easy, Consul is distributed as a Consul cluster. To make installation easy, Consul is distributed as a
[binary package](/downloads.html) for all supported platforms and [binary package](/downloads.html) for all supported platforms and
architectures. This page will not cover how to compile Consul from architectures. This page will not cover how to compile Consul from
@ -20,22 +20,22 @@ To install Consul, find the [appropriate package](/downloads.html) for
your system and download it. Consul is packaged as a "zip" archive. your system and download it. Consul is packaged as a "zip" archive.
After downloading Consul, unzip the package. Copy the `consul` binary to After downloading Consul, unzip the package. Copy the `consul` binary to
somewhere on the PATH so that it can be executed. On Unix systems, somewhere on the `PATH` so that it can be executed. On Unix systems,
`~/bin` and `/usr/local/bin` are common installation directories, `~/bin` and `/usr/local/bin` are common installation directories,
depending on if you want to restrict the install to a single user or depending on if you want to restrict the install to a single user or
expose it to the entire system. On Windows systems, you can put it wherever expose it to the entire system. On Windows systems, you can put it
you would like. wherever you would like, as long as that location is on the `%PATH%`.
### OS X ### OS X
If you are using [homebrew](http://brew.sh/#install) as a package manager, If you are using [homebrew](http://brew.sh/#install) as a package manager,
than you can install consul as simple as: you can install consul with:
```text ```text
$ brew cask install consul $ brew cask install consul
``` ```
if you are missing the [cask plugin](http://caskroom.io/) you can install it with: if you are missing the [cask plugin](http://caskroom.io/), you can install it with:
```text ```text
$ brew install caskroom/cask/brew-cask $ brew install caskroom/cask/brew-cask
@ -45,7 +45,7 @@ $ brew install caskroom/cask/brew-cask
After installing Consul, verify the installation worked by opening a new After installing Consul, verify the installation worked by opening a new
terminal session and checking that `consul` is available. By executing terminal session and checking that `consul` is available. By executing
`consul` you should see help output similar to that below: `consul` you should see help output similar to this:
```text ```text
$ consul $ consul
@ -67,8 +67,9 @@ Available commands are:
watch Watch for changes in Consul watch Watch for changes in Consul
``` ```
If you get an error that `consul` could not be found, then your PATH If you get an error that `consul` could not be found, your `PATH`
environment variable was not setup properly. Please go back and ensure environment variable was not set up properly. Please go back and ensure
that your PATH variable contains the directory where Consul was installed. that your `PATH` variable contains the directory where Consul was
installed.
Otherwise, Consul is installed and ready to go! Otherwise, Consul is installed and ready to go!