HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
Terraform Home

Customize the UI

This topic describes how to customize different parts of the user interface to accommodate the specific needs of your organization. Refer to the Customization API for instructions about customizing the UI using the API.

Access Customization Settings

To access the customization settings, visit the site admin area and click Customization. To save the settings, click Save Customization Settings.

Note: Terraform Enterprise sanitizes customization content before displaying it, and might remove HTML elements or attributes that pose a possible security risk.

Announcements

Use the Announcements section to publish a global application banner. Terraform Enterprise displays the banner at the top of every page so that you can broadcast upcoming maintenance windows, system outages, or other critical notices without relying on external channels. Refer to the Announcement banners API for instructions about managing banners using the API.

Terraform Enterprise supports one non-deactivated banner at a time. To replace a banner, deactivate the existing banner before you create a new one. This requirement applies to any non-deactivated banner, including a banner with a future schedule.

Visibility

Select Show banner to activate the banner. Clear Show banner to deactivate it. When Show banner is cleared, Terraform Enterprise hides the banner content, preview, and schedule fields. Terraform Enterprise applies the change when you save the customization settings.

Use this subsection to compose the banner message, choose its visual style, and select who sees it. Click Clear message to start over. Terraform Enterprise clears the Title and Body fields, returns Visual style and Target audience to their defaults, and selects Show banner. Clearing the message does not change the schedule.

FieldDescription
Visual styleControls the color and icon of the banner. Choose Info, Warning, or Critical. Defaults to Info.
TitleThe heading of the banner. This field is required and is limited to 100 characters.
BodyThe message of the banner. This field is required and is limited to 500 characters. It supports the same HTML formatting as the other customization fields, including common formatting such as bold, italic, links, lists, headings, and code. Terraform Enterprise removes scripts, inline styles, form controls, event handlers, and unsafe URLs when you save the form. The body must retain at least one displayable character after sanitization. When the body contains formatting that Terraform Enterprise removes, the form displays a warning before you save.
Target audienceDetermines who sees the banner. Select All users (Includes public login screen) to also display the banner to visitors who have not signed in, including on the sign-in page. Select Authenticated users only (Must be logged in) to restrict the banner to users who have signed in. Defaults to Authenticated users only.

The Banner preview area renders the banner as users see it and updates as you edit the title, body, and visual style. The preview appears as soon as you enter a title, so you can review the banner before you activate or save it.

Schedule

By default, a banner appears when you save it and remains visible until you clear Show banner. Use the Schedule (optional) subsection to publish and remove the banner automatically instead. Click Clear schedule to reset all schedule fields.

FieldDescription
TimezoneThe timezone that Terraform Enterprise uses to interpret the start and end times.
Start timeThe date and time when the banner becomes visible.
End timeThe date and time when Terraform Enterprise stops displaying the banner.

Terraform Enterprise validates the schedule as a complete set. Specify both a start time and an end time, or leave both blank. The end time must be later than the start time, and when you change the schedule, the end time must also be later than the current time.

Save the banner

Click Save Customization Settings to save the banner along with the rest of the customization settings.

After you save, Terraform Enterprise displays the banner at the top of every page for the selected audience. When you target all users, the banner also appears on the sign-in page and other pages that render before you sign in, such as the password reset and single sign-on pages. Users cannot dismiss the banner. When you update or deactivate a banner, other users see the change the next time they load or reload a page in their browser.

The following examples show common announcements and how to configure them.

Announce planned maintenance

Use the Warning style for disruptions that have not started yet. Set a schedule so that the banner appears and disappears without further action.

  • Choose Warning for the visual style.

  • Enter the following text in the Title field:

    Scheduled maintenance on Saturday

  • Enter the following text in the Body field:

    Terraform Enterprise is unavailable from 02:00 to 04:00 CDT while we upgrade the platform. Queued runs start automatically when maintenance completes.

  • Select All users (Includes public login screen) for the target audience.

  • Select (UTC -05:00) America/Chicago for the timezone.

  • Set the start time to 2026-09-12 at 02:00.

  • Set the end time to 2026-09-12 at 04:00.

Report an active incident

Use the Critical style for problems that affect users now. Leave the schedule blank so that the banner remains visible until you clear Show banner.

  • Choose Critical for the visual style.

  • Enter the following text in the Title field:

    Investigating slow runs

  • Enter the following text in the Body field:

    Runs are queuing longer than usual while we investigate. Follow <a href="https://status.example.com">our status page</a> for updates.

  • Select All users (Includes public login screen) for the target audience.

  • Leave the schedule fields blank.

