github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e9c7098936'
${ noResults }
consul/ui
History
Jack Pearkes e54026cebc
ui: remove components from index 		11 years ago
..
dist ui: ignore compiled js, dist 11 years ago
javascripts ui: clean up comments and old file 11 years ago
scripts ui: remove components from compile 11 years ago
static ui: loading 11 years ago
styles ui: clean up comments and old file 11 years ago
tests ui: add base ember 11 years ago
Gemfile ui: update ember, dist steps 11 years ago
Gemfile.lock ui: update ember, dist steps 11 years ago
Makefile ui: delete backup files 11 years ago
README.md Minor Typo 11 years ago
index.html ui: remove components from index 11 years ago
style-guide.html ui: add delete key functionality 11 years ago

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 data centers, 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 .

Releasing

make dist

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