readonly is not a valid Django DB connection.

The documentation suggests the following settings:

EXPLORER_CONNECTIONS = { 'Default': 'readonly' }
EXPLORER_DEFAULT_CONNECTION = 'readonly'

However this results in an error:

django.core.exceptions.ImproperlyConfigured: EXPLORER_CONNECTIONS contains (Default, readonly), but readonly is not a valid Django DB connection.

From doing a quick search (https://github.com/groveco/django-sql-explorer/issues/306), it looks like the solution is changing the settings to:

EXPLORER_CONNECTIONS = { 'Default': 'default' } 
EXPLORER_DEFAULT_CONNECTION = 'default'

Is this is the correct (safe) solution? If so, we should update the documentation.

[spapas]

Actually the correct thing to do from a security standpoint is to add another read-only connection to your django settings. So beyond ‘default’ you’ll have a ‘readonly’ key to your DATABASES settings dictionary (that would connect with a user that has read-only access to the tables).

However, the README definitely needs some updating because I can see the following phrase right after EXPLORER_CONNECTIONS is explained:

The first setting lists the connections you want to allow Explorer to use. The keys of the connections dictionary are friendly names to show Explorer users, and the values are the actual database aliases used in settings.DATABASES. It is highly recommended to set

this definitely has something missing and needs to be properly completed!

[marksweb]

@zehawki I became a maintainer a few days ago to try to get things rolling, bring django 3 support etc.

We’re nearly there with thanks to a fair few people actively contributing. And @spapas has just updated the readme in #406 which I think closes this ticket.

Talking of docs, there is a branch with the very beginning of a sphinx setup. I think the README needs refactoring to be a bit more basic in itself with the vast majority of it’s details put into sphinx.