web.conf

web.conf

web.conf contains settings for the SplunkWeb interface.

web.conf.spec

# Copyright (C) 2005-2007 Splunk Inc.  All Rights Reserved.  Version 3.0 
#
# This file contains possible attributes and values for a web.conf.
#
# Configuration options for the Splunk application server/SplunkWeb GSplunkWeb.
#
[settings]
startwebserver = [0 | 1]
   * Set whether or not to start SplunkWeb.
   * 0 will disable SplunkWeb, 1 will enable it.
   * Defaults to 1.
httpport = <port_number>
   * Must be present for SplunkWeb to start.
   * If omitted or 0 the server will NOT start an http listener.
   * Defaults to 8000.
   
mgmtHostPort = <IP:port>
   * Location of splunkd
   * Don't include http[s]:// -- just the IP address.
   * Defaults to 127.0.0.1:8089.
   
twistedLoginTimeout = <seconds_until_timeout>
   * Number of seconds before the twisted session times out
   * After <second_until_timeout>, idle users get redirected to login. 
   * Defaults to 3600.
   
restApiPostMode = [none | permissive | strict]
   * Set level of checking the REST API performs on form submissions.
   * none = does not check; GET and POST are allowed.
   * permissive = warns if REST method should be accessed via POST method.
   * strict = throws error if POST-only REST method is accessed via GET.
   * Defaults to permissive.
enableRestControlApi = [True | False]
   * Toggle the REST API /v3/controlapi/ endpoint on or off.
   * Defaults to false.
privKeyPath = /certs/privkey.pem
caCertPath = /certs/cert.pem
   * Set path to SSL certificate files to enable HTTPS.
   
isHosted = [True | False]
   * Sets 'hosted' mode, which controls whether users can save/alter options.
   * Please note: setting this to true is not recommendedt
   * Defaults to false.
disablePersistedPrefs = <string>
   * When set, prefs changes for those users will not be persisted across sessions. 
   * Can be a comma-separated list of user-types
   * For example, set to <User> to disable the persistence of preferences for all 'User' type accounts.  
   * Can also be User,Power,  User,Power,Admin etc... 
   * set to comma separated list of user-types, ex: User or User,Power,Admin.
   * Generally useful when many people are sharing the same account.
   * Defaults to User.
         
distributedStatusMessages
   * Configuration for various status messages that can come back from servers 
         in distributed search.
   * Defaults to notauthenticated:bad auth,invaliduserorpsw:bad login,down:unreachable,versionMismatch:version mismatch,productMismatch:no license,missingServerName:no server name
   
serviceFormPostURL = http://headlamp.splunk.com/event/add
userRegistrationURL = https://www.splunk.com/index.php/pre_reg?destination=prod_reg
userEntTrialRegistrationURL = https://www.splunk.com/index.php/sign_up?destination=prod_reg
userResendRegistrationURL =https://www.splunk.com/index.php/pre_reg?destination=prod_resend
docsCheckerBaseURL=http://quickdraw.splunk.com/help
updateCheckerBaseURL = http://quickdraw.splunk.com/js/
   * These are various Splunk.com urls that are configurable. 
   * Setting updateCheckerBaseURL to 0 will stop SplunkWeb from pinging Splunk.com 
         for new versions of itself. 
uiversion = [pinesol | oxiclean]
   * Toggle which version of SplunkWeb to load.
   * Must be set to either pinesol, or oxiclean. 
   * Not recommended in customer installations.   When set to pinesol, Splunk 
         will try to start with the legacy 2.1 and 2.2 front-end. 
   * NOTE: when using the pinesol front-end with Splunk 3.0, not all features will work correctly.
numberOfEventsPerCard = <integer>
   * Configuration for the number of events that the Endless Scroller asks the 
     server for with each request.
   * Defaults to 10.
numberOfCardsPerDeck = <integer>
   * Configuration for the number of requests that the Endless Scroller will 
     make before it starts to recycle space occupied by prior pages.
   * Defaults to 7.
#
# Configuration options for the administration section in SplunkWeb.
#
[adminTabs]
_order = <string>
   * Comma-separated values of the tab paths. 
   * Controls the order of the tabs in SplunkWeb.
   * Defaults to settings,datainputs,distributed,users,saved,license.
<pathToAdminSection>_label = <string>
   * Set the label on the tab that appears in SplunkWeb.
   * Map from _order.
   * Defaults are:
    settings_label = Server
    datainputs_label = Data Inputs
    distributed_label = Distributed
    users_label = Users
    saved_label = Saved Searches
    license_label = License & Usage
<pathToAdminSection>_roles = <string>
   * Comma-separated list that maps the tabs in SplunkWeb to roles.
   * Tab will only appear for users in one of those roles.
   * NOTE - for non-admin users there is a special tab called 'my account' that 
         appears, and that tab is not configurable here.
   * Defaults to:
   settings_roles = Admin
   datainputs_roles = Admin
   distributed_roles = Admin
   users_roles = Admin
   saved_roles = Admin,Power,User
   license_roles = Admin

web.conf.example

# Copyright (C) 2005-2007 Splunk Inc.  All Rights Reserved.  Version 3.0 
#
# Example settings for web.conf.spec file.
# You can use this example configuration file to customize your web settings.
[settings]
#port number tag is missing or 0 the server will NOT start an http listener 
httpport = 8000
# don't include http[s]:// in this anymore.
mgmtHostPort = localhost:8089
privKeyPath = /certs/privkey.pem
caCertPath = /certs/cert.pem
serviceFormPostURL = http://headlamp.splunk.com/event/add
userRegistrationURL = https://www.splunk.com/index.php/pre_reg?destination=prod_reg
updateCheckerBaseURL = http://quickdraw.splunk.com/js/
startwebserver = 1
# Endless Scroller configuration.  
# If you deal with almost all multiline data, you may be better served by 
# lower defaults, which mean fewer events will be requested at a time. 
numberOfEventsPerCard = 5
numberOfCardsPerDeck = 3

• Was this topic useful?
• Post a comment