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

84 lines
2.8 KiB
Plaintext
Raw Normal View History

2017-04-04 16:40:53 +00:00
---
2020-04-07 18:55:19 +00:00
layout: docs
page_title: Install Consul
sidebar_title: Installing Consul
2017-04-04 16:40:53 +00:00
description: |-
2019-12-19 02:02:26 +00:00
Installing Consul is simple. You can download a precompiled binary, compile
from source or run on Kubernetes. This page details these methods.
2017-04-04 16:40:53 +00:00
---
# Install Consul
2019-12-19 02:02:26 +00:00
Installing Consul is simple. There are three approaches to installing Consul:
2017-04-04 16:40:53 +00:00
1. Using a [precompiled binary](#precompiled-binaries)
1. Installing [from source](#compiling-from-source)
2020-04-09 23:46:54 +00:00
1. Installing [on Kubernetes](/docs/platform/k8s/run)
2019-12-19 02:02:26 +00:00
2017-04-04 16:40:53 +00:00
Downloading a precompiled binary is easiest, and we provide downloads over TLS
along with SHA256 sums to verify the binary. We also distribute a PGP signature
with the SHA256 sums that can be verified.
The [Getting Started guides](https://learn.hashicorp.com/tutorials/consul/get-started-install?utm_source=consul.io&utm_medium=docs) provide a quick walkthrough of installing and using Consul on your local machine.
2017-04-04 16:40:53 +00:00
## Precompiled Binaries
2020-04-09 23:46:54 +00:00
To install the precompiled binary, [download](/downloads) the appropriate
2017-04-04 16:40:53 +00:00
package for your system. Consul is currently packaged as a zip file. We do not
have any near term plans to provide system packages.
Once the zip is downloaded, unzip it into any directory. The `consul` binary
inside is all that is necessary to run Consul (or `consul.exe` for Windows). Any
additional files, if any, aren't required to run Consul.
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`.
## Compiling from Source
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`.
2020-04-06 20:27:35 +00:00
1. Clone the Consul repository from GitHub into your `GOPATH`:
2020-04-07 23:56:08 +00:00
```shell
$ mkdir -p $GOPATH/src/github.com/hashicorp && cd !$
$ git clone https://github.com/hashicorp/consul.git
$ cd consul
```
2017-04-04 16:40:53 +00:00
2020-04-06 20:27:35 +00:00
1. Bootstrap the project. This will download and compile libraries and tools
needed to compile Consul:
2020-04-07 23:56:08 +00:00
```shell
$ make tools
```
2017-04-04 16:40:53 +00:00
2020-04-06 20:27:35 +00:00
1. Build Consul 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 `consul` for only your local build environment (no cross-compiled
targets).
2020-04-07 23:56:08 +00:00
```shell
$ make dev
```
2017-04-04 16:40:53 +00:00
## Verifying the Installation
To verify Consul is properly installed, run `consul -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 Consul not being found.
2020-05-19 18:32:38 +00:00
```shell-session
2017-04-04 16:40:53 +00:00
$ consul -v
```
## Browser Compatibility Considerations
Consul currently supports all 'evergreen' browsers, as they are generally on
up-to-date versions. For more information on supported browsers, please see our
[FAQ](/faq.mdx)