ui: update readme

pull/98/head
Jack Pearkes 11 years ago
parent 67df23c2b9
commit fe71cd62df

@ -4,7 +4,8 @@ This directory contains the Consul Web UI. Consul contains a built-in
HTTP server that serves this directoy, but any common HTTP server HTTP server that serves this directoy, but any common HTTP server
is capable of serving it. is capable of serving it.
It uses JavaScript to communicate with the [Consul API](). The basic It uses JavaScript and [Ember](http://emberjs.com) to communicate with
the [Consul API](http://www.consul.io/docs/agent/http.html). The basic
features it provides are: features it provides are:
- Service view. A list of your registered services, their - Service view. A list of your registered services, their
@ -17,6 +18,9 @@ It's aware of multiple data centers, so you can get a quick global
overview before drilling into specific data-centers for detailed overview before drilling into specific data-centers for detailed
views. views.
The UI uses some internal undocumented HTTP APIs to optimize
performance and usability.
### Development ### Development
Improvements and bug fixes are welcome and encouraged for the Web UI. Improvements and bug fixes are welcome and encouraged for the Web UI.
@ -34,9 +38,7 @@ Reloading compilation for development:
make watch make watch
Additionally, you'll need to run a local webserver. 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
make server with a path to this directoy, you'll be able to access the UI via the
Consul HTTP server address, which defaults to `localhost:8500/ui`.
### Running the tests

Loading…
Cancel
Save