Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonw/datasette-indieauth
Datasette authentication using IndieAuth and RelMeAuth
https://github.com/simonw/datasette-indieauth
datasette datasette-io datasette-plugin indieauth
Last synced: 3 months ago
JSON representation
Datasette authentication using IndieAuth and RelMeAuth
- Host: GitHub
- URL: https://github.com/simonw/datasette-indieauth
- Owner: simonw
- Created: 2020-11-15T01:18:21.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-18T06:48:02.000Z (about 2 years ago)
- Last Synced: 2024-10-06T20:19:14.082Z (3 months ago)
- Topics: datasette, datasette-io, datasette-plugin, indieauth
- Language: Python
- Homepage:
- Size: 53.7 KB
- Stars: 8
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# datasette-indieauth
[](https://pypi.org/project/datasette-indieauth/)
[](https://github.com/simonw/datasette-indieauth/releases)
[](https://codecov.io/gh/simonw/datasette-indieauth)
[](https://github.com/simonw/datasette-indieauth/actions?query=workflow%3ATest)
[](https://github.com/simonw/datasette-indieauth/blob/main/LICENSE)
Datasette authentication using [IndieAuth](https://indieauth.net/).
## Demo
You can try out the latest version of this plugin at [datasette-indieauth-demo.datasette.io](https://datasette-indieauth-demo.datasette.io/-/indieauth)
## Installation
Install this plugin in the same environment as Datasette.
$ datasette install datasette-indieauth
## Usage
Ensure you have a website with a domain that supports IndieAuth or RelMeAuth. The easiest way to do that is to add the following HTML to your homepage, linking to your personal GitHub profile:
```html
```
Your GitHub profile needs to link back to your website, to prove that your GitHub account should be a valid identifier for that page.
Now visit `/-/indieauth` on your Datasette instance to begin the sign-in progress.
## Actor
When a user signs in using IndieAuth they will be recieve a signed `ds_actor` cookie identifying them as an [actor](https://docs.datasette.io/en/stable/authentication.html#actors) that looks like this:
```json
{
"me": "https://simonwillison.net/",
"display": "simonwillison.net"
}
```
If the IndieAuth server returned additional `"profile"` fields those will be merged into the actor. You can visit `/-/actor` on your Datasette instance to see the full actor you are currently signed in as.
## Restricting access with the restrict_access plugin configuration
You can use [Datasette's permissions system](https://docs.datasette.io/en/stable/authentication.html#permissions) to control permissions of authenticated users - by default, an authenticated user will be able to perform the same actions as an unauthenticated user.
As a shortcut if you want to lock down access to your instance entirely to just specific users, you can use the `restrict_access` plugin configuration option like this:
```json
{
"plugins": {
"datasette-indieauth": {
"restrict_access": "https://simonwillison.net/"
}
}
}
```
This can be a string or a list of user identifiers. It can also be a space separated list, which means you can use it with the [datasette publish](https://docs.datasette.io/en/stable/publish.html#datasette-publish) `--plugin-secret` configuration option to set permissions as part of a deployment, like this:
```
datasette publish vercel mydb.db --project my-secret-db \
--install datasette-indieauth \
--plugin-secret datasette-indieauth restrict_access https://simonwillison.net/
```
## Development
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
cd datasette-indieauth
python3 -mvenv venv
source venv/bin/activate
Or if you are using `pipenv`:
pipenv shell
Now install the dependencies and tests:
pip install -e '.[test]'
To run the tests:
pytest