How to change site title, site header and index title in Django Admin?
Asked Answered
R

24

277

How can I change the site title Django site admin, the site header Django administration and the index title Site administration in Django Admin?

enter image description here

Rhinoscopy answered 8/2, 2011 at 21:10 Comment(2)
This is covered in the tutorial.Joceline
The best answer is belowSanderson
S
147

Update: If you are using Django 1.7+, see the answer below.


Original answer from 2011: You need to create your own admin base_site.html template to do this. The easiest way is to create the file:

/<projectdir>/templates/admin/base_site.html

This should be a copy of the original base_site.html, except putting in your custom title:

{% block branding %}
<h1 id="site-name">{% trans 'my cool admin console' %}</h1>
{% endblock %}

For this to work, you need to have the correct settings for your project, namely in settings.py:

  • Make sure /projectdir/templates/ is added into TEMPLATE_DIRS.
  • Make sure django.template.loaders.filesystem.Loader is added into TEMPLATE_LOADERS.

See docs for more information on settings.py.

Scranton answered 8/2, 2011 at 21:27 Comment(6)
Also note that you can {% extends "admin/base.html" %} in /<projectdir>/templates/admin/base_site.html, and simply redefine the block(s) you need, i.e. {% block branding %}...{% endblock %}.Subservient
even if quite old, I want to add that you must put your app where you define this template before 'django.contrib.admin', in INSTALLED_APPSChemotaxis
@Arnaud, THAT is the cleanest answerNewbill
In django 1.6 python 3.3, the above works even when you don't add the TEMPLATE_LOADER setting. Just TEMPLATE_DIR is enough it seemsCorbie
This is outdated as of 1.7. See Reto Aebersold's answer.Uncut
Try this in url.py admin.site.site_header = 'My Administration' admin.site.index_title = ('My Admin') admin.site.site_title = ('My Admin page')Kim
C
424

As of Django 1.7 you don't need to override templates. You can now implement site_header, site_title, and index_title attributes on a custom AdminSite in order to easily change the admin site’s page title and header text. Create an AdminSite subclass and hook your instance into your URLconf:

admin.py:

from django.contrib.admin import AdminSite
from django.utils.translation import ugettext_lazy

class MyAdminSite(AdminSite):
    # Text to put at the end of each page's <title>.
    site_title = ugettext_lazy('My site admin')

    # Text to put in each page's <h1> (and above login form).
    site_header = ugettext_lazy('My administration')

    # Text to put at the top of the admin index page.
    index_title = ugettext_lazy('Site administration')

admin_site = MyAdminSite()

urls.py:

from django.conf.urls import patterns, include
from myproject.admin import admin_site

urlpatterns = patterns('',
    (r'^myadmin/', include(admin_site.urls)),
)

Update: As pointed out by oxfn you can simply set the site_header in your urls.py or admin.py directly without subclassing AdminSite:

admin.site.site_header = 'My administration'
Coan answered 27/7, 2014 at 16:53 Comment(7)
This throws a "You don't have permission to edit anything" error message when I try to access the /myadmin/. Looks like I should call .autodiscover, but Django 1.7 it's supposed to be called automatically. Any clue?Benbena
@DavidArcos You need to register your models at new admin_site that you created. Like admin_site.register(MyModel, ModelAdmin)Cargo
If also a header in django.auth.views should be customized (that depends on admin/base_site.html template, e.g. password_reset) then also extra_context should be used in urls: e.g. url(r'^password_reset/$', auth_views.password_reset, name='admin_password_reset', kwargs={'extra_context': {'site_header': "My administration"}})Myra
Something to know about this way is that it will only work with the standard admin pages, if on your side on another application you are adding your own admin pages (extendind the admin base template), they will always take the default "Django Administration" title.Nombril
@oxfn If I have more than one apps, the admin.site.site_header configuration in which app*/admin.py would take effect?Bookstore
I got this error - django.core.exceptions.ImproperlyConfigured: Passing a 3-tuple to include() is not supported. Pass a 2-tuple containing the list of patterns and app_name, and provide the namespace argument to include() instead.Transcaucasia
If you override AdminSite, you get you dont have permission. To solve this issue check here out:docs.djangoproject.com/en/dev/ref/contrib/admin/…Shererd
A
259

There is an easy way to set admin site header - assign it to current admin instance in urls.py like this

admin.site.site_header = 'My admin'

Or one can implement some header-building magic in separate method

admin.site.site_header = get_admin_header()

Thus, in simple cases there's no need to subclass AdminSite

