From fe71cd62df02865ebd2c159cb00c59634ef065d3 Mon Sep 17 00:00:00 2001 From: Jack Pearkes Date: Wed, 30 Apr 2014 23:08:10 -0400 Subject: [PATCH] ui: update readme --- ui/README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/ui/README.md b/ui/README.md index 8b5a8d3907..48ff47f56a 100644 --- a/ui/README.md +++ b/ui/README.md @@ -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 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: - 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 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. @@ -34,9 +38,7 @@ Reloading compilation for development: make watch -Additionally, you'll need to run a local webserver. - - make server - - -### Running the tests +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 directoy, you'll be able to access the UI via the +Consul HTTP server address, which defaults to `localhost:8500/ui`.