Admin Manual

 


How Splunk Works

server.conf

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.

server.conf

server.conf controls SSL settings for your Splunk server.

server.conf.spec

# This file contains possible attributes and values you can use to configure SSL and HTTP server options
# in server.conf.
#
# There is a server.conf in $SPLUNK_HOME/etc/bundles/default/.  To set custom configurations, 
# place a server.conf in your own custom bundle directory.  For examples, see server.conf.example.
#
# For help creating a bundle directory, or to learn more about bundles (including bundle precedence)
# please see the documentation located at http://www.splunk.com/doc/latest/admin/bundleconfig.
# This file contains options for controlling the server configuration
# The only options currently available is controlling the SSL 
# configuration of the server.
##########################################################################################
# SSLConfiguration details
##########################################################################################
[sslConfig]
	* Set SSL for the back-end under this stanza name.
		* NOTE: to set SSL for SplunkWeb and the browser, use web.conf.
	* Follow this stanza name with any number of the following attribute/value pairs.  
	* If you do not specify an entry for each attribute, Splunk will use the default value.
enableSplunkdSSL = <true|false>
	* Enables/disables SSL on the splunkd management port (8089).
    * Defaults to false.
          
keyfile = <filename>
        * Server certificate and key file. 
        * Certificates are auto-generated by splunkd upon starting Splunk.
        * You may replace the default cert with your own PEM format file.
        * Certs are stored in caPath (see below).
        * Default is server.pem.
        
keyfilePassword = <password>
        * Server certificate password.
        * Default is password.
caCertFile = <filename>
        * Public key of the signing authority.
        * Default is cacert.pem.
caPath = <path>
        * path where all these certs are stored.
        * Default is $SPLUNK_HOME/etc/auth.
        
certCreateScript = <script name>
        * Creation script for generating certs on startup 
          of Splunk.
        * Default is genSignedServerCert.sh
##########################################################################################
# Splunkd HTTP server configuration
##########################################################################################
[httpServer]
	* Set stand-alone HTTP settings for Splunk under this stanza name.
	* Follow this stanza name with any number of the following attribute/value pairs.  
	* If you do not specify an entry for each attribute, Splunk will use the default value.
atomFeedStylesheet = <string>
        * Defines the stylesheet relative URL to apply to default Atom feeds.
        * Set to 'none' to stop writing out xsl-stylesheet directive.  
        * Default value is '/static/atom.xsl'.
max-age = <int>
        * Set the maximum time (in seconds) to cache a static asset served off of the '/static' directory.
        * This value is passed along in the 'Cache-Control' HTTP header.
        * Default value is 3600.
          
follow-symlinks = <true|false>
        * Toggle whether static file handler (serving the '/static' directory) follow filesystem 
          symlinks when serving files.  
        * Default value is 'false'.
          
##########################################################################################
# Static file handler MIME-type map
[mimetype-extension-map]
	* This maps filename extensions to MIME types for files that are served from the static file handler.  
		* Ex: html = text/html
		* Ex: xsl = text/xml
<file-extension> = <MIME-type>
        * Instructs the HTTP static file server to mark any files ending in'file-exension' 
         with a header of 'Content-Type: <MIME-type>'.
        * If no extension is matched, then default is 'application/octet-stream'.

server.conf.example

# This file contains an example server.conf.  Use this file to configure SSL and HTTP server options.
#
# To use one or more of these configurations, copy the configuration block into
# server.conf in your own custom bundle.
#
# For help creating a bundle directory, or to learn more about bundles (including bundle precedence)
# please see the documentation located at http://www.splunk.com/doc/latest/admin/bundleconfig.
#
# Turn on SSL:
[sslConfig]
enableSplunkdSSL = true
keyfile = server.pem
keyfilePassword = password
caCertFile = cacert.pem
caPath = $$SPLUNK_HOME/etc/auth
certCreateScript = genSignedServerCert.sh

This documentation applies to the following versions of Splunk: 3.2 , 3.2.1 , 3.2.2 , 3.2.3 , 3.2.4 , 3.2.5 , 3.2.6 View the Article History for its revisions.


You must be logged into splunk.com in order to post comments. Log in now.

Was this documentation topic helpful?

If you'd like to hear back from us, please provide your email address:

We'd love to hear what you think about this topic or the documentation as a whole. Feedback you enter here will be delivered to the documentation team.

Feedback submitted, thanks!