Amah answered 24/9, 2014 at 8:11 Comment(8)
I added it in my url.py right after urlpattern. But it didn't work when I'm running the site with nginxHorsecar
@AlexJolig nginx shouldn't be a problem. Which backenf fo you use? Did you restart it?Amah
The first way worked. I dont really know what was the problem at the moment. thank youHorsecar
If you're changing the header, you'll probably also want to change the site title, which can be accomplished with: admin.site.site_title = 'My site admin'.Mutism
Here is an import string to add to urls.py: from django.contrib import adminEyelet
Wish I found this first... Heeding the docs, I subclassed AdminSite and spent a while trying to make it work with autodiscover() but finally thought of this solution on my own. I actually have my override in admin.py, which I think is cleaner since it's kept along with all the other admin-related logicSeavey
check the list of all the attributes you can change at docs.djangoproject.com/en/1.11/ref/contrib/admin/…Bernadette
even after 10 years this works, thank you. I placed it in my urls.py and it works in a custom theme.Hohenzollern
C
174

In urls.py you can override the 3 most important variables:

from django.contrib import admin

admin.site.site_header = 'My project'                    # default: "Django Administration"
admin.site.index_title = 'Features area'                 # default: "Site administration"
admin.site.site_title = 'HTML title from adminsitration' # default: "Django site admin"

Reference: Django documentation on these attributes.

Carolecarolee answered 27/3, 2016 at 19:39 Comment(2)
This should be the CORRECT answer to this question. This is the most appropriated and elegant solution.Carolecarolee
is there's a way to having username of logged-in user with title of index for example: admin.site.index_title = request.user.username+' Features area'Karyokinesis
S
147

Update: If you are using Django 1.7+, see the answer below.


Original answer from 2011: You need to create your own admin base_site.html template to do this. The easiest way is to create the file:

/<projectdir>/templates/admin/base_site.html

This should be a copy of the original base_site.html, except putting in your custom title:

{% block branding %}
<h1 id="site-name">{% trans 'my cool admin console' %}</h1>
{% endblock %}

For this to work, you need to have the correct settings for your project, namely in settings.py:

  • Make sure /projectdir/templates/ is added into TEMPLATE_DIRS.
  • Make sure django.template.loaders.filesystem.Loader is added into TEMPLATE_LOADERS.

See docs for more information on settings.py.

Scranton answered 8/2, 2011 at 21:27 Comment(6)
Also note that you can {% extends "admin/base.html" %} in /<projectdir>/templates/admin/base_site.html, and simply redefine the block(s) you need, i.e. {% block branding %}...{% endblock %}.Subservient
even if quite old, I want to add that you must put your app where you define this template before 'django.contrib.admin', in INSTALLED_APPSChemotaxis
@Arnaud, THAT is the cleanest answerNewbill
In django 1.6 python 3.3, the above works even when you don't add the TEMPLATE_LOADER setting. Just TEMPLATE_DIR is enough it seemsCorbie
This is outdated as of 1.7. See Reto Aebersold's answer.Uncut
Try this in url.py admin.site.site_header = 'My Administration' admin.site.index_title = ('My Admin') admin.site.site_title = ('My Admin page')Kim
P
73

A simple complete solution in Django 1.8.3 based on answers in this question.

In settings.py add:

ADMIN_SITE_HEADER = "My shiny new administration"

In urls.py add:

from django.conf import settings
admin.site.site_header = settings.ADMIN_SITE_HEADER
Principle answered 30/7, 2015 at 8:25 Comment(5)
Is there a better place to do this than using urls.py ?Goatskin
@VenkatKotra Yes, in admin.py. If you don't already have it, just create it and don't forget to add from django.contrib import admin.Seavey
The recommended way to import settings is via - "from django.conf import settings" (see docs.djangoproject.com/en/1.9/topics/settings/…)Heredity
There is no setting that Django looks at called ADMIN_SITE_HEADER, the only thing that matters here is the line in urls.pyPilose
I followed this way and have the named defined in settings first then imported into the url.py as explained above. I did the same for the login and the html title and all three worked well. ==> in url.py: {{ from django.conf import settings }} admin.site.site_header = settings.ADMIN_SITE_HEADER admin.site.site_title = settings.ADMIN_SITE_TITLE admin.site.index_title = settings.ADMIN_SITE_INDEXAshleeashleigh
O
24

For Django 2.1.1 add following lines to urls.py

from django.contrib import admin

# Admin Site Config
admin.sites.AdminSite.site_header = 'My site admin header'
admin.sites.AdminSite.site_title = 'My site admin title'
admin.sites.AdminSite.index_title = 'My site admin index'
Otte answered 16/9, 2018 at 2:24 Comment(0)
R
23

