Skip to content

Commit 726d39f

Browse files
committed
Fix typos and obsolete information in README
1 parent 40bf3af commit 726d39f

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ will also install PySAML2 and its dependencies automatically.
3333
Configuration
3434
=============
3535

36-
There are three things you need to setup to make djangosaml2 works in your
36+
There are three things you need to setup to make djangosaml2 work in your
3737
Django project:
3838

3939
1. **settings.py** as you may already know, it is the main Django
4040
configuration file.
4141
2. **urls.py** is the file where you will include djangosaml2 urls.
42-
3. **pysaml2** specific files such as a attribute map directory and a
42+
3. **pysaml2** specific files such as an attribute map directory and a
4343
certificate.
4444

4545

@@ -69,7 +69,7 @@ do to make sure it is compatible with your Django version and environment.
6969
as you run any other Django application test suite. Just type
7070
``python manage.py test djangosaml2``
7171

72-
Then you have to add the djangosaml2.backends.Saml2Backend
72+
Then you have to add the ``djangosaml2.backends.Saml2Backend``
7373
authentication backend to the list of authentications backends.
7474
By default only the ModelBackend included in Django is configured.
7575
A typical configuration would look like this::
@@ -89,7 +89,7 @@ A typical configuration would look like this::
8989
djangosaml2 0.5.0 it is now possible to define such
9090
backends.
9191

92-
Finally we have to tell Django what is the new login url we want to use::
92+
Finally we have to tell Django what the new login url we want to use is::
9393

9494
LOGIN_URL = '/saml2/login/'
9595
SESSION_EXPIRE_AT_BROWSER_CLOSE = True
@@ -114,7 +114,7 @@ view to the ``/saml2/login/`` view.
114114
Changes in the urls.py file
115115
---------------------------
116116

117-
The next thing you need to do is to include ``djangosaml2.urls`` module to your
117+
The next thing you need to do is to include ``djangosaml2.urls`` module in your
118118
main ``urls.py`` module::
119119

120120
urlpatterns = patterns(
@@ -269,9 +269,10 @@ metadata for remote entities. Usually the easiest type is the ``local`` where
269269
you just put the name of a local XML file with the contents of the remote
270270
entities metadata. This XML file should be in the SAML2 metadata format.
271271

272-
The ``key_file`` and ``cert_file`` options references the two parts of a
273-
standard x509 certificate. You need it to sign your metadata an to encrypt
274-
and decrypt the SAML2 assertions.
272+
The ``key_file`` and ``cert_file`` options reference the two parts of a
273+
standard x509 certificate. You need it to sign your metadata. For assertion
274+
encryption/decryption support please configure another set of ``key_file`` and
275+
``cert_file``, but as inner attribues of ``encryption_keypairs`` option.
275276

276277
.. note::
277278

@@ -308,13 +309,13 @@ When such assertion is received on the Django side it is used to find
308309
a Django user and create a session for it. By default djangosaml2 will
309310
do a query on the User model with the 'username' attribute but you can
310311
change it to any other attribute of the User model. For example,
311-
you can do this look up using the 'email' attribute. In order to do so
312+
you can do this lookup using the 'email' attribute. In order to do so
312313
you should set the following setting::
313314

314315
SAML_DJANGO_USER_MAIN_ATTRIBUTE = 'email'
315316

316317
Please, use an unique attribute when setting this option. Otherwise
317-
the authentication process will fail because djangosaml2 does not know
318+
the authentication process may fail because djangosaml2 will not know
318319
which Django user it should pick.
319320

320321
If your main attribute is something inherently case-inensitive (such as

0 commit comments

Comments
 (0)