Skip to main content

PBS UUA OpenId Consumer

Project description

Installation

pip install pbs-account-consumer

Configuration

  1. Add pbs_account_consumer to the INSTALLED_APPS section of the settings file.

  2. After installing you need to add a couple of params to your settings.py file.

    • Example param values:
      • OPENID_SSO_SERVER_URL = ‘https://account.pbs.org/cranky
      • OPENID_CREATE_USERS = True
      • OPENID_UPDATE_DETAILS_FROM_SREG = True
      • OPENID_USE_AS_ADMIN_LOGIN = True
      • OPENID_ADMIN_LOGIN_TEMPLATE = None
      • LOGIN_REDIRECT_URL = ‘/’
  3. Add the consumer app to the url routing.

    • For example:
      • Add url(r’^openid/’, include(‘pbs_account_consumer.urls’)) to urls.py in your project.
  4. Add the proper authentication backend to your project.

    • Add AUTHENTICATION_BACKENDS = (…, ‘pbs_account_consumer.auth.OpenIDBackend’,) to settings.py.
  5. Add the proper login link to the admin login template:

    • Add pbs_accout_consumer.urls to the main urls.py file of your project.
    • Make the link point to the login_begin view, as such: {% url login_begin %}

6. (Optional) If you want to use a custom realm (eg. you don’t want it to point to the base of your domain) you have to set OPENID_CUSTOM_REALM in settings.py:

OPENID_CUSTOM_REALM = ‘https://mysite.com/realm

The default is the absolute URI of the base of your website.

7. (Optional) If you want to use a custom domain (eg. if you are using a proxy for your website) for the return_to page you can set OPENID_CUSTOM_RETURN_TO in settings.py:

OPENID_CUSTOM_RETURN_TO = ‘https://mysite.com/realm/landing

The return_to parameter will be set to login_route route, relative to this parameter. There should be no trailing slash. The default is the absolute URI of the base of your website.

The RETURN_TO url should be under the REALM (trust_root), otherwise the OpenID provider will give an error and disallow authentication.

Requirments

  1. Python version 2.7 or greater.
  2. Django version 1.3 or greater.

Project details


Release history Release notifications

History Node

1.5.0

History Node

1.4.3

History Node

1.4.2

History Node

1.3.10

History Node

1.3.9

History Node

1.3.8

History Node

1.3.6

History Node

1.3.5

History Node

1.3.4

History Node

1.3.3

This version
History Node

1.3.2

History Node

1.3.1

History Node

1.3

History Node

1.2.3

History Node

1.2.2

History Node

1.2.1

History Node

1.2

History Node

1.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pbs-account-consumer-1.3.2.tar.gz (11.0 kB) Copy SHA256 hash SHA256 Source None Nov 4, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page