The following are the spec and example files for
# Version 6.1.14 # splunk-launch.conf contains values used at startup time, by the splunk command # and by windows services. # # Note: this conf file is different from most splunk conf files. There is only # one in the whole system, located at $SPLUNK_HOME/etc/splunk-launch.conf; further, # there are no stanzas, explicit or implicit. Finally, any # splunk-launch.conf files in etc/apps/... or etc/users/... will be ignored. # Lines beginning with a # are considered comments and are ignored. #******* # Environment variables # # Primarily, this file simply sets environment variables to be used by Splunk # programs. # # These environment variables are the same type of system environment variables # that can be set, on unix, using: # bourne shells: # $ export ENV_VAR=value # c-shells: # % setenv ENV_VAR value # # or at a windows command prompt: # C:\> SET ENV_VAR=value #******* <environment_variable>=<value> * Any desired environment variable can be set to any value. Whitespace is trimmed from around both the key and value. * Environment variables set here will be available to all splunk processes, barring operating system limitations. #******* # Specific Splunk environment settings # # These settings are primarily treated as environment variables, though some # have some additional logic (defaulting). # # There is no need to explicitly set any of these values in typical environments. #******* SPLUNK_HOME=<pathname> * The comment in the auto-generated splunk-launch.conf is informational, not a live setting, and does not need to be uncommented. * Fully qualified path to the Splunk install directory. * If unset, Splunk automatically determines the location of SPLUNK_HOME based on the location of splunk-launch.conf * Specifically, the parent of the directory containing splunk-launch.conf * Defaults to unset. SPLUNK_DB=<pathname> * The comment in the auto-generated splunk-launch.conf is informational, not a live setting, and does not need to be uncommented. * Fully qualified path to the directory containing the splunk index directories. * Primarily used by paths expressed in indexes.conf * The comment in the autogenerated splunk-launch.conf is informational, not a live setting, and does not need to be uncommented. * If unset, becomes $SPLUNK_HOME/var/lib/splunk (unix) or %SPLUNK_HOME%\var\lib\splunk (windows) * Defaults to unset. SPLUNK_BINDIP=<ip address> * Specifies an interface that splunkd and splunkweb should bind to, as opposed to binding to the default for the local operating system. * If unset, Splunk makes no specific request to the operating system when binding to ports/opening a listening socket. This means it effectively binds to '*'; i.e. an unspecified bind. The exact result of this is controlled by operating system behavior and configuration. * NOTE: When using this setting you must update mgmtHostPort in web.conf to match, or the command line and splunkweb will not know how to reach splunkd. * For splunkd, this sets both the management port and the receiving ports (from forwarders). * Useful for a host with multiple IP addresses, either to enable access or restrict access; though firewalling is typically a superior method of restriction. * Overrides the Splunkweb-specific web.conf/[settings]/server.socket_host param; the latter is preferred when SplunkWeb behavior is the focus. * Defaults to unset. SPLUNK_IGNORE_SELINUX=true * If unset (not present), Splunk on Linux will abort startup if it detects it is running in an SELinux environment. This is because in shipping/distribution-provided SELinux environments, Splunk will not be permitted to work, and Splunk will not be able to identify clearly why. * This setting is useful in environments where you have configured SELinux to enable Splunk to work. * If set to any value, Splunk will launch, despite the presence of SELinux. * Defaults to unset. SPLUNK_OS_USER = <string> | <nonnegative integer> * The OS user whose privileges Splunk will adopt when running, if this parameter is set. * Example: SPLUNK_OS_USER=fnietzsche, but a root login is used to start splunkd. Immediately upon starting, splunkd abandons root's privileges, and acquires fnietzsche's privileges; any files created by splunkd (index data, logs, etc.) will be consequently owned by fnietzsche. So when splunkd is started next time by fnietzsche, files will be readable. * When 'splunk enable boot-start -user <U>' is invoked, SPLUNK_OS_USER is set to <U> as a side effect. * Under UNIX, username or apposite numeric UID are both acceptable; under Windows, only a username. #******* # Service/server names. # # These settings are considered internal, and altering them is not supported. # # Under Windows, they influence the expected name of the service; on UNIX they # influence the reported name of the appropriate server or daemon process. # # If you want to run multiple instances of Splunk as *services* under Windows, # you will need to change the names below for 2nd, 3rd, ..., instances. That is # because the 1st instance has taken up service names 'Splunkd' and 'Splunkweb', # and you may not have multiple services with same name. #******* SPLUNK_SERVER_NAME=<name> * Names the splunkd server/service. * Defaults to splunkd (UNIX), or Splunkd (Windows). SPLUNK_WEB_NAME=<name> * Names the Python app server / web server/service. * Defaults to splunkweb (UNIX), or Splunkweb (Windows).
This documentation applies to the following versions of Splunk® Enterprise: 6.1.14