Configure app properties

App properties include the values you set when you created the app, such as the name and description, as well as additional properties for Splunkbase and other features. This section describes how to:

To change the app navigation bar, including the background color, see Add navigation to a Splunk app.

 

Modify the app configuration

The following settings are included in the default app.conf file. For details about other properties you can set, including ones that are required by Splunkbase, see the app.conf specification in the Admin Manual.

Setting

Description

is_configured A Boolean that indicates whether the user has run the custom setup for your app (1 is true, 0 is false).
is_visible A Boolean that indicates whether your app is visible in Splunk Web (1 is true, 0 is false).
label The name of your app, which appears in Splunk Web.
author The author's name.
For apps you intend to post to Splunkbase, enter the username of your splunk.com account.
description A short description of your app.
version A string containing the version of your app, such as "1.0.0" or "2.0beta".
For apps you intend to post to Splunkbase, make sure that the version number in app.conf matches the version number on Splunkbase.

Here is what the default "barebones" app.conf file looks like:

#
# Splunk app configuration file
#

[install]
is_configured = 0

[ui]
is_visible = 1
label = NAME OF YOUR APP

[launcher]
author = 
description = DESCRIPTION
version = 1.0

To change the properties for your app, edit the app.conf file:

  1. In a text editor, open $SPLUNK_HOME/etc/apps/your_app_name/default/app.conf.
  2. Make your changes and save the file.
  3. To view your changes, restart Splunk Web or refresh the app (open http://<localhost:port>/debug/refresh URL in your web browser, click Refresh, then reload the dashboard in the browser).
 

Update static assets for new versions of an app

When you release a new version of your app, you can update the static assets for your users by using a build number in your app.conf file. Static assets include images, CSS, and JavaScript files that are located in the app's /appserver/static/ folder.

To use a build number, add an install stanza to your app.conf file with a build property set to a single integer. Then, each time you release a new version of your app that also changes static assets, increment both the build number and the version number. This process ensures that browsers won't use cached copies of old static files for new versions of your app.

For example, add the following stanza to your app.conf file:

[install]
build = 2
 

Specify a setup page

If you are using a setup page, which is displayed the first time a user runs your app, specify the setup page by adding a ui stanza to your app.conf file with a setup_view property.

By default, when requesting any view from your app, Splunk Enterprise checks the setup_view property in the install stanza to determine whether the app has been configured. If the app is not configured, the setup page is displayed.

Here is an example of the app.conf setup page configuration:

[install]
is_configured = false

[ui]
setup_view = my_custom_setup_page

For more, see Create a setup page for a Splunk app.

 

Add icons to your app

You can display icons to your app in the Splunk Web app list and on the app menu:

App list

App menu

To display an icon for your app:

  1. Create the icon files below, in PNG format, preferrably with 24-bit transparency.
  2. Name the icon files as listed below. Filenames are case sensitive.
  3. Save icon files to $SPLUNK_HOME/etc/apps/your_app_name/static/.

The following table describes the requirements for app icons:

Filename Image size (pixels) Placement Example image
appIcon_2x.png 72 x 72 App list on the Splunk Web home page
(high resolution displays)
appIcon.png 36 x 36 App list on the Splunk Web home page
(standard resolution displays)
appIconAlt_2x.png 72 x 72 App menus for Splunk bar and search bar
(high resolution displays)
appIconAlt.png 36 x 36 App menus for Splunk bar and search bar
(standard resolution displays)
appLogo.png 160 x 40
(Maximum size)
App Bar on standard resolution displays
appLogo_2x.png 320 x 80
(Maximum size)
App Bar on high resolution displays

Notes

  • The app icons are listed in the order of precedence used by Splunkbase (the first icon found, in this order, is the one that is used).
  • High resolution displays include MacBookPro with Retina Display.