consul/website/source/intro/getting-started/ui.html.md

1.5 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.

To set up the self-hosted UI, start the Consul agent with the -ui parameter:

$ consul agent -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.

How to Use the Legacy UI

As of Consul version 1.2.0 the original Consul UI is deprecated. You can still enable it by setting the environment variable CONSUL_UI_LEGACY to true. Without this environment variable, the web UI will default to the latest version. To use the latest UI version, either set CONSUL_UI_LEGACY to false or don't include that environment variable at all.

Next Steps

This concludes our Getting Started guide. See the next steps page to learn more about how to continue your journey with Consul!