kumi/django-oidc-provider
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update Docs.

Browse source
This commit is contained in:
Juan Ignacio Fiorentino 2015-03-25 14:54:11 -03:00
parent 724dcfdc1d
commit 363b654a58
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
DOC.md
View file

@ -2,8 +2,11 @@
Django OIDC Provider can help you providing out of the box all the endpoints, data and logic needed to add OpenID Connect capabilities to your Django projects. Django OIDC Provider can help you providing out of the box all the endpoints, data and logic needed to add OpenID Connect capabilities to your Django projects.
**This project is still in DEVELOPMENT and is rapidly changing. DO NOT USE IT FOR PRODUCTION SITES, unless you know what you do.** **This project is still in DEVELOPMENT and is rapidly changing. DO NOT USE IT FOR PRODUCTION SITES, unless you know what you do.**
****************************************
Before getting started there are some important things that you should know: Before getting started there are some important things that you should know:
* Although OpenID was built on top of OAuth2, this isn't an OAuth2 server. Maybe in a future it will be. * Although OpenID was built on top of OAuth2, this isn't an OAuth2 server. Maybe in a future it will be.
* Despite that implementation MUST support TLS. You can make request without using SSL. There is no control on that. * Despite that implementation MUST support TLS. You can make request without using SSL. There is no control on that.
@ -26,6 +29,7 @@ Before getting started there are some important things that you should know:
- [Users And Clients](#users-and-clients) - [Users And Clients](#users-and-clients)
- [Templates](#templates) - [Templates](#templates)
- [Server Endpoints](#server-endpoints) - [Server Endpoints](#server-endpoints)
- [Running Tests](#running-tests)
## Requirements ## Requirements
@ -261,3 +265,11 @@ POST /openid/userinfo/ HTTP/1.1
Host: localhost:8000 Host: localhost:8000
Authorization: Bearer [ACCESS_TOKEN] Authorization: Bearer [ACCESS_TOKEN]
``` ```
## Running Tests
You need a Django project properly configured with the package. Then just run tests as normal.
```bash
$ python manage.py test oidc_provider
```