Splunk Enterprise version 8.1 will no longer be supported as of April 19, 2023. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see How to upgrade Splunk Enterprise.
This documentation does not apply to the most recent version of Splunk® Enterprise. Click here for the latest version.Download topic as PDF
The following are the spec and example files for
# Version 8.1.7 #
# This file contains descriptions of the settings that you can use to # configure a global banner at the top of every page in Splunk, above the Splunk bar. # # Each stanza controls different search commands settings. # # There is a global-banner.conf file in the $SPLUNK_HOME/etc/system/default/ directory. # Never change or copy the configuration files in the default directory. # The files in the default directory must remain intact and in their original # location. # # To set custom configurations, create a new file with the name global-banner.conf in # the $SPLUNK_HOME/etc/system/local/ directory. Then add the specific settings # that you want to customize to the local configuration file. # For examples, see global-banner.conf.example. You must restart the Splunk instance # to enable configuration changes. # # To learn more about configuration files (including file precedence) see the # documentation located at # http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles
* IMPORTANT: It is only possible to declare one global banner. This is the only stanza that Splunk Web will read. global_banner.visible = <bool> * Default: false global_banner.message = <string> * Default: Sample banner notification text. Please replace with your own message. global_banner.background_color = [green|blue|yellow|orange|red] * Default: blue global_banner.hyperlink = [http://<string>|https://<string>] * Default: none global_banner.hyperlink_text = <string> * Default: none
# Version 8.1.7 # # The following are example global-banner.conf configurations. Configure properties for # your custom application. # # To use one or more of these configurations, copy the configuration block into # app.conf in $SPLUNK_HOME/etc/system/local/. You must restart Splunk to # enable configurations. # # To learn more about configuration files (including precedence) please see the # documentation located at # http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles [BANNER_MESSAGE_SINGLETON] global_banner.visible = false global_banner.message = Sample banner notification text. Please replace with your own message. global_banner.background_color = blue global_banner.hyperlink = https://www.splunk.com/ global_banner.hyperlink_text = Splunk
Last modified on 17 November, 2021
This documentation applies to the following versions of Splunk® Enterprise: 8.1.7
Feedback submitted, thanks!