open-consul/website/source/intro/getting-started/install.html.markdown

54 lines
2.0 KiB
Markdown
Raw Normal View History

2014-02-08 00:41:03 +00:00
---
layout: "intro"
page_title: "Installing Consul"
2014-02-08 00:41:03 +00:00
sidebar_current: "gettingstarted-install"
---
# Install Consul
2014-02-08 00:41:03 +00:00
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
2014-02-08 00:41:03 +00:00
[binary package](/downloads.html) for all supported platforms and
architectures. This page will not cover how to compile Consul from
2014-02-08 00:41:03 +00:00
source.
## Installing Consul
2014-02-08 00:41:03 +00:00
To install Consul, find the [appropriate package](/downloads.html) for
your system and download it. Consul is packaged as a "zip" archive.
2014-02-08 00:41:03 +00:00
After downloading Consul, unzip the package. Copy the `consul` binary to
2014-02-08 00:41:03 +00:00
somewhere on the PATH so that it can be executed. On Unix systems,
`~/bin` and `/usr/local/bin` are common installation directories,
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
you would like.
## Verifying the Installation
After installing Consul, verify the installation worked by opening a new
terminal session and checking that `consul` is available. By executing
`consul` you should see help output similar to that below:
2014-02-08 00:41:03 +00:00
```
$ consul
usage: consul [--version] [--help] <command> [<args>]
2014-02-08 00:41:03 +00:00
Available commands are:
agent Runs a Consul agent
2014-02-08 00:41:03 +00:00
force-leave Forces a member of the cluster to enter the "left" state
info Provides debugging information for operators
join Tell Consul agent to join cluster
2014-02-08 00:41:03 +00:00
keygen Generates a new encryption key
leave Gracefully leaves the Consul cluster and shuts down
members Lists the members of a Consul cluster
monitor Stream logs from a Consul agent
version Prints the Consul version
2014-02-08 00:41:03 +00:00
```
If you get an error that `consul` could not be found, then your PATH
2014-02-08 00:41:03 +00:00
environmental variable was not setup properly. Please go back and ensure
that your PATH variable contains the directory where Consul was installed.
2014-02-08 00:41:03 +00:00
Otherwise, Consul is installed and ready to go!