Create a Splunk app

Create a Splunk app using Splunk Web to generate the directory structure for an app and the required files:

  1. On the Splunk Web home page, click the Gears icon next to Apps.
  2. Click Create app.
  3. On the Add new page, fill out the properties of the new app:
  4. Option Description
    Name The name of your app, which appears in the Splunk Web list and menu of apps.
    The name maps to the label setting in the app.conf configuration file.
    If you plan to upload your app to Splunkbase, follow the naming conventions as described in Naming conventions for apps and add-ons on Splunkbase in the Working with Splunkbase manual.
    Tip  Short app names are recommended to avoid issues with long file paths in Windows.
    Folder name The name to use for the directory in $SPLUNK_HOME/etc/apps/.
    The name of the folder cannot contain the "dot" (.) character.
    Version The app version string.
    Visible Indicates whether the app should be visible in Splunk Web.
    Apps that contain a user interface should be visible.
    Description A description of the app.
    Previous versions of Splunk Enterprise displayed the description on the Splunk Home page, however the current version of Splunk Enterprise does not use this description. If you plan to upload your app to Splunkbase, include a description because Splunkbase uses it to validate the app package.
    Author The author name.
    Template The template to use for creating your app.
    Select the "barebones" template to generate a basic app directory structure and a few required files. The "sample_app" template creates an app that includes sample dashboards, images, and CSS files for dashboard styling and behavior.
    Tip  You can create and add custom app templates to $SPLUNK_HOME/share/splunk/app_templates/.
    Upload asset Click Choose File to upload a single image, HTML, JavaScript, CSS, or other asset file to your app.
  5. Click Save.

A new directory for your app is created under the $SPLUNK_HOME/etc/apps directory. The following table shows the directories that are used by Splunk apps. The required directories are created when using the "barebones" template.

Directory

Description

App The directory for your app, app_name, under $SPLUNK_HOME/etc/apps.
App Contains resource files, such as images and style sheets.
App Contains resource files, including CSS, JS extensions, and icon files. See Client and server asset caching for more.
App Contains custom scripts for searches or scripted inputs.
App Contains configuration required by your app and dashboard files.
App Contains navigation and dashboard files.
App Contains navigation and dashboard files.
App Contains converted dashboards (HTML files).
App Contains your app's navigation file, default.xml.
App Contains Simple XML dashboards specific to your app.
App Contains modified versions of default configuration files or dashboards, which are located in /default. Splunk Enterprise creates this directory when the user makes any changes.
App Contains modified dashboards.
App Contains modified dashboards.
App Contains converted dashboards (HTML files).
App Contains modified simple XML dashboards (XML files).
App Contains lookup tables (CSV files).
App Contains permissions (META files). The default.meta file sets default permissions for the app. Permissions are private if this file is not present. Permission overrides by the user are set in the local.meta file.
App Contains resource files, including icon files.

Next steps