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
4,676 Commits 445 Branches 179 Tags 489 MiB
Go 62.5%
MDX 18.2%
SCSS 10.2%
JavaScript 4.4%
Handlebars 1.9%
Other 2.7%
Go to file
James Turnbull 23a4a96ad3 Documentation pass 
I was reviewing some docs and found a few issues.

1. Fixed some spelling mistakes.
2. Re-formatted some paragraphs.
3. Changed some potentially loaded language.
4. Fixed some grammar issues.
5. Tried to consistently use syntax-highlighting.
6. Fixed post-period spacing.
7. Fixed some formatting issues and inconsistency.
8. All "notes" are either proper notes or re-written.
 		2016-11-25 12:02:32 -05:00
acl Adds support for snapshots and restores. (#2396) 2016-10-25 19:20:24 -07:00
api Runs `go fmt`. 2016-11-22 17:49:48 -08:00
bench Fix Consul download link in benchmark scripts 2016-02-10 14:18:19 -02:00
command Updates static assets to pick up #2340 and and #2525. 2016-11-22 17:47:50 -08:00
consul Add keyring http endpoints 2016-11-22 20:10:43 -05:00
contrib Merge pull request #1863 from mssola/bash-completion 2016-07-05 12:52:58 -07:00
demo/vagrant-cluster Update demo 2016-11-21 12:49:59 -05:00
lib Use a cryptographically secure seed 2016-05-02 23:52:37 -07:00
logger Moves logger setup into its own package. (#2471) 2016-11-03 21:14:56 -07:00
scripts Adjusts path for injected GIT_* variables. 2016-11-08 18:35:25 -08:00
snapshot Adjusts location of archive test fixtures. 2016-11-03 21:42:50 -07:00
terraform Tweaks DO example Terraform. 2016-11-17 16:27:48 -08:00
test Adds support for snapshots and restores. (#2396) 2016-10-25 19:20:24 -07:00
testutil Add keyring http endpoints 2016-11-22 20:10:43 -05:00
tlsutil Upgrades to Go 1.7 and fixes vet finding and TLS behavior change. (#2281) 2016-11-07 18:15:26 -08:00
types Revert "Move `structs.CheckID` to a new top-level package, `types`." 2016-06-07 16:59:02 -04:00
ui Bootstrap w/o Glyphicons (resolves #2485) 2016-11-21 18:08:17 -05:00
vendor Adds AWS S3 SDK. 2016-11-14 17:56:47 -08:00
version Puts the tree into 0.7.2 dev mode. 2016-11-10 12:53:37 -08:00
watch Moves stale code to same spot and adds it everywhere that supports it. 2016-08-10 15:49:51 -07:00
website Documentation pass 2016-11-25 12:02:32 -05:00
.gitignore Use gox for building 2015-10-22 14:16:01 -04:00
.travis.yml Upgrades to Go 1.7 and fixes vet finding and TLS behavior change. (#2281) 2016-11-07 18:15:26 -08:00
CHANGELOG.md Update CHANGELOG.md 2016-11-22 17:49:14 -08:00
GNUmakefile Runs the static asset packaging inside the container; updates assets. 2016-11-08 15:14:08 -08:00
ISSUE_TEMPLATE.md Revise issue template to include a hint to use a gist 2016-04-28 22:27:25 -07:00
LICENSE Initial commit 2013-11-04 14:15:27 -08:00
README.md Upgrades to Go 1.7 and fixes vet finding and TLS behavior change. (#2281) 2016-11-07 18:15:26 -08:00
commands.go Adds basic build tag support with different versions. (#2463) 2016-11-02 17:27:49 -07:00
main.go Always seed math/rand on consul startup 2016-01-29 17:00:08 -08:00
main_test.go Adding basic CLI infrastructure 2013-12-19 11:22:08 -08:00
make.bat Removes the integration test runner, there weren't any tests using it. 2015-10-26 11:34:01 -07:00

README.md

Consul Build Status Join the chat at https://gitter.im/hashicorp-consul/Lobby

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:

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

Documentation

Full, comprehensive documentation is viewable on the Consul website:

https://www.consul.io/docs

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

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.

Vendoring

Consul currently uses govendor for vendoring.