mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-12 17:47:02 +02:00
73254908e6
* docs(web repl): add initial docs about the UI REPL * feature(repl): add link to the new docs in the REPL * chore(repl): Web CLI or Broweser CLI -> Web REPL * Use Hds::Link::Inline instead of DocLink Co-authored-by: claire bontempo <68122737+hellobontempo@users.noreply.github.com> * Update ui/app/templates/components/console/ui-panel.hbs Co-authored-by: claire bontempo <68122737+hellobontempo@users.noreply.github.com> * Update website/content/docs/commands/web.mdx Co-authored-by: claire bontempo <68122737+hellobontempo@users.noreply.github.com> * Update website/content/docs/commands/web.mdx Co-authored-by: claire bontempo <68122737+hellobontempo@users.noreply.github.com> * Fix typos and update phrasing. Co-authored-by: claire bontempo <68122737+hellobontempo@users.noreply.github.com> * docs(web repl): add a refrence to the repl docs on the ui config page * Update KV version 2 reference Co-authored-by: Chelsea Shaw <82459713+hashishaw@users.noreply.github.com> * fix linting --------- Co-authored-by: claire bontempo <68122737+hellobontempo@users.noreply.github.com> Co-authored-by: Chelsea Shaw <82459713+hashishaw@users.noreply.github.com>
80 lines
2.3 KiB
Plaintext
80 lines
2.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: UI - Configuration
|
|
description: |-
|
|
Vault features a user interface (web interface) for interacting with Vault.
|
|
Easily create, read, update, and delete secrets, authenticate, unseal, and
|
|
more with the Vault UI.
|
|
---
|
|
|
|
# Vault UI
|
|
|
|
Vault features a user interface (web interface) for interacting with Vault.
|
|
Easily create, read, update, and delete secrets, authenticate, unseal, and
|
|
more with the Vault UI.
|
|
|
|
-> The UI requires **Vault 0.10 or higher** or Vault Enterprise.
|
|
|
|
## Activating the Vault UI
|
|
|
|
The Vault UI is not activated by default. To activate the UI, set the `ui`
|
|
configuration option in the Vault server configuration. Vault clients do not
|
|
need to set this option, since they will not be serving the UI.
|
|
|
|
```hcl
|
|
ui = true
|
|
|
|
listener "tcp" {
|
|
# ...
|
|
}
|
|
```
|
|
|
|
For more information, please see the
|
|
[Vault configuration options](/vault/docs/configuration).
|
|
|
|
## Accessing the Vault UI
|
|
|
|
The UI runs on the same port as the Vault listener. As such, you must configure
|
|
at least one `listener` stanza in order to access the UI.
|
|
|
|
```hcl
|
|
listener "tcp" {
|
|
address = "10.0.1.35:8200"
|
|
|
|
# If bound to localhost, the Vault UI is only
|
|
# accessible from the local machine!
|
|
# address = "127.0.0.1:8200"
|
|
}
|
|
```
|
|
|
|
In this case, the UI is accessible at the following URL from any machine on the
|
|
subnet (provided no network firewalls are in place):
|
|
|
|
```text
|
|
https://10.0.1.35:8200/ui/
|
|
```
|
|
|
|
It is also accessible at any DNS entry that resolves to that IP address, such as
|
|
the Consul service address (if using Consul):
|
|
|
|
```text
|
|
https://vault.service.consul:8200/ui/
|
|
```
|
|
|
|
### Note on TLS
|
|
|
|
When using TLS (recommended), the certificate must be valid for all DNS entries
|
|
you will be accessing the Vault UI on, and any IP addresses on the SAN. If you
|
|
are running Vault with a self-signed certificate, any browsers that access the
|
|
Vault UI will need to have the root CA installed. Failure to do so may result in
|
|
the browser displaying a warning that the site is "untrusted". It is highly
|
|
recommended that client browsers accessing the Vault UI install the proper CA
|
|
root for validation to reduce the chance of a MITM attack.
|
|
|
|
|
|
## Vault UI Web REPL
|
|
|
|
The Vault UI includes an interactive Web REPL to interact with Vault's API much
|
|
like the Vault CLI. For more on that, see the
|
|
[Web REPL documentation](/vault/docs/commands/web).
|