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 specified 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.

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.


Default: []

Metric data and graphs are cached for one minute by default. If defined, DEFAULT_CACHE_POLICY is a list of tuples of minimum query time ranges mapped to the cache duration for the results. This allows for larger queries to be cached for longer periods of times. All times are in seconds. An example configuration:

DEFAULT_CACHE_POLICY = [(0, 60), # default is 60 seconds
                        (7200, 120), # >= 2 hour queries are cached 2 minutes
                        (21600, 180)] # >= 6 hour queries are cached 3 minutes

This will cache any queries between 0 seconds and 2 hours for 1 minute, any queries between 2 and 6 hours for 2 minutes, and anything greater than 6 hours for 3 minutes. If the policy is empty or undefined, everything will be cached for DEFAULT_CACHE_DURATION.

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, CERES_DIR, LOG_DIR, and INDEX_FILE default paths are referenced.

Default: See below The location of Graphite-web’s static content. This defaults to static/ three parent directories up from In the default layout this is /opt/graphite/static.

This directory doesn’t even exist once you’ve installed graphite. It needs to be populated with the following command:

PYTHONPATH=$GRAPHITE_ROOT/webapp collectstatic --noinput --settings=graphite.settings

This collects static files for graphite-web and external apps (namely, the Django admin app) and puts them in a directory that needs to be available under the /static/ URL of your web server. To configure Apache:

Alias /static/ "/opt/graphite/static"

For Nginx:

location /static/ {
    alias /opt/graphite/static/;

Alternatively, static files can be served directly by the Graphite webapp if you install the whitenoise Python package.

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/ceres The location of Ceres 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, CERES_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 webapp.

Configure Webserver (Apache)

There is an example example-graphite-vhost.conf file in the examples directory of the graphite web source code. You can use this to configure apache. Different distributions have different ways of configuring Apache. Please refer to your distribution’s documentation on the subject.

For example, Ubuntu uses /etc/apache2/sites-available and sites-enabled/ to handle this (A symlink from sites-enabled/ to sites-available/ would be used after placing the file in sites-available/).

Others use an Include directive in the httpd.conf file like this:

# This goes in httpd.conf
Include /usr/local/apache2/conf/vhosts.d/*.conf

The configuration files must then all be added to /usr/local/apache2/conf/vhosts.d/. Still others may not help handle this at all and you must add the configuration to your http.conf file directly.

Graphite will be in the DocumentRoot of your webserver, and will not allow you to access plain-HTML in subdirectories without addition configuration. You may want to edit the example-graphite-vhosts.conf file to change port numbers or use additional "SetHandler None" directives to allow access to other directories.

Be sure to reload your Apache configuration by running sudo /etc/init.d/apache2 reload or sudo /etc/init.d/httpd reload.

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 alternately in LDAP_URI.


Default: 389

Set the LDAP server port here or alternately in LDAP_URI.


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).


Default: ‘’

Instead of using a hardcoded username and password for the account that binds to the LDAP server you could use the credentials of the user that tries to log in to Graphite. This is the template that creates the full DN to bind with.

Other Authentications


Default: False

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


Default: “django.contrib.auth.middleware.RemoteUserMiddleware”

Enables the use of an alternative remote authentication backend.


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.

Dashboard Authorization Configuration

These settings control who is allowed to save and delete dashboards. By default anyone can perform these actions, but by setting DASHBOARD_REQUIRE_AUTHENTICATION, users must at least be logged in to do so. The other two settings allow further restriction of who is able to perform these actions. Users who are not suitably authorized will still be able to use and change dashboards, but will not be able to save changes or delete dashboards.


Default: False

If set to True, dashboards can only be saved and deleted by logged in users.


Default: None

If set to the name of a user group, dashboards can only be saved and deleted by logged-in users who are members of this group. Groups can be set in the Django Admin app, or in LDAP.

Note that DASHBOARD_REQUIRE_AUTHENTICATION must be set to true - if not, this setting is ignored.


Default: False

If set to True, dashboards can only be saved or deleted by users having the appropriate (change or delete) permission (as set in the Django Admin app). These permissions can be set at the user or group level. Note that Django’s ‘add’ permission is not used.

Note that DASHBOARD_REQUIRE_AUTHENTICATION must be set to true - if not, this setting is ignored.

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 instead of the old DATABASE_* format. Users must use the new specification to have a working database.

See the Django documentation for full documentation of the DATABASES setting.


Remember, setting up a new database requires running PYTHONPATH=$GRAPHITE_ROOT/webapp migrate --settings=graphite.settings --run-syncdb to create the initial schema.


If you are using a custom database backend (other than SQLite) you must first create a $GRAPHITE_ROOT/webapp/graphite/ file that overrides the database related settings from Use $GRAPHITE_ROOT/webapp/graphite/ as a template.

If you are experiencing problems, uncomment the following line in /opt/graphite/webapp/graphite/

# DEBUG = True

and review your webapp logs. If you’re using the default graphite-example-vhost.conf, your logs will be found in /opt/graphite/storage/log/webapp/.

If you’re using the default SQLite database, your webserver will need permissions to read and write to the database file. So, for example, if your webapp is running in Apache as the ‘nobody’ user, you will need to fix the permissions like this:

sudo chown nobody:nobody /opt/graphite/storage/graphite.db

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 also be enabled and configured accordingly.


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.


Default: carbon_ch

Possible values: carbon_ch, fnv1a_ch

The default carbon_ch is Graphite’s traditional consistent-hashing implementation. Alternatively, you can use fnv1a_ch, which supports the Fowler–Noll–Vo hash function (FNV-1a) hash implementation offered by the carbon-c-relay relay project.

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.