Customizing the Tanium Console and Interact

You can customize the appearance and behavior of the Tanium Console and Interact Overview page.

Customize the Tanium Console color

In deployments with multiple environments (such as lab environments, test environments, and production environments), customizing the top border color of the Tanium Console Main menu (header) can help users identify which environment they are signed into for the current session. The following figure shows an example of a custom color.

Figure 1: Tanium Console Main menu color

Users require the Administrator reserved role to manage the console color.

In a high availability (HA) deployment, the Tanium Console instances for both Tanium Servers use the same color configuration. You cannot specify a different color for each HA peer.

From the Main menu, go to Administration > Configuration > Miscellaneous and click Console Configurations.
In the Console Color section, use the Current Color selector to pick your custom color or click No Color .
Click Save Change, wait about two minutes for the change to apply, and then refresh your web browser to confirm that the new color appears as expected.
To apply the change immediately, restart the Tanium Server service: see Manage the Tanium Server service.

Select the Tanium Console header text

By default, the Tanium Console Main menu (header) displays no text above the version fields. In deployments with multiple environments (such as lab environments, test environments, and production environments), adding text can help users identify which environment they are signed into for the current console session. The following figure shows an example that identifies a Production Environment:

Users require the Administrator reserved role to manage the Main menu text.

In a high availability (HA) deployment, the Tanium Console instances for both Tanium Servers use the same text configuration. You cannot specify different text for each HA peer.

Perform the following steps to add, edit, or remove the Main menu text:

From the Main menu, go to Administration > Configuration > Miscellaneous > Console Configurations.
In the Console Header Text section, enter the new text in the Change Header Text field.
If you want to revert to the default (no text), click Reset.
Click Save Change, wait about two minutes for the change to apply, and then refresh your web browser to confirm that the text appears as expected.
To apply the change immediately, restart the Tanium Server service: see Manage the Tanium Server service.

Select the confirmation prompt for Tanium Console tasks

Many tasks that users initiate in the Tanium Console require responding to a confirmation prompt before the tasks proceed. Select the prompt type based on whether you want to optimize Tanium Console security (password prompt) or the user experience (yes/cancel prompt).

Only users assigned the Administrator reserved role can manage the confirmation prompt.

If you enable Security Assertion Markup Language (SAML) single sign-on, the Tanium Server automatically changes the prompt to a Yes/Cancel prompt. For details, see Integrating with a SAML IdP.

From the Main menu, go to Administration > Configuration > Miscellaneous > Confirmation Prompt.
Select Show a password prompt or Show a Yes/Cancel prompt, and then click Save.

Customize the Tanium Console help URL

By default, clicking the Help link in the Main menu opens a new browser tab or window with the URL https://docs.tanium.com. In deployments where that URL is inaccessible (for example, if the Tanium Server does not have Internet access), you can change the help URL.

Users require the Administrator reserved role to manage the console help URL.

From the Main menu, go to Administration > Configuration > Miscellaneous > Console Configurations.
In the Help URL section, enter the new URL in the Change URL field.
If you want to revert to the original, default help URL, click Reset.
Click Save Change, wait about two minutes for the change to apply, and refresh your web browser.
To apply the change immediately, restart the Tanium Server service: see Manage the Tanium Server service.
Click the Help link to verify that it opens the new URL.

Customize the Tanium Console logo

You can replace the default Tanium logo in the Main menu (header) of the Tanium Console with the logo of your organization. The Tanium Console supports all the standard image formats that your browser supports, such as PNG, JPG, and SVG. The maximum file size is 2 MB. You can also adjust the logo height, which is 24 pixels by default. The Tanium Console automatically scales the logo width proportionately.

Users require the Administrator reserved role to manage the console logo.

Create your own logo file if you want to replace the Tanium logo.
From the Main menu, go to Administration > Configuration > Miscellaneous > Console Configurations.
(New logo only) In the Console Logo section, click Choose File, select the logo file, and click Open.
If you want to revert to the original, default logo, click Reset.
(Optional): In the Adjust logo size field, specify the logo height in pixels.
Click Save Change, wait about two minutes for the change to apply, and then refresh your web browser to confirm the updated logo appears as expected.
To apply the changes immediately, restart the Tanium Server service: see Manage the Tanium Server service.

Set Tanium Console user preferences

User preferences control certain behaviors of the Tanium Console on a per-user basis. Changes that you make to your settings affect all the personas that are assigned to your account, but do not affect other users. The Tanium Server applies the preferences of a user when that user logs into the console. The Tanium Console filters the settings on the Edit Preferences page based on the effective permissions of the persona used to access the page. For example, if the persona does not have permission to ask questions, many of the settings do not appear. For details on permissions, see RBAC overview.

Click the drop down beside <username> at the top right of the Tanium Console and select Preferences.
Configure the settings described in Table 1 and click Save. The changes apply immediately.

Table 1: User preferences
Settings	Guidelines
Consider question results complete at	The default is 99%.
Suspend console automatically if no activity detected for	The default is 10 minutes. The value must be equal to or less than the timeout that your administrator set for all users through the max_console_idle_seconds setting (Administration > Global Settings). The global setting has a default of 3,600 seconds (1 hour). If you set the user preference to a lower value than the global setting, the Tanium Server applies the user preference.
Submit filter text after	After the user starts typing in a filter field in the Tanium Console, the Tanium Server does not start searching for the text string until the specified time period passes. The default is 700 ms.
Hide error results from questions	Enabled by default. Select this option if you want the Questions Results grid to omit null or error values, such as [no results] or [results currently unavailable]. This option provides clarity in that the grid shows only the answers that are likely to be useful. However, this option also prevents the grid from showing the complete set of answers received from all endpoints.
Language	Select a language for text that appears in the Tanium Console. The Default is the language selected for the browser that you use to access the Tanium Console.

Customize Tanium module overview pages

Each Tanium module has an Overview page that appears when you navigate to the module. Overview pages are organized into sections such as guidance on getting started, reports related to module health, or reports related to deployment metrics. If you show, hide, or reorder sections of a module Overview page, your changes apply across all the personas that are assigned to your user account. The following steps also apply to customizing the Tanium Home page .

View the content on a module Overview page. From the Main menu, select Modules > <module name>.
- By default, all the page sections are expanded so that their contents are visible. You can toggle between collapsing and expanding a page section.
- Click Hide within any section that you do not want the page to show.
  
  The following steps describe how to reverse this change if necessary.
To customize the Overview page, click Customize Page.
1. Select the sections that you want to display.
2. Click and drag the sections to change the order in which they appear, and then click Save.

The Tanium Home page and Interact Overview page display categories, dashboards, and saved questions that you selected as favorites. To change the favorites, see Filter by favorites.