Welcome to django-indieweb’s documentation!¶

django-indieweb provides IndieAuth, Micropub, Webmention, WebSub, and h-card support for Django applications.

Contents:

Features¶

IndieAuth authentication endpoint - For logging into IndieWeb sites
IndieAuth authorization endpoint with consent screen - For granting permissions to apps
IndieAuth token endpoint - For exchanging auth codes for access tokens
Micropub endpoint with content creation, source query, update, delete, undelete, and media upload support
Webmention support - Send and receive cross-site conversations
WebSub support - Advertise topic/hub discovery links, notify hubs, and receive tokenized subscriber callbacks
H-card profiles - Store and display user profiles with microformats2
Pluggable content handler system for Micropub integration
Pluggable interfaces for Webmention URL resolution and spam checking
Support for both form-encoded and JSON Micropub requests
Microformats2 parsing for rich webmention content and h-cards
Micropub query endpoints (config with media-endpoint discovery, syndicate-to, source)
Django integration

Note

The Micropub endpoint now includes content creation, source query, update, delete, and undelete actions through a pluggable handler architecture. A dedicated media endpoint stores direct uploads through Django storage and is advertised through Micropub config. See Micropub Implementation Guide for implementation details.

Project Planning¶

Planned work is tracked in the project backlog. See Backlog.

Installation¶

Install django-indieweb using pip:

pip install django-indieweb

Or with uv:

uv pip install django-indieweb

Quick Start¶

Add “indieweb” to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    ...
    'indieweb',
]

Include the indieweb URLconf in your project urls.py:
```
path('indieweb/', include('indieweb.urls')),
```
Run migrations:
```
python manage.py migrate
```
Visit the IndieWeb endpoints at:
- /indieweb/auth/ - Authentication endpoint
- /indieweb/token/ - Token endpoint
- /indieweb/micropub/ - Micropub endpoint
- /indieweb/media/ - Micropub media endpoint
- /indieweb/webmention/ - Webmention endpoint

To enable content creation and editing via Micropub, create a content handler:

from indieweb.handlers import MicropubContentHandler, MicropubEntry

class MyContentHandler(MicropubContentHandler):
    def create_entry(self, properties, user):
        # Your content creation logic here
        pass

See Micropub Implementation Guide for detailed implementation examples.

To publish WebSub-enabled topics, configure INDIEWEB_WEBSUB_HUBS, add discovery links to your topic responses, and call notify_hubs() after content changes. See WebSub Support.

Adapter Responsibilities¶

Micropub handlers are host-owned authorization boundaries. After django-indieweb authenticates the bearer token and checks the requested scope, your MicropubContentHandler must verify that the authenticated user is allowed to create, update, delete, undelete, read source content, list content or media, and manage media for the submitted URL or storage object. The bundled InMemoryMicropubHandler is an unsafe development/testing example only; it keeps entries in process memory and performs no ownership checks.