Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Added documentation for dashboard authorization settings

  • Loading branch information...
commit d034f71e8b88642f5a8c9a577ff5ac53f0a03f1a 1 parent 682c07e
@captsens captsens authored
Showing with 25 additions and 0 deletions.
  1. +25 −0 docs/config-local-settings.rst
View
25 docs/config-local-settings.rst
@@ -228,6 +228,31 @@ LOGIN_URL
for directing users to an external authentication link such as for Remote User authentication
or a backend such as `django_openid_auth <https://launchpad.net/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 choosing *just one* of these three settings you can restrict those
+actions further. 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.
+
+DASHBOARD_REQUIRE_AUTHENTICATION
+ `Default: False`
+
+ If set to True, dashboards can only be saved and deleted by logged in users.
+
+DASHBOARD_EDIT_GROUP
+ `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.
+
+DASHBOARD_REQUIRE_PERMISSIONS
+ `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.
+
Database Configuration
----------------------
The following configures the Django database settings. Graphite uses the database for storing user
Please sign in to comment.
Something went wrong with that request. Please try again.