splunk-launch.conf

splunk-launch.conf

The following are the spec and example files for splunk-launch.conf.

splunk-launch.conf.spec

# Copyright (C) 2005-2011 Splunk Inc. All Rights Reserved.  Version 4.3.2 

# splunk-launch.conf contains values used during splunk 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
# Any 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 operating system when binding to
  ports/opening a listening socket.  This means it effectively binds to '*' or
  an unspecified bind.  The exact result of this is contolled 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).
* Typically useful for a host with multiple IP addresses, either to enable
  access or restrict access, though firewalling is typically a superior choice
  for restriction.
* Overrides the Splunkweb-specific setting in web.conf of server.socket_host
  for historical reasons.  That setting is preferred when SplunkWeb's behavior
  is the concern.
* Defaults to unset. 

SPLUNK_IGNORE_SELINUX=true
* If unset (not present), then 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.

#*******
# Service/server names.
#
# These settings are considered internal, and altering them is not supported.
# 
# On windows, they influence the expected name of the service; on unix they
# influence the reported name of the appropriate server or daemon process.
#*******

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).

splunk-launch.conf.example

No example

• Was this topic useful?
• Post a comment