github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/configuration/ui.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: ui Stanza - Agent Configuration
     4  description: |-
     5    The "ui" stanza configures the Nomad agent's web UI.
     6  
     7  ---
     8  
     9  # `ui` Stanza
    10  
    11  <Placement groups={['ui']} />
    12  
    13  The `ui` stanza configures the Nomad agent's [web UI].
    14  
    15  ```hcl
    16  ui {
    17    enabled =  true
    18  
    19    consul {
    20      ui_url = "https://consul.example.com:8500/ui"
    21    }
    22  
    23    vault {
    24      ui_url = "https://vault.example.com:8200/ui"
    25    }
    26  }
    27  ```
    28  
    29  A default `ui` stanza is automatically merged with all Nomad agent
    30  configurations. Note that the UI can be served from any Nomad agent,
    31  and the configuration is individual to each agent.
    32  ## `ui` Parameters
    33  - `enabled` `(bool: true)` - Specifies whether the web UI is
    34    enabled. If disabled, the `/ui/` path will return an empty web page.
    35  
    36  - `consul` <code>([Consul]: nil)</code> - Configures integrations
    37    between the Nomad web UI and the Consul web UI.
    38  
    39  - `vault` <code>([Vault]: nil)</code> - Configures integrations
    40    between the Nomad web UI and the Vault web UI.
    41  
    42  ## `consul` Parameters
    43  
    44  - `ui_url` `(string: "")` - Specifies the full base URL to a Consul
    45    web UI (for example: `https://consul.example.com:8500/ui`. This URL
    46    is used to build links from the Nomad web UI to a Consul web
    47    UI. Note that this URL will not typically be the same one used for
    48    the agent's [`consul.address`]; the `consul.address` is the URL used
    49    by the Nomad to communicate with Consul, whereas the
    50    `ui.consul.ui_url` is the URL you'll visit in your browser. If
    51    this field is omitted, this integration will be disabled.
    52  
    53  ## `vault` Parameters
    54  
    55  - `ui_url` `(string: "")` - Specifies the full base URL to a Vault
    56    web UI (for example: `https://vault.example.com:8200/ui`. This URL
    57    is used to build links from the Nomad web UI to a Vault web
    58    UI. Note that this URL will not typically be the same one used for
    59    the agent's [`vault.address`]; the `vault.address` is the URL used
    60    by the Nomad to communicate with Vault, whereas the
    61    `ui.vault.ui_url` is the URL you'll visit in your browser. If
    62    this field is omitted, this integration will be disabled.
    63  
    64  
    65  [web UI]: https://learn.hashicorp.com/collections/nomad/web-ui
    66  [Consul]: /docs/configuration/ui#consul-parameters
    67  [Vault]: /docs/configuration/ui#vault-parameters
    68  [`consul.address`]: /docs/configuration/consul#address
    69  [`vault.address`]: /docs/configuration/vault#address