The easiest way of doing it make sure you have

from django.contrib import admin

and then just add these at bottom of url.py of you main application

admin.site.site_title = "Your App Title"
admin.site.site_header = "Your App Admin" 
Raffarty answered 29/3, 2017 at 21:8 Comment(0)
F
21

Hope am not too late to the party, The easiest would be to edit the admin.py file.

admin.site.site_header = 'your_header'
admin.site.site_title = 'site_title'
admin.site.index_title = 'index_title'
Farris answered 20/1, 2021 at 1:30 Comment(0)
D
16

Simple Method is add following code in your url.py

    urlpatterns = [
    #Your URLS here
    path('admin/', admin.site.urls),
]

admin.site.site_header = 'SiteName Admin'
admin.site.site_title  = 'SiteName'
admin.site.index_title   = 'Admin'
Demonstrate answered 6/4, 2022 at 7:11 Comment(0)
H
10

As you can see in the templates, the text is delivered via the localization framework (note the use of the trans template tag). You can make changes to the translation files to override the text without making your own copy of the templates.

  1. mkdir locale

  2. ./manage.py makemessages

  3. Edit locale/en/LC_MESSAGES/django.po, adding these lines:

    msgid "Django site admin"
    msgstr "MySite site admin"
    
    msgid "Django administration"
    msgstr "MySite administration"
    
  4. ./manage.py compilemessages

See https://docs.djangoproject.com/en/1.3/topics/i18n/localization/#message-files

Hocker answered 14/2, 2012 at 22:29 Comment(1)
This is a terrible solution. Overriding translation strings is just an awful idea.Emphasize
H
9

From Django 2.0 you can just add a single line in the url.py and change the name.

# url.py

from django.contrib import admin 
admin.site.site_header = "My Admin Central" # Add this

For older versions of Django. (<1.11 and earlier) you need to edit admin/base_site.html

Change this line

{% block title %}{{ title }} | {{ site_title|default:_('Django site admin') }}{% endblock %}

to

{% block title %}{{ title }} | {{ site_title|default:_('Your Site name Admin Central') }}{% endblock %}

You can check your django version by

django-admin --version
Holofernes answered 29/2, 2020 at 9:35 Comment(0)
W
8

There are two methods to do this:

1] By overriding base_site.html in django/contrib/admin/templates/admin/base_site.html: Following is the content of base_site.html:

{% extends "admin/base.html" %}

{% block title %}{{ title }} | {{ site_title|default:_('Django site admin') }}{% endblock %}

{% block branding %}
<h1 id="site-name"><a href="{% url 'admin:index' %}">{{ site_header|default:_('Django administration') }}</a></h1>
{% endblock %}

{% block nav-global %}{% endblock %}

Edit the site_title & site_header in the above code snippet. This method works but it is not recommendable since its a static change.

2] By adding following lines in urls.py of project's directory:

admin.site.site_header = "AppHeader"
admin.site.site_title = "AppTitle"
admin.site.index_title = "IndexTitle"
admin.site.site_url = "Url for view site button"

This method is recommended one since we can change the site-header, site-title & index-title without editing base_site.html.

Westward answered 28/1, 2020 at 10:44 Comment(0)
C
8

Use format_html to allow html to be rendered, otherwise it will be just plain text.

in your main urls.py file add followings(urls.py is in the directory where settings.py exist):

from django.contrib import admin
from django.utils.html import format_html

site_header = 'Your html snippet'
admin.site.site_header = format_html(site_header)
Copious answered 31/5, 2021 at 8:21 Comment(1)
is There's a way to get the username of the logged-in user for example admin.site.index_title = request.user.username + ' AdminKaryokinesis
S
7

admin.py:

from django.contrib.admin import AdminSite

AdminSite.site_title = ugettext_lazy('My Admin')

AdminSite.site_header = ugettext_lazy('My Administration')

AdminSite.index_title = ugettext_lazy('DATA BASE ADMINISTRATION')
Syndicate answered 13/3, 2017 at 17:56 Comment(1)
from django.utils.translation import ugettext_lazy Don't forget to add this line.Lowrey
P
7

Just go to admin.py file and add this line in the file :

admin.site.site_header = "My Administration"

Phenice answered 22/4, 2020 at 13:57 Comment(0)
P
6

First of all, you should add templates/admin/base_site.html to your project. This file can safely be overwritten since it’s a file that the Django devs have intended for the exact purpose of customizing your admin site a bit. Here’s an example of what to put in the file:

