consul

History

James Phillips be4d2ff659 Moves the static assets into a subfolder where index.html expects them.		9 years ago
..
dist	ui: ignore compiled js, dist	11 years ago
javascripts	Clean up the JS a bit and make Ember code more idiomatic	9 years ago
scripts	Moves the static assets into a subfolder where index.html expects them.	9 years ago
static	website: document precedence of Atlas endpoint inputs	9 years ago
styles	revert `8bf8871`, `fc2aad3`, `503d338`.	9 years ago
tests	ui: add nodeShow test	11 years ago
Gemfile	…
Gemfile.lock	revert `8bf8871`, `fc2aad3`, `503d338`.	9 years ago
Makefile	Use gox for building	9 years ago
README.md	s/data center/datacenter/g	10 years ago
development_config.json	revert `8bf8871`, `fc2aad3`, `503d338`.	9 years ago
index.html	Show node status as failing if a service on the node is failing	9 years ago
style-guide.html	…

README.md

Consul Web UI

This directory contains the Consul Web UI. Consul contains a built-in HTTP server that serves this directory, but any common HTTP server is capable of serving it.

It uses JavaScript and Ember to communicate with the Consul API. The basic features it provides are:

Service view. A list of your registered services, their health and the nodes they run on.
Node view. A list of your registered nodes, the services running on each and the health of the node.
Key/value view and update

It's aware of multiple datacenters, so you can get a quick global overview before drilling into specific data-centers for detailed views.

The UI uses some internal undocumented HTTP APIs to optimize performance and usability.

Development

Improvements and bug fixes are welcome and encouraged for the Web UI.

You'll need sass to compile CSS stylesheets. Install that with bundler:

cd ui/
bundle

Reloading compilation for development:

make watch

Consul ships with an HTTP server for the API and UI. By default, when you run the agent, it is off. However, if you pass a -ui-dir flag with a path to this directory, you'll be able to access the UI via the Consul HTTP server address, which defaults to localhost:8500/ui.

An example of this command, from inside the ui/ directory, would be:

consul agent -bootstrap -server -data-dir /tmp/ -ui-dir .

Basic tests can be run by adding the ?test query parameter to the application.

When developing Consul, it's recommended that you use the included development configuration.

consul agent -config-file=development_config.json

Releasing

make dist

The dist folder will contain the files you should use for deployment.