simonw / django-sql-dashboard

Django app for building dashboards using raw SQL queries
https://django-sql-dashboard.datasette.io/
Apache License 2.0
437 stars 37 forks source link

Document the "execute_sql" permission #112

Closed toolness closed 3 years ago

toolness commented 3 years ago

Hello! I noticed that the "security" section of the documentation says the following:

Access to the dashboard is controlled by Django’s permissions system, which means you can limit access to trusted team members.

However, it doesn't mention what the permission is called. From looking at the source, it appears this permission is called execute_sql:

https://github.com/simonw/django-sql-dashboard/blob/fe7ff4e920cb790c4fe0b27cbcb7467a5e39ca4e/django_sql_dashboard/models.py#L83

Should this permission be mentioned by name in the documentation? And should the "quick start" mention it too? Or is it already mentioned somewhere and I just missed it?