django-registration / docs / upgrade.rst

The branch 'django15' does not exist.

Upgrade guide

The |version| release of django-registration represents a complete rewrite of the previous codebase, and introduces several new features which greatly enhance the customizability and extensibility of django-registration. Whenever possible, changes were made in ways which preserve backwards compatibility with previous releases, but some changes to existing installations will still be required in order to upgrade to |version|. This document provides a summary of those changes, and of the new features available in the |version| release.

Django version requirement

As of |version|, django-registration requires Django 1.4 or newer; older Django releases may work, but are officially unsupported.

Backwards-incompatible changes

If you're upgrading from an older release of django-registration, and if you were using the default setup (i.e., the included default URLconf and no custom URL patterns or custom arguments to views), you do not need to make any chances.

If you had customized django-registration by writing your own backend, you will now need to implement that backend by subclassing :ref:`the built-in views <views>` and overriding or implementing your customizations appropriately. Much of this is similar to previous backend class implementations, so minimal changes to existing code should be required.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.