diff options
| author | James Muranga <jmured@gmail.com> | 2014-09-21 18:47:09 +0300 |
|---|---|---|
| committer | James Muranga <jmured@gmail.com> | 2014-11-12 22:47:48 +0300 |
| commit | 613da0b10e2397d0534dd2b55e40bc3dab18a6dd (patch) | |
| tree | ee755941fdd0e7277c9d82dcfd33ff66de1a5a5b /README.rst | |
| parent | b2c06648f48eeecc1c7572492dd220c41f436172 (diff) | |
| download | django_openstack_auth-613da0b10e2397d0534dd2b55e40bc3dab18a6dd.tar.gz | |
Updated the installation instructions
Changed the name of the app from keystone_auth to
openstack_auth in the installation instructions
Removed the redudant installation instructions in README.rst
Change-Id: If97c93a446754573bd6fb55b15cb4c881ad1f4e6
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 31 |
1 files changed, 3 insertions, 28 deletions
@@ -6,37 +6,12 @@ Django OpenStack Auth is a pluggable Django authentication backend that works with Django's ``contrib.auth`` framework to authenticate a user against OpenStack's Keystone Identity API. -The current version is designed to work with the Keystone V2 API. +The current version is designed to work with the Keystone v2.0 and v3 API. You can `view the documentation`_ on Read The Docs. .. _view the documentation: http://django-openstack-auth.readthedocs.org/en/latest/ -Installation -============ +You can `view the installation instructions`_ on Read The Docs. -Installing is quick and easy: - -#. Run ``pip install django_openstack_auth``. - -#. Add ``openstack_auth`` to ``settings.INSTALLED_APPS``. - -#. Add ``'openstack_auth.backend.KeystoneBackend'`` to your - ``settings.AUTHENTICATION_BACKENDS``, e.g.:: - - AUTHENTICATION_BACKENDS = ('openstack_auth.backend.KeystoneBackend',) - -#. Configure your API endpoint(s) in ``settings.py``:: - - OPENSTACK_KEYSTONE_URL = "http://example.com:5000/v2.0" - -#. Include ``'keystone_auth.urls'`` somewhere in your ``urls.py`` file. - -#. Use it as you would any other Django auth backend. - -Running The Tests -================= - -Download the repository and run:: - - python setup.py test +.. _view the installation instructions: http://django-openstack-auth.readthedocs.org/en/latest/installation.html#installation |