datasette-auth-osm

Datasette plugin that authenticates users against OpenStreetMap

Installation

Install this plugin in the same environment as Datasette.

datasette install datasette-auth-osm

Demo

You can try this out at datasette-auth-osm-demo.fly.dev - click on the top right menu icon and select "Sign in with OpenStreetMap".

Initial configuration

First, create a new application in Openstreetmap - OAuth2 Applications. You will need the client ID and client secret for that application.

Add http://127.0.0.1:8001/-/osm-callback to the list of Allowed Callback URLs.

Then configure these plugin secrets using metadata.yml:

plugins:
  datasette-auth-osm:
    client_id:
      "$env": OSM_CLIENT_ID
    client_secret:
      "$env": OSM_CLIENT_SECRET

In development, you can run Datasette and pass in environment variables like this:

OSM_CLIENT_ID="...client-id-goes-here..." \
OSM_CLIENT_SECRET="...secret-goes-here..." \
datasette -m metadata.yml

Once your Datasette instance is deployed, you will need to add its callback URL to the "Allowed Callback URLs" list your OAuth2 application in OpenStreetMap.

The callback URL should be something like:

https://url-to-your-datasette/-/osm-callback

Example for a permission block to only allow logged in users to see the private.db:

databases:
  private:
    allow:
      osm_id: "*"

The name of the actor field is not id as in the Datasette documentation, but osm_id.

Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd datasette-auth-osm
python3 -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest