Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure.
Go JavaScript HTML CSS Shell Gherkin Other
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.github/ISSUE_TEMPLATE github: more tweaking of bug issue template May 11, 2018
acl Rewrite all of acl_test.go Jul 25, 2018
agent Added code to allow snapshot inclusion of NodeMeta (#4527) Aug 16, 2018
api Addresses the flakiness of CatalogNodes (#4530) Aug 15, 2018
bench Gets benchmarks running again and does a rough pass for 0.7.1. Nov 29, 2016
build-support UI: Add conditional enterprise logo (#4432) Jul 30, 2018
command replace old fork of text package (#4501) Aug 14, 2018
connect Improve flaky connect/proxy Listener tests (#4498) Aug 8, 2018
demo demo: Added udp port forwarding May 30, 2018
ipaddr New config parser, HCL support, multiple bind addrs (#3480) Sep 25, 2017
lib Refactor to use embedded struct. Jun 25, 2018
logger golint: Untangle if blocks with return in else Apr 25, 2017
sentinel Renames stubs to be more consistent. Nov 30, 2017
service_os Changes made : Jun 29, 2018
snapshot Removes timeout when restoring snapshots. Dec 13, 2017
terraform Spelling (#3958) Mar 19, 2018
test Update test certificates that expire this year to be way in the future May 12, 2018
testrpc Address flakiness in command/exec tests (#4517) Aug 10, 2018
testutil Fixed message: testutil/server.go:317: missing ... in args forwarded … Jul 10, 2018
tlsutil 🐛 Formatting changes only; add missing trailing commas Mar 15, 2018
types Removes remoteConsuls in favor of the new router. Mar 16, 2017
ui-v2 UI: Add conditional enterprise logo (#4432) Jul 30, 2018
ui Remove upgrade banner html from v1 ui Jun 22, 2018
vendor replace old fork of text package (#4501) Aug 14, 2018
version Putting source back into Dev Mode Jul 30, 2018
watch Misc test fixes Jun 25, 2018
website Clarify port usage for agents (#4510) Aug 14, 2018
.dockerignore Update the scripting Jun 15, 2018
.gitignore Update .gitignore - ignore some macos fs event notification stuff May 24, 2018
.travis.yml Move travis build env back to containers Aug 2, 2018 Update Aug 16, 2018
GNUmakefile BUGFIX: Unit test relying on WaitForLeader() did not work due to wron… Aug 6, 2018 Spelling (#3958) Mar 19, 2018
LICENSE Initial commit Nov 4, 2013 add copyright notice file Jul 9, 2018 readme: add note about security related issues (#4401) Jul 19, 2018
Vagrantfile Adds a basic Linux Vagrant setup, stolen from Nomad. Oct 6, 2017
main.go Added Side Effect import for Windows Service Jun 18, 2018
main_test.go Adding basic CLI infrastructure Dec 19, 2013

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.

  • Service Segmentation - Consul Connect enables secure service-to-service communication with automatic TLS encryption and identity-based authorization.

Consul runs on Linux, Mac OS X, FreeBSD, Solaris, and Windows. A commercial version called Consul Enterprise is also available.

Please note: We take Consul's security and our users' trust very seriously. If you believe you have found a security issue in Consul, please responsibly disclose by contacting us at

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.9+ 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 build all os/architecture combinations. Set the environment variable CONSUL_DEV=1 to build it just for your local machine's os/architecture, or use make dev.

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. The test suite may fail if over-parallelized, so if you are seeing stochastic failures try GOTEST_FLAGS="-p 2 -parallel 2" make test.

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


Consul currently uses govendor for vendoring and vendorfmt for formatting vendor.json to a more merge-friendly "one line per package" format.