ui.mdx

layout	page_title	description
docs	ui Stanza - Agent Configuration	The "ui" stanza configures the Nomad agent's web UI.

ui Stanza

<Placement groups={['ui']} />

The ui stanza configures the Nomad agent's web UI.

ui {
  enabled =  true

  consul {
    base_url = "https://consul.example.com:8500/ui"
  }

  vault {
    base_url = "https://vault.example.com:8200/ui"
  }
}

A default ui stanza is automatically merged with all Nomad agent configurations. Note that the UI can be served from any Nomad agent, and the configuration is individual to each agent.

ui Parameters

• enabled (bool: true) - Specifies whether the web UI is enabled. If disabled, the /ui/ path will return an empty web page.

• consul (Consul: nil) - Configures integrations between the Nomad web UI and the Consul web UI.

• vault (Vault: nil) - Configures integrations between the Nomad web UI and the Vault web UI.

consul Parameters

• base_url (string: "") - Specifies the full base URL to a Consul web UI (for example: https://consul.example.com:8500/ui. This URL is used to build links from the Nomad web UI to a Consul web UI. Note that this URL will not typically be the same one used for the agent's consul.address; the consul.address is the URL used by the Nomad to communicate with Consul, whereas the ui.consul.base_url is the URL you'll visit in your browser. If this field is omitted, this integration will be disabled.

vault Parameters

• base_url (string: "") - Specifies the full base URL to a Vault web UI (for example: https://vault.example.com:8200/ui. This URL is used to build links from the Nomad web UI to a Vault web UI. Note that this URL will not typically be the same one used for the agent's vault.address; the vault.address is the URL used by the Nomad to communicate with Vault, whereas the ui.vault.base_url is the URL you'll visit in your browser. If this field is omitted, this integration will be disabled.