Splunk® Enterprise

Admin Manual

Download manual as PDF

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

user-prefs.conf

The following are the spec and example files for user-prefs.conf.

user-prefs.conf.spec

# This file describes some of the settings that are used, and
# can be configured on a per-user basis for use by the Splunk Web UI.

# Settings in this file are requested with user and application scope
# of the relevant user, and the user-prefs app.  

# Additionally, settings by the same name which are available in the
# roles the user belongs to will be used at lower precedence.

# This means interactive setting of these values will cause the values
# to be updated in
# $SPLUNK_HOME/etc/users/user-prefs/<username>/local/user-prefs.conf
# where <username> is the username for the user altering their
# preferences.

# It also means that values in another app will never be used unless
# they are exported globally (to system scope) or to the user-prefs
# app.

# In practice, providing values in other apps isn't very interesting,
# since values from the authorize.conf roles settings are more
# typically sensible ways to defaults for values in user-prefs.

[general]

default_namespace = <app name>
* Specifies the app that the user will see initially upon login to the
  Splunk Web User Interface.
* This uses the "short name" of the app, such as launcher, or search,
  which is synonymous with the app directory name.
* Splunk defaults this to 'launcher' via the default authorize.conf

tz = <timezone>
* Specifies the per-user timezone to use
* If unset, the timezone of the Splunk Server or Search Head is used.
* Only canonical timezone names such as America/Los_Angeles should be
  used (for best results use the Splunk UI).
* Defaults to unset.


[default]
# Additional settings exist, but are entirely UI managed.
<setting> = <value>


user-prefs.conf.example

#   Version 6.2.3 
#
# This is an example user-prefs.conf.  Use this file to configure settings on a per-user 
# basis for use by the Splunk Web UI.
#
# To use one or more of these configurations, copy the configuration block into user-prefs.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://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles

# Note: These are examples.  Replace the values with your own customizations.


# EXAMPLE: Setting the default timezone to GMT for all Power and User role members. 

[role_power]
tz = GMT 

[role_user]
tz = GMT 

PREVIOUS
ui-prefs.conf
  NEXT
user-seed.conf

This documentation applies to the following versions of Splunk® Enterprise: 6.2.3


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

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

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters