Consul is a tool for service discovery, monitoring and configuration.
Go HTML CSS JavaScript Shell HCL Other
Latest commit 03fcbe9 Jan 18, 2017 @slackpad slackpad committed on GitHub Update
Failed to load latest commit information.
acl Adds support to the ACL package for agent policies. Dec 14, 2016
api Adds catalog support for node IDs. Jan 18, 2017
bench Gets benchmarks running again and does a rough pass for 0.7.1. Nov 29, 2016
command Adds catalog support for node IDs. Jan 18, 2017
consul Merge pull request #2661 from hashicorp/f-node-id Jan 19, 2017
contrib Merge pull request #1863 from mssola/bash-completion Jul 5, 2016
demo/vagrant-cluster Demo: configurable Consul version Jan 13, 2017
lib Adds basic support for node IDs. Jan 18, 2017
logger Moves logger setup into its own package. (#2471) Nov 4, 2016
scripts Adjusts path for injected GIT_* variables. Nov 9, 2016
snapshot Adjusts location of archive test fixtures. Nov 4, 2016
terraform Merge pull request #2612 from amiryal/patch-2 Jan 5, 2017
test Adds support for snapshots and restores. (#2396) Oct 26, 2016
testutil Omit empty node_meta Jan 18, 2017
tlsutil Upgrades to Go 1.7 and fixes vet finding and TLS behavior change. (#2281 Nov 8, 2016
types Adds basic support for node IDs. Jan 18, 2017
ui UI: add notification for disabled JavaScript Jan 5, 2017
vendor Update `hashicorp/go-sockaddr` to account for `tun(4)` interfaces. Jan 17, 2017
version Puts the tree in 0.7.3 dev mode. Dec 19, 2016
watch Moves stale code to same spot and adds it everywhere that supports it. Aug 10, 2016
website Fixes a paste-o in the docs. Jan 19, 2017
.gitignore Use gox for building Oct 22, 2015
.travis.yml Upgrades to Go 1.7 and fixes vet finding and TLS behavior change. (#2281 Nov 8, 2016 Update Jan 19, 2017
GNUmakefile Runs the static asset packaging inside the container; updates assets. Nov 8, 2016 Revise issue template to include a hint to use a gist Apr 29, 2016
LICENSE Initial commit Nov 4, 2013 Upgrades to Go 1.7 and fixes vet finding and TLS behavior change. (#2281 Nov 8, 2016
commands.go cli: Add KV `export` and `import` Jan 5, 2017
main.go Always seed math/rand on consul startup Jan 30, 2016
main_test.go Adding basic CLI infrastructure Dec 19, 2013
make.bat Removes the integration test runner, there weren't any tests using it. Oct 26, 2015

Consul Build Status Join the chat at

Consul is a tool for service discovery and configuration. Consul is distributed, highly available, and extremely scalable.

Consul provides several key features:

  • Service Discovery - Consul makes it simple for services to register themselves and to discover other services via a DNS or HTTP interface. External services such as SaaS providers can be registered as well.

  • Health Checking - Health Checking enables Consul to quickly alert operators about any issues in a cluster. The integration with service discovery prevents routing traffic to unhealthy hosts and enables service level circuit breakers.

  • Key/Value Storage - A flexible key/value store enables storing dynamic configuration, feature flagging, coordination, leader election and more. The simple HTTP API makes it easy to use anywhere.

  • Multi-Datacenter - Consul is built to be datacenter aware, and can support any number of regions without complex configuration.

Consul runs on Linux, Mac OS X, FreeBSD, Solaris, and Windows.

Quick Start

An extensive quick start is viewable on the Consul website:


Full, comprehensive documentation is viewable on the Consul website:

Developing Consul

If you wish to work on Consul itself, you'll first need Go installed (version 1.7+ is required). Make sure you have Go properly installed, including setting up your GOPATH.

Next, clone this repository into $GOPATH/src/ and then just type make. In a few moments, you'll have a working consul executable:

$ make
$ bin/consul

Note: make will also place a copy of the binary in the first part of your $GOPATH.

You can run tests by typing make test.

If you make any changes to the code, run make format in order to automatically format the code according to Go standards.

Building Consul on Windows

Make sure Go 1.7+ is installed on your system and that the Go command is in your %PATH%.

For building Consul on Windows, you also need to have MinGW installed. TDM-GCC is a simple bundle installer which has all the required tools for building Consul with MinGW.

Install TDM-GCC and make sure it has been added to your %PATH%.

If all goes well, you should be able to build Consul by running make.bat from a command prompt.

See also golang/winstrap and golang/wiki/WindowsBuild for more information of how to set up a general Go build environment on Windows with MinGW.


Consul currently uses govendor for vendoring.