diff --git a/README.rst b/README.rst index fa3719b..fde0bbc 100644 --- a/README.rst +++ b/README.rst @@ -2,9 +2,9 @@ Django OIDC Provider #################### -OpenID Connect Provider implementation for Django. +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. -Read docs for more info. https://github.com/juanifioren/django-oidc-provider/wiki +Read docs for more info. https://github.com/juanifioren/django-oidc-provider/blob/master/doc.md ************* Running tests diff --git a/doc.md b/doc.md index 301dc78..5f3ce83 100644 --- a/doc.md +++ b/doc.md @@ -12,6 +12,7 @@ Before getting started there are some important things that you should know: # Table Of Contents +- [Requirements](#requirements) - [Installation](#installation) - [Settings](#settings) - [Users And Clients](#users-and-clients) @@ -19,6 +20,11 @@ Before getting started there are some important things that you should know: - [Server Endpoints](#server-endpoints) - [Claims And Scopes](#claims-and-scopes) +## Requirements + +- Python 2.7.*. +- Django 1.7.*. + ## Installation Install the package using pip. @@ -26,7 +32,7 @@ Install the package using pip. ```bash pip install django-oidc-provider # Or latest code from repo. -pip install git+https://github.com/juanifioren/django-oidc-provider.git#egg=openid_provider +pip install git+https://github.com/juanifioren/django-oidc-provider.git#egg=oidc_provider ``` Add it to your apps. @@ -39,7 +45,7 @@ INSTALLED_APPS = ( 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', - 'openid_provider', + 'oidc_provider', # ... ) ``` @@ -49,7 +55,7 @@ Add the provider urls. ```python urlpatterns = patterns('', # ... - url(r'^openid/', include('openid_provider.urls', namespace='openid_provider')), + url(r'^openid/', include('oidc_provider.urls', namespace='oidc_provider')), # ... ) ``` @@ -70,10 +76,10 @@ LOGIN_URL = '/accounts/login/' # OPTIONAL SETTINGS. -DOP_CODE_EXPIRE = 60*10 # 10 min. -DOP_EXTRA_SCOPE_CLAIMS = MyAppScopeClaims, -DOP_IDTOKEN_EXPIRE = 60*10, # 10 min. -DOP_TOKEN_EXPIRE = 60*60 # 1 hour. +OIDC_CODE_EXPIRE = 60*10 # 10 min. +OIDC_EXTRA_SCOPE_CLAIMS = MyAppScopeClaims, +OIDC_IDTOKEN_EXPIRE = 60*10, # 10 min. +OIDC_TOKEN_EXPIRE = 60*60 # 1 hour. ``` ## Users And Clients @@ -221,4 +227,4 @@ See how we create our own scopes using the convention: If a field is empty or ``None`` will be cleaned from the response. -**Don't forget to add your class into your app settings.** \ No newline at end of file +**Don't forget to add your class into your app settings.**