Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Consul is a tool for service discovery, monitoring and configuration.
Go CSS HTML JavaScript Ruby Shell Other

Merge pull request #1146 from hashicorp/website-broken-link

website: fix broken link on acl page
latest commit 3846dea370
@ryanbreen ryanbreen authored
Failed to load latest commit information.
acl acl: adding negative tests for bad policy
api Add TCP check type
bench Bump version references
command Remove trailing slash from lock
consul consul: filter services by ACL when using ChecksInState.
contrib/zsh-completion Add new 0.5 commands
demo/vagrant-cluster Fix missing config-dir in getting started guide
deps Adding dep
scripts Add XXX to the end of mktemp template to support more linux versions.
terraform gc duplicate platform variable
test Reissues cert for the unit tests, which expired a few days ago.
testutil testutil: support ACLMasterToken, ACLDatacenter and ACLDefaultPolicy
tlsutil tlsutil: Testing hostname verification
ui fix base64 issue
watch api: initial import from armon/consul-api
website website: fix broken link on acl page
.gitignore Update middleman-hashicorp
.travis.yml travis-ci: use newer build infra
CHANGELOG.md Update CHANGELOG.md
LICENSE Initial commit
Makefile Build consul to a temp dir for API tests
README.md make.bat: add Makefile functionality for Windows
Vagrantfile Fixes the Vagrantfile on VMWare.
commands.go command/configtest: add
main.go main: do not process -v or --version after a '--'
main_test.go Adding basic CLI infrastructure
make.bat make.bat: add Makefile functionality for Windows
version.go switch to more idiomatic var syntax

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.

Something went wrong with that request. Please try again.