The anchor tag in the body renders as a link that users can click.

Share an informational notice

Use the Info style for changes that do not disrupt service. Select Authenticated users only when the message is relevant only to users who have signed in.

  • Choose Info for the visual style.

  • Enter the following text in the Title field:

    Updated cost policy takes effect 1 October

  • Enter the following text in the Body field:

    Workspaces in the <strong>production</strong> project must pass the updated cost policy. Contact the platform team with questions.

  • Select Authenticated users only (Must be logged in) for the target audience.

  • Leave the schedule fields blank.

The strong tag in the body renders as bold text.

Format the banner body

The Body field supports the same HTML formatting as the other customization fields, such as the footer. Supported formatting includes links, bold and italic text, headings, lists, and code. Terraform Enterprise removes anything outside that set, including scripts, inline styles, form controls, and event handlers.

<h3>Maintenance details</h3>
<ul>
  <li>Upgrade to <code>v202601-1</code>.</li>
  <li>Follow <a href="https://status.example.com">our status page</a> for <strong>live updates</strong>.</li>
</ul>

Terraform Enterprise sanitizes the content when you save the banner. Scripts, inline styles, form controls, event handlers, and unsafe URLs are removed. The body must retain at least one displayable character after sanitization.

The Body field is limited to 500 characters, including any HTML markup that you enter.

Support

You can update the support content displayed in the UI.

URL Override Fields

Terraform Enterprise provides three URL override fields that let you route users to internal resources instead of the default HashiCorp destinations. Each field controls a distinct link category across the product UI.

FieldControlsAccepted schemesMax length
Internal Support URLSupport links in the Help menu and error pageshttps://, http://, or mailto:2048 characters
Internal Documentation URLDocumentation links in the Help menuhttps:// or http://2048 characters
Internal Tutorials URLTutorial links in the Help menuhttps:// or http://2048 characters

Setting any field to blank clears the override and restores the default HashiCorp URL. No service restart is required.

Email Address

Terraform Enterprise uses the support email address as the contact address in system emails, such as onboarding invitations, notifications, and the transactional mailer footer. You can specify a local email address if you want users to contact a specific person or team.

Note that this field defaults to support@hashicorp.com, which is not a functional email address for HashiCorp support. If you need assistance or want to submit a feature request, visit the HashiCorp support center and open a ticket.

Error Instructions

Supports HTML

Instructions to display when users encounter unexpected errors. You can use this space to provide links to your support triage process or other ticketing systems.

Avatar sources

The avatar_sources setting controls which external services Terraform Enterprise contacts to fetch user avatar images.

How avatar sources work

Terraform Enterprise uses the enabled avatar sources to fetch user avatar images. If no avatar is available, Terraform Enterprise renders up to two characters as a fallback in a colored square. Terraform Enterprise derives the initials from the local part of the user's email address or their username if no email is set. The fallback is always active regardless of the source of the avatar and cannot be disabled.

Gravatar

Gravatar is enabled by default. As a result, Terraform Enterprise generates Gravatar URLs using each user's email address, which causes the browser to make outbound HTTPS requests to gravatar.com. In air-gapped or network-restricted deployments where gravatar.com is unreachable, disable Gravatar so that Terraform Enterprise doesn't emit Gravatar URLs or make outbound requests to Gravatar servers.

When Gravatar is disabled, Terraform Enterprise does not generate Gravatar URLs for any user and all avatar resolution falls back to text initials.

Configure avatar sources

  1. In the site admin area, click Customization.
  2. Under User Avatars, check or uncheck the Gravatar checkbox.
  3. Click Save Customization Settings.

Application

You can customize the following UI elements.

Login Help

Supports HTML

The content provided in this field replaces the "Need an Account? Sign up here." prompt. This is an opportunity to provide system usage disclaimers, or any custom new user processes you may have.

New User Instructions

Supports HTML

Instructions shown to new users who aren't yet members of an organization. If you have a custom provisioning process for granting organization access, you can explain it here. (By default, new users are prompted to contact the system administrator for organization membership.)

Footer Content

Supports HTML

Content to display in the footer of every application page. Useful for disclaimers and other site-wide communication.

Edit this page on GitHub