Graphite-web uses the convention of importing a file from the webapp module. This is where Graphite-web’s runtime configuration is loaded from.

Config File Location is generally located within the main graphite module where the webapp’s code lives. In the default installation layout this is /opt/graphite/webapp/graphite/ Alternative locations can be used by symlinking to this path or by ensuring the module can be found within the Python module search path.

General Settings


Default: America/Chicago

Set your local timezone. Timezone is specifed using zoneinfo names.



Overrides the Documentation link used in the header of the Graphite Composer


Default: False

Triggers the creation of rendering.log which logs timings for calls to the The Render URL API


Default: False

Triggers the creation of cache.log which logs timings for remote calls to carbon-cache as well as Request Cache (memcached) hits and misses.


Default: False

Trigges the creation of metricaccess.log which logs access to Whisper and RRD data files

DEBUG = True

Default: False

Enables generation of detailed Django error pages. See Django’s documentation for details


Default: <unset>

If set, executes rrdtool flushcached before fetching data from RRD files. Set to the address or socket of the rrdcached daemon. Ex: unix:/var/run/rrdcached.sock


Default: []

If set, enables the caching of calculated targets (including applied functions) and rendered images. If running a cluster of Graphite webapps, each webapp should have the exact same values for this setting to prevent unneeded cache misses.

Set this to the list of memcached hosts. Ex: ['', '', '']


Default: 60

Default expiration of cached data and images.

Filesystem Paths

These settings configure the location of Graphite-web’s additional configuration files, static content, and data. These need to be adjusted if Graphite-web is installed outside of the default installation layout.

Default: /opt/graphite The base directory for the Graphite install. This setting is used to shift the Graphite install from the default base directory which keeping the default layout. The paths derived from this setting can be individually overridden as well
Default: GRAPHITE_ROOT/conf The location of additional Graphite-web configuration files
Default: GRAPHITE_ROOT/storage The base directory from which WHISPER_DIR, RRD_DIR, LOG_DIR, and INDEX_FILE default paths are referenced
Default: See below The location of Graphite-web’s static content. This defaults to content/ two parent directories up from In the default layout this is /opt/graphite/webapp/content
Default: CONF_DIR/dashboard.conf The location of the Graphite-web Dashboard configuration
Default: CONF_DIR/graphTemplates.conf The location of the Graphite-web Graph Template configuration
Default: /opt/graphite/storage/whisper The location of Whisper data files
Default: /opt/graphite/storage/rrd The location of RRD data files
Default: [WHISPER_DIR, RRD_DIR] The list of directories searched for data files. By default, this is the value of WHISPER_DIR and RRD_DIR (if rrd support is detected). If this setting is defined, the WHISPER_DIR and RRD_DIR settings have no effect.
Default: STORAGE_DIR/log/webapp The directory to write Graphite-web’s log files. This directory must be writable by the user running the Graphite-web webapp
Default: /opt/graphite/storage/index The location of the search index file. This file is generated by the script and must be writable by the user running the Graphite-web webap

Email Configuration

These settings configure Django’s email functionality which is used for emailing rendered graphs. See the Django documentation for further detail on these settings

Default: django.core.mail.backends.smtp.EmailBackend Set to django.core.mail.backends.dummy.EmailBackend to drop emails on the floor and effectively disable email features.
Default: localhost
Default: 25
Default: ‘’
Default: ‘’
Default: False

Authentication Configuration

These settings insert additional backends to the AUTHENTICATION_BACKENDS and MIDDLEWARE_CLASSES settings. Additional authentication schemes are possible by manipulating these lists directly.


These settings configure a custom LDAP authentication backend provided by Graphite. Additional settings to the ones below are configurable setting the LDAP module’s global options using ldap.set_option. See the module documentation for more details.

# SSL Example
import ldap
ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_ALLOW)
ldap.set_option(ldap.OPT_X_TLS_CACERTDIR, "/etc/ssl/ca")
ldap.set_option(ldap.OPT_X_TLS_CERTFILE, "/etc/ssl/mycert.pem")
ldap.set_option(ldap.OPT_X_TLS_KEYFILE, "/etc/ssl/mykey.pem")
Default: False