{% extends "admin/base.html" %}
{% load i18n %}

{% block title %}{{ title }} | {% trans 'Some Organisation' %}{% endblock %}

{% block branding %}
<style type="text/css">
  #header
  {
    /* your style here */
  }
</style>
<h1 id="site-name">{% trans 'Organisation Website' %}</h1>
{% endblock %}

{% block nav-global %}{% endblock %}

This is common practice. But I noticed after this that I was still left with an annoying “Site Administration” on the main admin index page. And this string was not inside any of the templates, but rather set inside the admin view. Luckily it’s quite easy to change. Assuming your language is set to English, run the following commands from your project directory:

$ mkdir locale
$ ./manage.py makemessages -l en

Now open up the file locale/en/LC_MESSAGES/django.po and add two lines after the header information (the last two lines of this example)

"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2010-04-03 03:25+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

msgid "Site administration"
msgstr "Main administration index"

After this, remember to run the following command and reload your project’s server:

$ ./manage.py compilemessages

source: http://overtag.dk/wordpress/2010/04/changing-the-django-admin-site-title/

Pikeperch answered 14/7, 2013 at 21:50 Comment(2)
Linking to outside sites is considered bad, since the link might go bad. You are encouraged to rewrite the answer from the site here.Stupor
I rewrote the answer in case you don't wanna go outside site.Pikeperch
I
6

You can use these following lines in your main urls.py

you can add the text in the quotes to be displayed

To replace the text Django admin use admin.site.site_header = ""

To replace the text Site Administration use admin.site.site_title = ""

To replace the site name you can use admin.site.index_title = ""

To replace the url of the view site button you can use admin.site.site_url = ""

Izy answered 6/7, 2020 at 6:28 Comment(0)
B
5

you do not need to change any template for this work you just need to update the settings.py of your project. Go to the bottom of the settings.py and define this.

admin.site.site_header = 'My Site Admin'

In this way you would be able to change the header of the of the Django admin. Moreover you can read more about Django Admin customization and settings on the following link.

Django Admin Documentation

Barret answered 12/4, 2016 at 13:37 Comment(0)
O
5

You can use AdminSite.site_header to change that text. Here is the docs

Overhaul answered 12/8, 2017 at 8:25 Comment(0)
R
5

In admin.py file just override these attributes

from django.contrib import admin

admin.site.site_header = "site header name"
admin.site.index_title = "index title name"
admin.site.site_title = "site title name"
Reprobation answered 26/5, 2023 at 8:29 Comment(0)
S
4

You just override the admin/base_site.html template (copy the template from django.contrib.admin.templates and put in your own admin template dir) and replace the branding block.

Schonthal answered 8/2, 2011 at 21:25 Comment(0)
D
4

Since I only use admin interface in my app, I put this in the admin.py :

admin.site.site_header = 'My administration'
Doolie answered 12/4, 2016 at 13:27 Comment(0)
T
3

You can change site title, site header and index title in Django Admin as shown below:

# "admin.py"

from django.contrib import admin

admin.site.site_title = 'My site title'
admin.site.site_header = 'My site header'
admin.site.index_title = 'My index title'

Then, these are changed as shown below:

enter image description here

In addition, you can translate them with gettext_lazy() as shown below. *gettext() doesn't work for them and you can see my answer explaining how to translate in Django:

# "admin.py"

from django.contrib import admin
from django.utils.translation import gettext_lazy as _

admin.site.site_title = _('My site title')
admin.site.site_header = _('My site header')
admin.site.index_title = _('My index title')

Then, these are translated as shown below:

enter image description here

Tiffin answered 18/6, 2023 at 10:36 Comment(0)
C
0

One easy method is to include the following code in the urls.py file located in your project folder.

 in urls.py add 

  admin.site.site_header  =  "Site Header here"  
  admin.site.site_title  =  "Side title"
  admin.site.index_title  =  "Index title"

For example:

from django.contrib import admin
from django.urls import path
from django.conf.urls import include
from django.conf.urls.static import static
from django.conf import settings


admin.site.site_header  =  "Hadramawt Kitchen"  
admin.site.site_title  =  "Hadramawt Kitchen"
admin.site.index_title  =  "Hadramawt Admin"

urlpatterns = [
  path('admin/', admin.site.urls),
  path('', include('food_products.urls' )),
  path('categories', include('categories.urls' )),
  path('news', include('news.urls')),
  path('weeklyOffer', include('weekly_offer.urls'))
]+ static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
Classroom answered 14/1, 2023 at 15:55 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.