pr0d33p / django-keycloak

Django app to add Keycloak support to your project.

=============== Django Keycloak

.. image:: https://www.travis-ci.org/Peter-Slump/django-keycloak.svg?branch=master :target: https://www.travis-ci.org/Peter-Slump/django-keycloak :alt: Build Status .. image:: https://readthedocs.org/projects/django-keycloak/badge/?version=latest :target: http://django-keycloak.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status .. image:: https://codecov.io/gh/Peter-Slump/django-keycloak/branch/master/graph/badge.svg :target: https://codecov.io/gh/Peter-Slump/django-keycloak :alt: codecov .. image:: https://api.codeclimate.com/v1/badges/eb19f47dc03dec40cea7/maintainability :target: https://codeclimate.com/github/Peter-Slump/django-keycloak/maintainability :alt: Maintainability

Django app to add Keycloak support to your project.

Read documentation <http://django-keycloak.readthedocs.io/en/latest/>_

http://www.keycloak.org/

An showcase/demo project is added in the example folder <example/README.md>_.

Development

Install development environment:

.. code:: bash

$ 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:

.. code:: bash

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

Run the container

.. code:: bash

$ 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

.. code:: bash

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

Release Notes

unreleased

v0.2.5

• Add registeration redirect view

v0.2.4

• Fixed refresh token expiration date exists

v0.2.3

• Fixed ENTTITLMENT issue by commenting the code temporarily, till fully fixed
• https://issues.redhat.com/browse/KEYCLOAK-8353

v0.2.2

• Fixed issue by adding migration file to repo

v0.2.1

• Added a feature to use redirect url after successful login using settings.LOGIN_REDIRECT_URL

v0.2.0

• Added support for Python 3.9 & Django 4.1
• Fixed integration issues with keycloak > v4
  • Peter-Slump#57
  • Peter-Slump#18
  • oauth2-proxy/oauth2-proxy#1448
• Updated documentation.

v0.1.2-dev

v0.1.1

• Added support for remote user. Handling identities without registering a User model. (thanks to bossan <https://github.com/bossan>_)
• Addes support for permissions using resources and scopes. (thanks to bossan <https://github.com/bossan>_)
• Added example project.
• Updated documentation.

v0.1.0

• Correctly extract email field name on UserModel (thanks to swist <https://github.com/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