Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure. https://www.consul.io
Go to file
Guillaume Demesy 809ed36344 Fixed Header background 2015-10-13 22:29:14 +02:00
acl Fix a bunch of typos. 2015-09-15 13:22:08 +01:00
api Merge pull request #1041 from rboyer/api-fix-session-renew 2015-09-25 13:15:54 -07:00
bench Bump version references 2015-05-18 14:37:27 -07:00
command Add http method to log output 2015-10-02 18:33:06 -07:00
consul Fix a bunch of typos. 2015-09-15 13:22:08 +01:00
contrib/zsh-completion Add new 0.5 commands 2015-01-30 00:12:03 -08:00
demo/vagrant-cluster Fix missing config-dir in getting started guide 2015-07-22 13:33:15 +02:00
deps Adding dep 2015-05-18 14:05:53 -07:00
scripts Add shopt globs to include hidden files 2015-10-08 13:47:25 -04:00
terraform gc duplicate platform variable 2015-06-25 08:39:22 +02:00
test Reissues cert for the unit tests, which expired a few days ago. 2015-05-27 15:08:58 -07:00
testutil Fix a bunch of typos. 2015-09-15 13:22:08 +01:00
tlsutil tlsutil: Testing hostname verification 2015-05-11 16:05:39 -07:00
ui website: document precedence of Atlas endpoint inputs 2015-08-27 17:54:56 -07:00
watch api: initial import from armon/consul-api 2015-01-06 10:40:00 -08:00
website Fixed Header background 2015-10-13 22:29:14 +02:00
.gitignore Update middleman-hashicorp 2015-04-26 15:29:48 -04:00
.travis.yml travis-ci: use newer build infra 2015-07-28 09:13:25 -07:00
CHANGELOG.md remove various typos 2015-09-11 12:29:54 -07:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
Makefile Build consul to a temp dir for API tests 2015-04-11 13:21:56 -07:00
README.md make.bat: add Makefile functionality for Windows 2015-01-25 06:35:56 +01:00
Vagrantfile Fixes the Vagrantfile on VMWare. 2015-06-16 16:59:55 -07:00
commands.go command/configtest: add 2015-05-08 13:09:50 -07:00
main.go main: do not process -v or --version after a '--' 2015-03-11 16:33:55 -07:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
make.bat make.bat: add Makefile functionality for Windows 2015-01-25 06:35:56 +01:00
version.go switch to more idiomatic var syntax 2015-07-08 23:22:12 +01:00

README.md

Consul Build Status

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, and Windows. It is recommended to run the Consul servers only on Linux, however.

Quick Start

An extensive quick quick start is viewable on the Consul website:

http://www.consul.io/intro/getting-started/install.html

Documentation

Full, comprehensive documentation is viewable on the Consul website:

http://www.consul.io/docs

Developing Consul

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

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

$ go get -u ./...
$ 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.4+ 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.