2.8 KiB
| layout | page_title | sidebar_current | description |
|---|---|---|---|
| intro | Web UI | gettingstarted-ui | Consul comes with support for beautiful, functional web UIs out of the box. UIs can be used for viewing all services and nodes, for viewing all health checks and their current status, and for reading and setting key/value data. The UIs automatically supports multi-datacenter. |
Consul Web UI
Consul comes with support for beautiful, functional web UIs out of the box. UIs can be used for viewing all services and nodes, for viewing all health checks and their current status, and for reading and setting key/value data. The UIs automatically support multi-datacenter.
There are two options for running a web UI for Consul: using Atlas by HashiCorp to host the dashboard for you or self-hosting the open-source UI.
Atlas-hosted Dashboard
To set up the Atlas UI for Consul, you must add two fields to your configuration: the name of your Atlas infrastructure and your Atlas token. Below is an example command-line invocation of the Consul agent providing these settings:
$ consul agent -atlas=ATLAS_USERNAME/demo -atlas-token="ATLAS_TOKEN"
To get an Atlas username and token, create an account and replace the respective values in your Consul configuration with your credentials.
You can view a live demo here.
Self-hosted Dashboard
To set up the self-hosted UI, download the web UI package
and unzip it to a directory somewhere on a system with a Consul agent
install. Restart the Consul agent, and append a
-ui-dir parameter
pointing to the directory where you unzipped the UI (that is, the
directory containing 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.
You can view a live demo of the Consul Web UI here.
While the live demo is able to access data from all datacenters, we've also setup demo endpoints in the specific datacenters: AMS2 (Amsterdam), SFO1 (San Francisco), and NYC3 (New York).
Next Steps
This concludes our Getting Started guide. See the next steps page to learn more about how to continue your journey with Consul!