server.conf

server.conf

server.conf controls SSL and HTTP settings for your Splunk server.

server.conf.spec

# Copyright (C) 2005-2008 Splunk Inc.  All Rights Reserved.  Version 3.0
#
# 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/system/default/.  To set custom configurations, 
# place a server.conf in $SPLUNK_HOME/etc/system/local/.  For examples, see server.conf.example.
# You must restart Splunk to enable configurations.
#
# To learn more about configuration files (including precedence) please see the documentation 
# located at http://www.splunk.com/base/Documentation/latest/Admin/HowDoConfigurationFilesWork.
# This file contains options for controlling the server configuration
# The only options currently available is controlling the SSL 
# configuration of the server.
##########################################################################################
# SSL Configuration details
##########################################################################################
[sslConfig]
        * Set SSL for communications on Splunk's back-end under this stanza name.
                * NOTE: To set SSL (eg HTTPS) for Splunk Web 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 true.
useClientSSLCompression = <true | false>
    * Turns on HTTP client compression. 
    * Server-side compression is turned on by default; setting this on the client side enables 
    compression between server and client.  
    * Enabling this potentially gives you much faster distributed searches across multiple 
    Splunk instances.
    * 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).
    * Defaults to server.pem.
        
keyfilePassword = <password>
        * Server certificate password.
    * Defaults to password.
caCertFile = <filename>
        * Public key of the signing authority.
        * Defaults to cacert.pem.
caPath = <path>
        * Path where all these certs are stored.
    * Defaults to SPLUNK_HOME/etc/auth.
        
certCreateScript = <script name>
    * Script for generating certs on Splunk startup.
    * Defaults to genSignedServerCert.py.
##########################################################################################
# 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 uses 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.  
    * Defaults to /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.
    * Defaults to 3600.
          
follow-symlinks = <true|false>
    * Toggle whether static file handler (serving the '/static' directory) follow filesystem 
      symlinks when serving files.  
    * Defaults to false.
          
##########################################################################################
# Static file handler MIME-type map
[mimetype-extension-map]
        * Map filename extensions to MIME type for files served from the static file handler under
        this stanza name.
        
<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>'.
    * Defaults to:
    
    [mimetype-extension-map]
	gif = image/gif
	htm = text/html
	jpg = image/jpg
	png = image/png
	txt = text/plain
	xml = text/xml
	xsl = text/xml
        
##########################################################################################
# Remote applications configuration (e.g. SplunkBase)
##########################################################################################
[applicationsManagement]
        * Set remote applications 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 uses the default value.
url = <URL>
        * Applications repository.
        * Defaults to http://www.splunkbase.com/api/apps
loginUrl = <URL>
        * Applications repository login.
        * Defaults to http://www.splunkbase.com/api/account:login/
useragent = <splunk-version>-<splunk-build-num>-<platform>
        * User-agent string to use when contacting applications repository.
        * <platform> includes information like operating system and CPU architecture.

server.conf.example

# Copyright (C) 2005-2008 Splunk Inc.  All Rights Reserved.  Version 3.0 
#
# 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 $SPLUNK_HOME/etc/system/local/. You must restart Splunk to enable configurations.
#
# To learn more about configuration files (including precedence) please see the documentation 
# located at http://www.splunk.com/base/Documentation/latest/Admin/HowDoConfigurationFilesWork.
[sslConfig]
enableSplunkdSSL = true
useClientSSLCompression = true
keyfile = MYserver.pem
keyfilePassword = password
caCertFile = MYcacert.pem
caPath = $$SPLUNK_HOME/etc/apps/MYAPP/auth/
certCreateScript = MYgenSignedServerCert.py

• Was this topic useful?
• Post a comment