Installation

Quick Start

Install using pip…

pip install django-jwt-allauth

You can quickly start a new Django project with JWT Allauth pre-configured using the startproject command:

jwt-allauth startproject myproject

This will create a new Django project called “myproject” with JWT Allauth pre-configured. Then:

cd myproject
python manage.py makemigrations jwt_allauth
python manage.py migrate
python manage.py runserver

Projects created via jwt-allauth startproject are configured to store jwt_allauth migrations inside your project codebase via Django’s MIGRATION_MODULES setting. This is especially useful in Docker environments where your project source code is persisted (and committed to git) but site-packages is ephemeral.

The generated migration files will live under:

myproject/
    myproject/
        migrations_external/
            jwt_allauth/
                0001_initial.py
                ...

Available options:

  • --email=True - Enables email configuration in the project

  • --template=PATH - Uses a custom template directory for project creation

Installation for existing projects

Install using pip…

pip install django-jwt-allauth

Add the following to your to your INSTALLED_APPS setting in the settings.py file in the same order:

INSTALLED_APPS = [
    ...
    'jwt_allauth',
    'rest_framework',
    'rest_framework.authtoken',
    'allauth',
    'allauth.account',
]

Set the AUTH_USER_MODEL setting in the settings.py file:

AUTH_USER_MODEL = 'jwt_allauth.JAUser'

Add the following to your MIDDLEWARE setting in the settings.py file:

MIDDLEWARE = [
    ...
    'allauth.account.middleware.AccountMiddleware',
]

Set the following to your AUTHENTICATION_BACKENDS setting in the settings.py file:

AUTHENTICATION_BACKENDS = (
    # Needed to login by username in Django admin, regardless of `allauth`
    "django.contrib.auth.backends.ModelBackend",
    # `allauth` specific authentication methods, such as login by e-mail
    "allauth.account.auth_backends.AuthenticationBackend"
)

Add the following to your urls.py file.

from django.urls import path, include

...

urlpatterns = [
    ...
    path('jwt-allauth/', include('jwt_allauth.urls')),
    ...
]

Run migrations.

To make migrations persistent across environments (recommended for Docker), configure local migration modules for jwt_allauth using MIGRATION_MODULES.

  1. Create the local migrations package inside your Django project module (replace myproject with your project module name):

myproject/
    myproject/
        migrations_external/
            __init__.py
            jwt_allauth/
                __init__.py

  1. Add this to your settings.py:

MIGRATION_MODULES = {
    'jwt_allauth': 'myproject.migrations_external.jwt_allauth',
}

  1. Generate and apply migrations:

python manage.py makemigrations jwt_allauth
python manage.py migrate

Done! django-jwt-allauth will configure django-allauth and djangorestframework-simplejwt for you.