status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Consul is a distributed, highly available, and data center aware solution to connect and configure applications across dynamic, distributed infrastructure. https://www.consul.io
1,098 Commits 445 Branches 179 Tags 481 MiB
Go 65.8%
MDX 16.4%
SCSS 9.4%
JavaScript 4.1%
Handlebars 1.8%
Other 2.4%
Go to file
Armon Dadgar d77a458bdc website: Clarify the ?pretty docs 2014-08-01 13:38:03 -07:00
bench Cutting v0.3.1 2014-07-21 10:58:37 -04:00
command modified so ?pretty=anything will work 2014-08-01 14:28:46 -06:00
consul Run `go fmt` 2014-07-24 01:09:55 +02:00
demo/vagrant-cluster Cutting v0.3.1 2014-07-21 10:58:37 -04:00
deps Adding the deps file for 0.3.1 2014-07-21 11:34:10 -04:00
scripts scripts: Ensure OSX build works on older versions. Fixes #147. 2014-06-11 10:07:38 -07:00
test Add some basic smoke tests for wrapTLSclient. 2014-06-29 18:11:32 -07:00
testutil testutil: Using the correct RPC struct 2014-06-10 19:12:36 -07:00
ui ui: add tests param to readme 2014-07-22 13:32:05 -04:00
website website: Clarify the ?pretty docs 2014-08-01 13:38:03 -07:00
.gitignore ui: ignore compiled js, dist 2014-05-01 11:22:30 -04:00
.travis.yml Adding Travis file 2014-04-19 13:40:38 -07:00
CHANGELOG.md Update CHANGELOG.md 2014-07-23 23:45:03 +02:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
Makefile Fix a Makefile typo. 2014-06-29 18:22:44 -07:00
README.md Adding travis badge 2014-04-19 13:49:20 -07:00
Vagrantfile Using older OS's for compilation 2014-05-01 11:09:00 -07:00
commands.go command/reload: Adding new command 2014-06-11 10:58:26 -07:00
main.go main: Fixing app name 2014-04-11 16:23:05 -07:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
version.go Cutting v0.3.1 2014-07-21 10:58:37 -04: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.2+ 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:

$ 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.