layout | page_title | description |
---|---|---|
docs |
Install Consul |
Install Consul to get started with service discovery and service mesh. Follow the installation instructions to download the precompiled binary, or use Go to compile from source. |
Installing Consul is simple. There are three approaches to installing Consul:
-
Using a precompiled binary
-
Installing from source
-
Installing on Kubernetes
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 Get Started on VMs tutorials provide a quick walkthrough of installing and using Consul on a VM.
To install the precompiled binary, download the appropriate 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).
No additional files are 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
.
To compile from source, you will need Go installed and
a copy of git
in your PATH
.
-
Clone the Consul repository from GitHub:
$ git clone https://github.com/hashicorp/consul.git $ cd consul
-
Build Consul for your target system. The binary will be placed in
./bin
(relative to the git checkout).$ make dev
Specify your target system by setting the following environment variables before building:
GOOS
: Target operating system. Valid values include:linux
,darwin
,windows
,solaris
,freebsd
.GOARCH
: Target architecture. Valid values include:386
,amd64
,arm
,arm64
$ export GOOS=linux GOARCH=amd64 $ make dev
To verify Consul is properly installed, run consul version
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.
$ consul version
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