Initial docs for dashboard permissions, refs #27

simonw · Mar 19, 2021 · c3770f7 · c3770f7
1 parent bd19486
commit c3770f7
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -21,8 +21,10 @@ maxdepth: 3
 ---
 setup
 sql
+saved-dashboards
 widgets
 contributing
+
 ```
 
 ![Django_SQL_Dashboard screenshot](https://user-images.githubusercontent.com/9599/111020900-da352a00-837d-11eb-8991-73ec6e6608ef.png)
diff --git a/docs/saved-dashboards.md b/docs/saved-dashboards.md
@@ -0,0 +1,17 @@
+# Saved dashboards
+
+A set of SQL queries can be used to create a saved dashboard. Saved dashboards have URLs and support permissions, so you can specify which users are allowed to see which dashboard.
+
+Saved dashboards currently need to be created using the Django Admin interface.
+
+Available view permissions are as follows:
+
+- `private`: Only the user who created (owns) the dashboard can view
+- `public`: Any user can view
+- `unlisted`: Any user can view, but they need to know the URL (this feature is not complete)
+- `loggedin`: Any logged-in user can view
+- `group`: Any user who is a member of the `view_group` attached to the dashboard can view
+- `staff`: Any user who is staff can view
+- `superuser`: Any user who is a superuser can view
+
+Edit permissions exist in the admin interface but do not yet do anything. Follow [#27](https://github.com/simonw/django-sql-dashboard/issues/27) for progress on this.