django-rocketchat-auth

Authenticate Rocket.Chat with Django Framework


License
MIT
Install
pip install django-rocketchat-auth==1.2

Documentation

django-rocketchat-auth

Authenticate your Rocket.Chat users with Django web framework.

This app implements the API used by Rocket.Chat IFrame authentication. Also, it handles logout by wiring up a method on Django signals.

Quickstart

  1. Install this app in you project:

    pip install django-rocketchat-auth
    
  2. Add "rocketchat_auth" to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = (
        ...
        'rocketchat_auth',
    )
    
  3. Update your settings.py:

    MONGO_DB = 'localhost:27017'
    ROCKETCHAT = 'localhost'
    
  4. Include the rocketchat_auth URLconf in your project urls.py like this:

    urlpatterns += [url(r'^rocketchat/', include('rocketchat_auth.urls'))]
    
  5. You will probably need to use django-cors-headers and set your Rocket.Chat domain in CORS_ORIGIN_WHITELIST

  6. Now go to your Rocket.Chat admin page > Settings > Accounts. Enable Iframe and set:

Roadmap

  • Enforce unique email registration in Django admin, since Rocket.Chat requires this.
  • Update Rocket.Chat user details in MongoDB when the user is modified in Django Admin.