Default: ‘’

Set the LDAP server here or alternativly in LDAP_URL


Default: 389

Set the LDAP server port here or alternativly in LDAP_URL


Default: None

Sets the LDAP server URI. E.g. ldaps://


Default: ‘’

Sets the LDAP search base. E.g. OU=users,DC=mycompany,DC=com


Default: ‘’

Sets the base LDAP user to bind to the server with. E.g. CN=some_readonly_account,DC=mycompany,DC=com


Default: ‘’

Sets the password of the base LDAP user to bind to the server with.


Default: ‘’

Sets the LDAP query to return a user object where %s substituted with the user id. E.g. (username=%s) or (sAMAccountName=%s) (Active Directory)

Other Authentications


Default: False

Enables the use of the Django RemoteUserBackend authentication backend. See the Django documentation for further details


Default: /account/login

Modifies the URL linked in the Login link in the Composer interface. This is useful for directing users to an external authentication link such as for Remote User authentication or a backend such as django_openid_auth

Database Configuration

The following configures the Django database settings. Graphite uses the database for storing user profiles, dashboards, and for the Events functionality. Graphite uses an Sqlite database file located at STORAGE_DIR/graphite.db by default. If running multiple Graphite-web instances, a database such as PostgreSQL or MySQL is required so that all instances may share the same data source.


As of Django 1.2, the database configuration is specified by the DATABASES dictionary. For compatibility with Django 1.1, Graphite’s default Sqlite database configuration still uses the old method. This means that users running under Django 1.4 will not have a working default. In any case, it is recommended that all users on Django 1.2 or above explicitly specify a database configuration using the new format

See the Django documentation for full documentation of the DATABASE setting. Users on Django 1.1 will require setting the deprecated DATABASE_* settings outlined in the Django 1.1 documentation


Remember, setting up a new database requires running syncdb to create the initial schema

Cluster Configuration

These settings configure the Graphite webapp for clustered use. When CLUSTER_SERVERS is set, metric browse and render requests will cause the webapp to query other webapps in CLUSTER_SERVERS for matching metrics. Graphite will use only one successfully matching response to render data. This means that metrics may only live on a single server in the cluster unless the data is consistent on both sources (e.g. with shared SAN storage). Duplicate metric data existing in multiple locations will not be combined.


Default: []

The list of IP addresses and ports of remote Graphite webapps in a cluster. Each of these servers should have local access to metric data to serve. The first server to return a match for a query will be used to serve that data. Ex: [“”, “”]


Default: 6

Timeout for remote data fetches in seconds


Default: 2.5

Timeout for remote find requests (metric browsing) in seconds


Default: 60

Time in seconds to blacklist a webapp after a timed-out request


Default: 300

Time to cache remote metric find results in seconds


Default: False

Enable remote rendering of images and data (JSON, et al.) on remote Graphite webapps. If this is enabled, RENDERING_HOSTS must be configured below


Default: []

List of IP addresses and ports of remote Graphite webapps used to perform rendering. Each webapp must have access to the same data as the Graphite webapp which uses this setting either through shared local storage or via CLUSTER_SERVERS. Ex: [“”, “”]


Default: 1.0

Connection timeout for remote rendering requests in seconds


Default: []

If multiple carbon-caches are running on this machine, each should be listed here so that the Graphite webapp may query the caches for data that has not yet been persisted. Remote carbon-cache instances in a multi-host clustered setup should not be listed here. Instance names should be listed as applicable. Ex: [‘’,‘’, ‘’]


Default: 1.0

Timeout for carbon-cache cache queries in seconds

Additional Django Settings

The shipped with Graphite-web imports into the namespace to allow further customization of Django. This allows the setting or customization of standard Django settings and the installation and configuration of additional middleware. To manipulate these settings, ensure is imported as such:

from graphite.app_settings import *

The most common settings to manipulate are INSTALLED_APPS, MIDDLEWARE_CLASSES, and AUTHENTICATION_BACKENDS