App.conf

App.conf

Configure app.conf to make your app visible to Splunk Web. If you're using app builder, it will configure this for you.

Configuration

To enable your app and make it in Splunk Web add the following stanza to $SPLUNK_HOME/etc/apps/<app_name>/default/app.conf:

[ui]
is_visible = true
label = <name>

• Stanza must have the [ui] header.
• Set is_visible to true if you want your app to appear in the drop-down menu in Splunk Web.
• Set label to the name of your app.

add your app to the app launcher

Add the following stanza to app.conf to add your app into the app launcher. Fill out each attribute as described.

[launcher]
author=<author of app>
description=<textual description of app>
version=<version of app> 

Make sure you add an the following images to your app's ../appserver/static/ directory:

• appIcon_<appname>.png: this icon shows up in the launcher to the left of to your app name. App icons must be 36x36 pixels, in PNG format.
• screenshot_<appname>.png: this screenshot shows up in launcher above your app description. Screenshots should be a minimum of 490 x 275 pixels. If they are larger, they will be automatically cropped. They should also be PNG format.

Update static content

Splunk's appserver caches all the static assets in your app (such as images, CSS and Javascript). If you release a new version of your app, you can set app.conf to make your updated assets available to users. Add the install stanza attribute to your app.conf file, and specify a build number. For example:

[install]
build = 2

• Stanza must have the [install] header.
• Set the build number to a unique ID. This way, when someones installs a new version of your app, they will get all the new assets you package with your app.

If you want to reload your app's static content while you're working on the app and you don't want to clear your browser cache, hit this URI and click the button there:

http://localhost:8000/_bump

(Replace with your Splunk host:port.)

• Was this topic useful?
• Post a comment