valency / deepauth

Deepera Authentication System

Deepera Authentication System

To use captcha, install the following packages:

sudo apt install libz-dev libjpeg-dev libfreetype6-dev python-dev

To install, add deepauth and captcha to INSTALLED_APPS in your Django settings.

Compulsory configurations:

AUTH_USER_MODEL = 'deepauth.Account'
DEEPAUTH_EMAIL_CONF = {
    'required': True,
    'server': 'smtp.example.com',
    'port': 465,
    'username': '[email protected]',
    'password': 'moc.elpmaxe',
    'subject': 'Activate Your Account',
    'content': 'Dear {0},\nPlease verify your account by clicking the following link:\n{1}\nYours sincerely,\nExample.com',
}

Optional configurations:

DEEPAUTH_CAPTCHA_NEED = False
# Whether captcha is required to register or login

DEEPAUTH_INVITATION_ONLY = False
# Invatitation code must be provided if set to true

DEEPAUTH_TOKEN_LIFETIME = 7
# Token will expire in certain days

To enable access, add the following URLs to your URL patterns:

path(r'^auth/', include('deepauth.urls')),
path(r'^captcha/', include('captcha.urls'))

To show docs, add the following code to your URLs:

from rest_framework.documentation import include_docs_urls
urlpatterns = [
    path(r'^docs/', include_docs_urls('API Docs'))
]