Splunk® Enterprise

Developing Views and Apps for Splunk Web

Download manual as PDF

Download topic as PDF

Customize the login page

Splunk Enterprise users can customize Splunk Web login page components.

Add custom text

If you are using Splunk Enterprise, you can customize the Splunk platform login page with plain or HTML formatted text.

Prerequisite

Review the login_content setting details in the web.conf spec file.

Steps

  1. Check the $SPLUNK_HOME/etc/system/local/ directory for a web.conf file. Use one of the following options.

    File already exists in the directory File does not exist in the directory
    Locate the [settings] stanza in the file.
    1. Create a new file called web.conf in the directory.
    2. Add a [settings] stanza in the file.
  2. In the local web.conf file, add or edit the login_content string under the [settings] stanza.
    login_content = <content_string>
    

    Ensure that the text and formatting are no longer than one line in the configuration file. See the custom text example.

  3. Restart the Splunk instance to view the change.

Example

[settings]
login_content = This is a <b>production server</b>.<br>For expensive searches try: <a href="http://server2:8080">server2</a>

Customize the login page background

If you are using Splunk Enterprise, you can use Splunk Web to customize the login page background. Display a custom image, a default image, or no image.

You can also configure the login page background image using the loginCustomBackgroundImage and loginBackgroundImageOption settings in $SPLUNK_HOME/etc/system/local/web.conf. See the web.conf spec file for more information.

Note: Image alignment and scaling customizations are not available. Depending on the browser window size, the background image appearance can vary.

Prerequisites

If you are adding a custom image, make sure that the image file meets the following requirements.

  • Use a .jpg, .jpeg, or .png formatted file.
  • A landscape oriented image is recommended.
  • The maximum file size is 20MB.
  • The suggested minimum image size is 1024x640 pixels.

Steps

  1. Log into the Splunk instance and navigate to Settings > System > Server Settings > Login Background.
  2. Select one of the following options.
    Background option Description
    Custom image To use a custom background, upload the image file and click Choose.
    Default image Use the default background image.
    No image Do not display an image on the login page.
  3. Use the Preview screen to preview the login page customization.
  4. Click Save.
  5. Restart the Splunk instance to view the changes.

If you are using Splunk Enterprise, you can customize the login page logo.

Prerequisites

  • The maximum image size is 485px wide and 100px high. If the image exceeds these limits, the image is automatically resized.
  • Review the loginCustomLogo setting details in the web.conf spec file.

Steps

  1. (Optional) If you are using an image file, put it into the following directory location.
    $SPLUNK_HOME/etc/apps/<app_name>/appserver/static/logo
    
  2. Check the $SPLUNK_HOME/etc/system/local/ directory for a web.conf file. Use one of the following options.

    File already exists in the directory File does not exist in the directory
    Locate the [settings] stanza in the file.
    1. Create a new file called web.conf in the directory.
    2. Add a [settings] stanza in the file.
  3. In the local web.conf file, add or edit the loginCustomLogo setting under the [settings] stanza. Indicate the loginCustomLogo file path or an image URL.
  4. Restart the Splunk instance to view the change.

Use a custom favicon

Splunk Enterprise users can add a custom favicon to use across Splunk Web.

Prerequisites

  • Review the customFavicon setting details in the web.conf spec file.
  • Make sure that the favicon image file meets the following requirements.
    • Use only an .ico formatted file.
    • The image must be square. No other image shapes are supported.

Steps

  1. Put the image file into the following directory location.
    $SPLUNK_HOME/etc/apps/<app_name>/appserver/static/customfavicon
    
  2. Check the $SPLUNK_HOME/etc/system/local/ directory for a web.conf file. Use one of the following options.

    File already exists in the directory File does not exist in the directory
    Locate the [settings] stanza in the file.
    1. Create a new file called web.conf in the directory.
    2. Add a [settings] stanza in the file.
  3. In the local web.conf file, add or edit the customFavicon setting under the [settings] stanza. Indicate the customFavicon file path.
  4. Restart the Splunk instance to view the change.
PREVIOUS
Customization options and caching
  NEXT
Customize dashboard styling and behavior

This documentation applies to the following versions of Splunk® Enterprise: 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.6.0, 6.6.1, 6.6.2, 6.6.3


Comments

Hi @Woodcock,
Thanks for pointing this out. I've updated the docs to mention the conf file setting in our instructions for updating the logo.

Frobinson splunk, Splunker
October 11, 2016

The required loginCustomLogo setting should be documented:
https://answers.splunk.com/answers/462935/new-functionality-in-splunk-65-to-add-a-logo-is-no.html

Woodcock
October 11, 2016

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters