setup.conf

setup.conf

Each Splunk application can have a setup.conf file to specify how it interacts with Splunk and with other Splunk applications. For each application, setup.conf is located in $SPLUNK_HOME/etc/apps/<application name>/default, where SPLUNK_HOME is the directory into which you installed Splunk and <application name> is the name of the specific application. If you want to edit setup.conf for a given application, make your edits in that application's local directory. This way, they will not be overwritten if you upgrade/update the application.

Use setup.conf to provide instructions to Splunk about how a particular Splunk application interacts with Splunk and with other Splunk applications.

setup.conf.spec

# Copyright (C) 2005-2008 Splunk Inc.  All Rights Reserved.  Version 3.4
#
# This file contains possible setup options for an individual Splunk application.
# Each Splunk application can have its own setup.conf file. 
# The setup.conf file is used when you enable or disable a given application to 
# make changes to a Splunk configuration that are beyond those available using 
# the normal configuration system.
# In the setup.conf file, you can specify the following:
#  * Files to be manipulated. You can specify that a file or files needed by this application 
#    (images or css files, for example) replace another file or files. 
#  * Other Splunk applications that are required or not supported when this application is enabled.
#    You can specify that an application is explicitly required or just that it be enabled if it 
#    is available. 
#  * Scripts to be run when this application is enabled or disabled.
#  * Splunk module(s) to be enabled or disabled. This option is rarely used except for in the 
#    Splunk Light Forwarder configuration. 
# You can specify multiple items in each stanza.
# 
# To learn more about configuration files (including precedence) please see the documentation 
# located at http://www.splunk.com/base/Documentation/latest/Admin/HowDoConfigurationFilesWork.
#
# To enable these configurations, you must enable or disable for a given application. 
# Splunk will then ask you to restart. 
#####################
# Files Stanza
#####################
# Use this stanza to put in place specific files local to this application to specified locations 
# within a Splunk installation.
[files]
SOURCE_LOCATION = DEST_LOCATION 
#####################
# Apps Stanza
#####################
# Use this stanza to specify other Splunk applications that are required or not supported when this
# application is running. The difference between "enabled" and "required" is that "enabled" will 
# not produce an error if the specified application is not present.
[apps]
APP_NAME = disabled | enabled | required
#####################
# Scripts Stanza
#####################
# Use this module to specify that a particular script or scripts be run when this application 
# is enabled or disabled.
[scripts]
enabled = SCRIPT_LOCATION
disabled = SCRIPT_LOCATION 
#####################
# Modules Stanza
#####################
# Use this stanza to specify that a particular Splunk module or modules be enabled or disabled when 
# this application is enabled. Modules are defined in $SPLUNK_HOME/etc/modules and are where
# Splunk's internal pipelines and processors are defined. Disabling a module should be done with 
# care and is not a typical application operation. 
[modules]
MODULE_NAME = disabled | enabled 

• Was this topic useful?
• Post a comment