Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 2.71 KB

README.rst

File metadata and controls

99 lines (69 loc) · 2.71 KB
Raw

Django Keycloak

Build Status Documentation Status codecov Maintainability

Django app to add Keycloak support to your project.

Read documentation

http://www.keycloak.org/

An showcase/demo project is added in the example folder.

Development

Install development environment:

$ make install-python

Writing docs

Documentation is written using Sphinx and maintained in the docs folder.

To make it easy to write docs Docker support is available.

First build the Docker container:

$ docker build . -f DockerfileDocs -t django-keycloak-docs

Run the container

$ docker run -v `pwd`:/src --rm -t -i -p 8050:8050 django-keycloak-docs

Go in the browser to http://localhost:8050 and view the documentation which get refreshed and updated on every update in the documentation source.

Create release

$ git checkout master
$ git pull
$ bumpversion release
$ make deploy-pypi
$ bumpversion --no-tag patch
$ git push origin master --tags

Release Notes

** pb custom versions ** - custom approach to managing realm/client usage - include register url - support KeycloakDRFAUthorizationBackend - use settings.LOGIN_REDIRECT_URL if available

unreleased

v0.1.2-dev

v0.1.1

  • Added support for remote user. Handling identities without registering a User model. (thanks to bossan)
  • Addes support for permissions using resources and scopes. (thanks to bossan)
  • Added example project.
  • Updated documentation.

v0.1.0

  • Correctly extract email field name on UserModel (thanks to swist)
  • Add support for Oauth2 Token Exchange to exchange tokens with remote clients. Handy when using multiple applications with different clients which have to communicate with each other.
  • Support for session iframe