Customize the login page

Splunk Enterprise users can customize Splunk Web login page components. Splunk Cloud Platform customers cannot 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.	Create a new file called web.conf in the directory. 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

To edit the login page background, your role must hold the edit_server capability.

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.

Add a custom logo

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.	Create a new file called web.conf in the directory. 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.	Create a new file called web.conf in the directory. Add a [settings] stanza in the file.

3. In the local web.conf file, under [settings], create or edit the customFavicon setting to specify the app name and favicon file path. For the favicon file path, include the file path after your app's appserver/static directory. For example:

   [settings]
   customFavicon = <myApp:customfavicon/myFaviconFile.ico>

   [settings]
   customFavicon = <myApp:customfavicon/myDirectory/myFaviconFile.ico>

4. Restart the Splunk instance to view the change.