ITC Media

Django

django-allauthでユーザー認証構築のための3ステップ

（最終更新月：2021年12月）

✔このような方へ向けて書かれた記事となります

「ユーザー登録、ログインするページを作りたい！」

「一から認証機能を構築したいけどどうしたら良いの！？」

✔当記事を通じてお伝えすること

  • django-allauthのインストール
  • django-allauthの設定方法
  • 管理ページでの行う設定

django-allauthをインストール・設定するだけで下記の機能が使えるようになります。

  • ログイン
  • 新規登録
  • ログアウト
  • パスワード変更
  • パスワードリセット
  • Eメールアドレス登録変更
  • Eメールアドレス認証
  • SNS等のアカウントと紐付け

実践Django Pythonによる本格Webアプリケーション開発 [ 芝田 将 ]
created by Rinker
¥3,850 (2024/12/25 23:41:03時点 楽天市場調べ-詳細)

django-allauthのインストール

ターミナルで、

pip install django-allauth

でインストールしましょう

インストールが終わったら、

pip freeze > requirements.txt

など、パッケージを記録しておくことを忘れずに！

django-allauthの設定

settings.py

まずは、インストール後にsettings.pyで下記を追記する必要があります。

AUTHENTICATION_BACKENDS = [ 
  'django.contrib.auth.backends.ModelBackend',     
  'allauth.account.auth_backends.AuthenticationBackend',
] 

SITE_ID = 1

MIDDLEWARE

MIDDLEWARE = [
    #....
    "allauth.account.middleware.AccountMiddleware", #こちらを追記
]

下記↓については、それぞれ確認して足りないものを追加してください。

TEMPLATES

    ....,      
    'DIRS': [BASE_DIR / "templates"],        
    ....,      
    'OPTIONS': {            
            'context_processors': [
            ....,
            'django.template.context_processors.request',
            ....,
                                             ], 
                     }, 
                              }, ]

INSTALLED_APPS

INSTALLED_APPS = [
'django.contrib.auth',    
'django.contrib.messages',     
'django.contrib.sites',    
'allauth',     
'allauth.account',     
'allauth.socialaccount'
]

その他、SNSアカウントと紐付ける場合はそれぞれ設定が必要です。

当記事では説明を割愛します。

urls.pyの設定

settings.pyと同列のurls.pyに下記を追記します。

...
from django.urls import path, include

urlpatterns = [
    ...
    path('accounts/', include('allauth.urls')),
    ...
]

これによってそれぞれのページへアクセスすることができるようになります。

マイグレーションの実行

マイグレーションを実行し、変更を適用します。

$ python manage.py migrate
Operations to perform:
  Apply all migrations: account, accounts, admin, auth, contenttypes, nippo, sessions, sites, socialaccount
Running migrations:
  Applying account.0001_initial... OK
  Applying account.0002_email_max_length... OK
  Applying sites.0001_initial... OK
  Applying sites.0002_alter_domain_unique... OK
  Applying socialaccount.0001_initial... OK
  Applying socialaccount.0002_token_max_lengths... OK
  Applying socialaccount.0003_extra_data_default_dict... OK

エラーが出なければ設定に問題はなく、これでdjango-allauthの設定は完了です。

管理者ページでの設定変更

管理者ページへアクセスしてみると、新しいモデルクラスが登録されているのがわかります

設定するのは、以下の2つです。

  • メールアドレス
  • サイト

の2つになります

メールアドレスクラスでの変更

「メールアドレス」へ進み、スーパーユーザーとして登録しているあなたのアドレスを登録しておきましょう。

サイト名の変更

「サイト」へ進み、サイト名を自身のドメイン名に変更しておく必要があります。

これを行わないと、ユーザー登録時に送られるメールで不具合が起きてしまいます。

まとめ

以上で設定は完了しました。当記事の内容をまとめます。

django-allauthを使ってユーザー認証を構築するには下記の3ステップで進めます。

  1. django-allauthのインストール
  2. django-allauthの設定方法
  3. 管理ページでの行う設定

念の為、ローカルサーバーを立ち上げログインページへアクセスしてみます

http://localhost:8000/accounts/login/

ユーザー登録ページは下記のとおりです。

http://localhost:8000/accounts/signup/

その他のページも公式ドキュメントに詳しく書いてありますのでご確認ください

ただし、問題が発生する場合もあります。

別記事でも記載した通り、オリジナルのユーザーモデルクラスを作りEメールアドレスでのログイン方法へ変更している場合、下記のようなエラーページに飛んでしまいます。

該当してしまった方は下記ページでEメールでのログイン方法へ変更している場合のdjango-allauth設定方法について解説していますので、ご覧ください。

【django-allauth】ログイン・ログアウト機能のカスタマイズ

関連記事