Show a page before your users authenticate into the admin site
Project description
Django Frontpage
Show a page before your users authenticate into the admin site.
Valid users will go straight to the admin site, others will land in the frontpage where you can show an app description, warning, etc. You only need to provide your own template.
After clicking the login button in the frontpage, the user will be redirected to the
original url. If there was no original url, the user will be redirected to the
FRONTPAGE_ADMIN_PREFIX
.
Getting started
Works with Django version 2.0 to 3.1.
Tested with Django-supported Python versions.
Install:
pip install django-frontpage
Then modify your Django settings:
Add the frontpage
application to INSTALLED_APPS
:
INSTALLED_APPS = (
...
'frontpage',
...
)
Add the middleware to MIDDLEWARE
after AuthenticationMiddleware
or any
other authentication middleware like OAuth2:
MIDDLEWARE = [
...
'django.contrib.auth.middleware.AuthenticationMiddleware',
'oauth2_provider.backends.OAuth2Backend',
'frontpage.middleware.FrontpageMiddleware',
...
]
Default admin prefix is '/admin/'
change it if necessary:
FRONTPAGE_ADMIN_PREFIX = '/admin/'
Add the frontpage view to your urls:
from frontpage.views import FrontpageView
urlpatterns = [
path('', FrontpageView.as_view(), name='frontpage'),
path('admin/', admin.site.urls),
...
]
Demo
Here's how the default template looks like:
Custom frontpage template
Place a different frontpage template in frontpage/index.html
.
Or use the template_name
attribute in urls.py
:
from frontpage.views import FrontpageView
urlpatterns = [
path('', FrontpageView.as_view(template_name='my_frontpage.html'), name='frontpage'),
path('admin/', admin.site.urls),
...
]
See frontpage/templates/frontpage/index.html for the default frontpage template.
Settings
Option | Default | Description |
---|---|---|
FRONTPAGE_ADMIN_PREFIX |
'/admin/' | mandatory, the path of the admin site. |
FRONTPAGE_URL_NAME |
'frontpage' | name of the frontpage url |
FRONTPAGE_LOGIN_URL_NAME |
'admin:login' | name of the login url |
FRONTPAGE_LOGOUT_URL_NAME |
'admin:logout' | name of the logout url |
FRONTPAGE_RELOGIN_URL_NAME |
'admin:login' | name of the relogin url |
Frontpage needs to know about the logout url because that one should not be redirected.
Relogin is necessary if you are logged in as an user that does not have access to the admin. You may need to implement a custom view to logout the user then redirect to some login URL.
Flow
When the frontpage
is accessed then:
- if the user
is_authenticated
andis_staff
then:- the user will be redirected to the
admin
site
- the user will be redirected to the
- if the user
is_authenticated
but NOTis_staff
then:frontpage
is rendered with a specific message
- if the user is anonymous then:
frontpage
is rendered with a specific message
When any page of the admin
site is accessed then:
- if the user
is_authenticated
andis_staff
then:- everything is ok,
frontpage
will do nothing here
- everything is ok,
- if the user
is_authenticated
but NOTis_staff
then:- the user will be redirected to the
frontpage
page
- the user will be redirected to the
- if the user is anonymous then:
- the user will be redirected to the
frontpage
page
- the user will be redirected to the
Tests
pip install -r requirements-dev.txt
pip install Django
pytest
Authors
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.