You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ This library allow *Single Sign On* (SSO) integration into Django through the [O
20
20
21
21
It can be used to setup a Single Sign On using an identity provider (Keycloak, etc.) or to login using Google, Twitter, etc.
22
22
23
-
**Warning**: this library has not been audited. However, we are based on [pyoidc](https://github.com/CZ-NIC/pyoidc/) which we believe is a sane OIDC implementation.
23
+
**Warning**: this library has not been audited. However, we are based on [pyoidc](https://github.com/CZ-NIC/pyoidc/) which we believe is a sane OIDC implementation.
24
24
25
25
We tried to make OpenID Connect (OIDC) configuration as easy and secure as possible. However
26
26
everything can be customized, and we tried to take into account every use case in the library design.
@@ -47,10 +47,10 @@ If you are not satisfied with the default configuration, take a look at the cook
47
47
48
48
This library is built on the work of many others. First all, thanks to all the maintainers of [pyoidc](https://github.com/CZ-NIC/pyoidc/) as they did all the spec implementation. This library is mostly about glue between Django and *pyoidc*.
49
49
50
-
We were also heavily inspired by:
50
+
We were also heavily inspired by:
51
51
52
-
*[`mozilla-django-oidc`](https://github.com/mozilla/mozilla-django-oidc) for it's login redirection URI management
53
-
*[`django-auth-oidc`](https://gitlab.com/aiakos/django-auth-oidc) for it's hook system
52
+
*[`mozilla-django-oidc`](https://github.com/mozilla/mozilla-django-oidc) for its login redirection URI management
53
+
*[`django-auth-oidc`](https://gitlab.com/aiakos/django-auth-oidc) for its hook system
54
54
55
55
If you want to understand why we decided to implement our own library, this is documented [here](https://django-pyoidc.readthedocs.io/latest/explanation.html).
56
56
@@ -60,13 +60,13 @@ The documentation is graciously hosted at [readthedocs](https://django-pyoidc.re
60
60
61
61
## Installation
62
62
63
-
First, install the python package:
63
+
First, install the python package:
64
64
65
65
```bash
66
66
pip install django_pyoidc
67
67
```
68
68
69
-
Then add the library app to your django applications, after `django.contrib.sessions` and `django.contrib.auth`:
69
+
Then add the library app to your django applications, after `django.contrib.sessions` and `django.contrib.auth`:
70
70
71
71
```python
72
72
INSTALLED_APPS= [
@@ -77,21 +77,21 @@ INSTALLED_APPS = [
77
77
]
78
78
```
79
79
80
-
Don't forget to add the session middleware! Add in your `settings.py`:
80
+
Don't forget to add the session middleware! Add in your `settings.py`:
Now is time to run a migrate operation, as we create a database table ([read why here](https://django-pyoidc.readthedocs.io/latest/explanation.html#about-caching)). Run in your project dir:
88
+
Now is time to run a migrate operation, as we create a database table ([read why here](https://django-pyoidc.readthedocs.io/latest/explanation.html#about-caching)). Run in your project dir:
89
89
90
90
```
91
91
./manage.py migrate
92
92
```
93
93
94
-
We also need a cache ([read why here](https://django-pyoidc.readthedocs.io/latest/explanation.html#about-caching)), so let's configure a dumb one for development purposes. Add in your `settings.py`:
94
+
We also need a cache ([read why here](https://django-pyoidc.readthedocs.io/latest/explanation.html#about-caching)), so let's configure a dumb one for development purposes. Add in your `settings.py`:
95
95
96
96
```python
97
97
CACHES= {
@@ -104,7 +104,7 @@ CACHES = {
104
104
105
105
Now you can pick an identity provider from the [available providers](https://django-pyoidc.readthedocs.io/latest/reference.html#providers). Providers class are a quick way to generate the library configuration and URLs. You can also configure the settings manually, but this is not recommended if you are not familiar with the OpendID Connect (OIDC) protocol.
106
106
107
-
Add the following `DJANGO_PYOIDC` to your `settings.py`:
107
+
Add the following `DJANGO_PYOIDC` to your `settings.py`:
108
108
109
109
```python
110
110
# settings
@@ -142,7 +142,7 @@ urlpatterns = [
142
142
]
143
143
```
144
144
145
-
And you are ready to go!
145
+
And you are ready to go!
146
146
147
147
If you struggle with those instructions, take a look at [the quickstart tutorial](https://django-pyoidc.readthedocs.io/latest/tutorial.html).
0 commit comments