Metadata-Version: 2.0
Name: django-host-user-override
Version: 0.2
Summary: Override current user based on subdomain
Home-page: https://github.com/mpyrev/django-host-user-override
Author: Mikhail Pyrev
Author-email: mikhail.pyrev@gmail.com
License: MIT License
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Dist: Django (>=1.10)

django-host-user-override
=========================

Overrides current user based on host prefix. For example any request to
``5.user.example.com`` (format can be changed in settings) becomes
request as if you were logged in as user with ID 5. This allows you to
be logged in as different users in different tabs **at the same time**
without losing your primary authenticated user.

Works only if you're logged in as superuser.

Also gives you big red banner on top of every page if your user is
overridden.

Requirements
------------

-  Your DNS server should resolve subdomains ``*.user.<your domain>`` to
   the same IP address as main domain.
-  Your project should not use absolute link generation or any other
   technic that can change current subdomain. It is a more inconvenience
   than requirement though.

Installing django-host-user-override
------------------------------------

1. Install the package from PyPI:
   ``pip install django-host-user-override``

2. Add ``host_user_override`` to ``INSTALLED_APPS``:

   .. code:: python

       INSTALLED_APPS = [
          ...,
          'host_user_override',
          ...,
       ]

3. Add ``HostUserOverrideMiddleware`` right after
   ``AuthenticationMiddleware``:

   .. code:: python

       MIDDLEWARE = [
          ...,
          'django.contrib.auth.middleware.AuthenticationMiddleware',
          'host_user_override.middleware.HostUserOverrideMiddleware',
          ...,
       ]

4. Update your ``settings.py`` file to support subdomains (don't forget
   about DNS as well): \`\`\`python ALLOWED\_HOSTS = ['.example.com']

SESSION\_COOKIE\_DOMAIN = '.example.com' \`\`\`

5. Set new ``change_form.html`` template in ``UserAdmin``: \`\`\`python
   admin.site.unregister(User)

@admin.register(User) class CustomUserAdmin(UserAdmin):
change\_form\_template = 'host\_user\_override/change\_form.html' \`\`\`

Optional settings
~~~~~~~~~~~~~~~~~

6. Update ``settings.py`` if you want host pattern other than
   ``<id>.user.<domain>``. Example for ``u<id>.<domain>``: \`\`\`python
   HOSTUSEROVERRIDE\_HOST\_REGEXP = r'u(:raw-latex:`\d`+)..+'

HOSTUSEROVERRIDE\_HOST\_SUB\_REGEXP = r'u:raw-latex:`\d`+.'

HOSTUSEROVERRIDE\_REDIRECT\_URL\_FORMAT = 'http://u{user\_id}.{host}/'

HOSTUSEROVERRIDE\_PERMANENT\_REDIRECT = False \`\`\`

Usage
-----

Open any non-superuser in Django Admin and press 'Login as multiuser'
button.

License
-------

This project is licensed under the MIT License - see the
`LICENSE <LICENSE>`__ file for details.

Acknowledgments
---------------

-  Props to django-debug-toolbar team for HTML injection code
-  Thanks to @dimoha for original idea


