You can use pip to install django-browserid and requirements:

pip install django-browserid


To use django-browserid, add it to INSTALLED_APPS in

    # ...
    'django_browserid',  # Load after auth to monkey-patch it.
    # ...

and add django_browserid.auth.BrowserIDBackend to AUTHENTICATION_BACKENDS in

    # ...
    # ...

Edit your file and add the following:

urlpatterns = patterns('',
    # ...
    (r'^browserid/', include('django_browserid.urls')),
    # ...

You should also add the following in

# Note: No trailing slash

BrowserID uses an assertion and an audience to verify the user. This SITE_URL is used to determine the audience. For security reasons, it is very important that you set SITE_URL correctly.

You can also set the following optional config in (they have sensible defaults):

# Path to redirect to on successful login.

# Path to redirect to on unsuccessful login attempt.

Somewhere in one of your templates, you’ll need to create a link and a form with a single hidden input element, which you’ll use to submit the BrowserID assertion to the server. If you want to use django_browserid.forms.BrowserIDForm, you could use something like the following template snippet:

{% if not user.is_authenticated %}
<a class="browserid-login" href="#">Sign In</a>
<form method="POST" action="{% url browserid_verify %}">
   {% csrf_token %}
   {{ browserid_form.as_p }}
{% endif %}


If you’re using the default JavaScript mentioned below, you can use as many login links as you like as long as they all have the class browserid-login. However, you must only include the form on the page once.

If you use browserid_form, it is further recommended that you add django_browserid.context_processors.browserid_form to TEMPLATE_CONTEXT_PROCESSORS; this will create the browserid_form variable automatically in RequestContext instances when needed. That is, in

    # ...
    # ...

You will also need to include JavaScript to power the BrowserID popup and form. You can use django form media at the bottom of your page (see Form Media and Managing static files for more information):

{{ }}

This JavaScript file requires jQuery 1.6 or higher.


If you don’t want to use the static files framework, you’ll need to include the file, as well as JavaScript similar to django_browserid/static/browserid/browserid.js:

<script src=""></script>
<!-- Include JS for browserid_form here. -->


If your site uses Content Security Policy, you will have to add directives to allow the external JavaScript, as well as an iframe used as part of the login process.

If you’re using django-csp, the following settings will work:

CSP_SCRIPT_SRC = ("'self'", '')
CSP_FRAME_SRC = ("'self'", '')

Logging Out

To log users out, create a view that calls django.contrib.auth.logout, or use the standard logout view django.contrib.auth.views.logout. Then, add a link to your page with the browserid-logout class:

<a href="{% url logout %}" class="browserid-logout">Log Out</a>


Ensure that you include the form media on the same page, as it handles calling when the logout link is clicked.

Project Versions

Table Of Contents

Previous topic


Next topic

Advanced Usage

This Page