1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
.. _index:
django-registration |release|
=============================
django-registration is an extensible application providing user
registration functionality for `Django
<https://www.djangoproject.com/>`_-powered Web sites.
Although nearly all aspects of the registration process are
customizable, out-of-the-box support is provided for two common use
cases:
* Two-phase registration, consisting of initial signup followed by a
confirmation email with instructions for activating the new account.
* One-phase registration, where a user signs up and is immediately
active and logged in.
To get up and running quickly, :ref:`install django-registration
<install>`, then read :ref:`the quick start guide <quickstart>`, which
describes the steps necessary to configure django-registration for the
built-in workflows. For more detailed information, including how to
customize the registration process (and support for alternate
registration systems), read through the documentation listed below.
.. toctree::
:caption: Installation and configuration
:maxdepth: 1
install
quickstart
.. toctree::
:caption: Built-in registration workflows
:maxdepth: 1
activation-workflow
one-step-workflow
.. toctree::
:caption: For developers
:maxdepth: 1
views
forms
custom-user
validators
exceptions
settings
signals
deprecations
.. toctree::
:caption: Other documentation
:maxdepth: 1
security
upgrade
faq
.. seealso::
* `Django's authentication documentation
<https://docs.djangoproject.com/en/stable/topics/auth/>`_. Django's
authentication system is used by django-registration's default
configuration.
|
