2014-05-01 18:19:13 +00:00
|
|
|
---
|
|
|
|
|
layout: "intro"
|
|
|
|
|
page_title: "Web UI"
|
|
|
|
|
sidebar_current: "gettingstarted-ui"
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Consul Web UI
|
|
|
|
|
|
|
|
|
|
Consul comes with support for a
|
|
|
|
|
[beautiful, functional web UI](http://demo.consul.io) out of the box.
|
|
|
|
|
This UI can be used for viewing all services and nodes, viewing all
|
|
|
|
|
health checks and their current status, and for reading and setting
|
|
|
|
|
key/value data. The UI automatically supports multi-datacenter.
|
|
|
|
|
|
|
|
|
|
For ease of deployment, the UI is
|
|
|
|
|
[distributed](/downloads_web_ui.html)
|
|
|
|
|
as static HTML and JavaScript.
|
|
|
|
|
You don't need a separate web server to run the web UI. The Consul
|
|
|
|
|
agent itself can be configured to serve the UI.
|
|
|
|
|
|
|
|
|
|
## Screenshot and Demo
|
|
|
|
|
|
|
|
|
|
You can view a live demo of the Consul Web UI
|
|
|
|
|
[here](http://demo.consul.io).
|
|
|
|
|
|
2014-05-01 18:25:27 +00:00
|
|
|
While the live demo is able to access data from all datacenters,
|
|
|
|
|
we've also setup demo endpoints in the specific datacenters:
|
|
|
|
|
[AMS2](http://ams2.demo.consul.io) (Amsterdam),
|
|
|
|
|
[SFO1](http://sfo1.demo.consul.io) (San Francisco),
|
2014-05-02 04:18:40 +00:00
|
|
|
and [NYC1](http://nyc1.demo.consul.io) (New York).
|
2014-05-01 18:25:27 +00:00
|
|
|
|
2014-05-01 18:19:13 +00:00
|
|
|
A screenshot of one page of the demo is shown below so you can get an
|
|
|
|
|
idea of what the web UI is like. Click the screenshot for the full size.
|
|
|
|
|
|
|
|
|
|
<div class="center">
|
2014-10-06 23:12:34 +00:00
|
|
|
<%= link_to image_tag('consul_web_ui.png'), image_path('consul_web_ui.png') %>
|
2014-05-01 18:19:13 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
## Set Up
|
|
|
|
|
|
|
|
|
|
To set up the web UI,
|
|
|
|
|
[download the web UI package](/downloads_web_ui.html)
|
|
|
|
|
and unzip it to a directory somewhere on the server where the Consul agent
|
|
|
|
|
is also being run. Then, just append the `-ui-dir` to the `consul agent`
|
|
|
|
|
command pointing to the directory where you unzipped the UI (the
|
|
|
|
|
directory with the `index.html` file):
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ consul agent -ui-dir /path/to/ui
|
|
|
|
|
...
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The UI is available at the `/ui` path on the same port as the HTTP API.
|
|
|
|
|
By default this is `http://localhost:8500/ui`.
|
