Skip to content

Commit 4f96f37

Browse files
committed
RTD minor changes
1 parent 29ad753 commit 4f96f37

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

docs/source/contents/setup.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -220,8 +220,8 @@ setting::
220220
SAML_CONFIG_LOADER = 'python.path.to.your.callable'
221221

222222

223-
User attributes
224-
---------------
223+
Users, attributes and account linking
224+
-------------------------------------
225225

226226
In the SAML 2.0 authentication process the Identity Provider (IdP) will
227227
send a security assertion to the Service Provider (SP) upon a successful
@@ -516,15 +516,19 @@ metadata for remote entities. Usually the easiest type is the ``local`` where
516516
you just put the name of a local XML file with the contents of the remote
517517
entities metadata. This XML file should be in the SAML2 metadata format.
518518

519+
.. Note::
520+
521+
Don't use ``remote`` option for fetching metadata in production.
522+
Try to use ``mdq`` and introduce a MDQ server instead, it's more efficient.
523+
519524
The ``key_file`` and ``cert_file`` options reference the two parts of a
520525
standard x509 certificate. You need it to sign your metadata. For assertion
521526
encryption/decryption support please configure another set of ``key_file`` and
522527
``cert_file``, but as inner attributes of ``encryption_keypairs`` option.
523528

524529
.. Note::
525530

526-
Check your openssl documentation to generate a test certificate but don't
527-
forget to order a real one when you go into production.
531+
Check your openssl documentation to generate a test certificate.
528532

529533
..
530-
openssl req -nodes -new -x509 -days 3650 -keyout private.key -out public.cert
534+
openssl req -nodes -new -x509 -newkey rsa:2048 -days 3650 -keyout private.key -out public.cert

docs/source/contents/usage.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,10 @@ Now you need to send the entity id and the metadata of this new SP to the
1616
IdP administrators so they can add it to their list of trusted services.
1717

1818
You can get this information starting your Django development server and
19-
going to the http://localhost:8000/saml2/metadata url. If you have included
19+
going to the **http://localhost:8000/saml2/metadata/** url. If you have included
2020
the djangosaml2 urls under a different url prefix you need to correct this
2121
url.
2222

2323
There are many saml2 idps suitable for testing, such as [samltest.id](https://samltest.id/).
24-
If you are looking for a django idp, try one of these:
25-
26-
- [uniAuth](https://github.com/UniversitaDellaCalabria/uniAuth)
27-
- [djangosaml2idp](https://github.com/OTA-Insight/djangosaml2idp/)
24+
If you are looking for a django IdP, you can try [uniAuth](https://github.com/UniversitaDellaCalabria/uniAuth) or
25+
[djangosaml2idp](https://github.com/OTA-Insight/djangosaml2idp/).

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A Django application that builds a fully compliant SAML2 Service Provider on top
66
Djangosaml2 protects your project with a SAML2 SSO Authentication, supporting features like
77
**HTTP-REDIRECT** and **HTTP-POST SSO Binding**, **Single logout**,
88
**Discovery Service**, **Wayf page** with customizable html template,
9-
**IdP Hinting**, **Samesite cookie** SSO workaround.
9+
**IdP Hinting** and **Samesite cookie** SSO workaround.
1010

1111
The entire project code is open sourced and therefore licensed
1212
under the `Apache 2.0 <https://en.wikipedia.org/wiki/Apache_License>`_.

0 commit comments

Comments
 (0)