App directory structure

App directory structure

All Apps live in a custom directory, within $SPLUNK_HOME/etc/apps.

Note: When you build an App via appbuilder, all these directories are automatically created.

App Structure

Within this directory are the following subdirectories:

• Default/
  • Put all the Splunk configuration files your App needs in Default. All Apps must have an app.conf. Some may also contain savedsearches.conf, inputs.conf, or other relevant configuration files.

• Local/
  • Developers don't configure anything within the local dir. It is there for App users and admins to overwrite any default configurations.

Within both default and local directories, there are more subdirectories for configuring the UI. These are contained within $SPLUNK_HOME/etc/apps/<App_name>/<default or local>/data/UI/, and include:

• Nav/
  • This directory contains only default.xml. Use this file to create View Collections.

• Views/
  • Put all the views you create in this directory. Use views to build a custom UI.

Custom configurations

To add any custom modules, images, CSS or HTML to your App, add the appserver/static directories within your App's directory ($SPLUNK_HOME/etc/apps/<App_name>/). Use the static directory to:

• Change your App's style.
• Add Web resources.