Skip to main content
Django Unfold provides extensive configuration options through the UNFOLD setting in your Django settings file. All settings are optional and have sensible defaults.

​
Configuration structure

Add the UNFOLD dictionary to your Django settings:
settings.py
UNFOLD = {
    "SITE_TITLE": "My Admin",
    "SITE_HEADER": "Administration",
    # ... other settings
}

​
Site branding

​
SITE_TITLE
string
default:"None"
The site title displayed in the browser tab and admin header.
​
SITE_HEADER
string
default:"None"
The main header text displayed in the admin interface.
​
SITE_SUBHEADER
string
default:"None"
Subheader text displayed below the main header.
​
SITE_DROPDOWN
string
default:"None"
Content for the site dropdown menu in the header.
​
SITE_URL
string
default:"/"
URL the site logo/title links to.
​
SITE_ICON
string
default:"None"
Path to the icon displayed in the admin interface.
​
SITE_SYMBOL
string
default:"None"
Symbol or short text displayed alongside the site title.
Path to the logo image displayed in the admin interface.

​
Display options

​
SHOW_HISTORY
boolean
default:"True"
Show the history link in the admin interface for objects.
​
SHOW_VIEW_ON_SITE
boolean
default:"True"
Display the “View on site” button when available.
​
SHOW_LANGUAGES
boolean
default:"False"
Enable language switcher in the admin interface.
​
LANGUAGE_FLAGS
object
default:"{}"
Dictionary mapping language codes to flag icons or images.
​
SHOW_BACK_BUTTON
boolean
default:"False"
Show a back button in the admin interface navigation.

​
Environment

​
ENVIRONMENT
string
default:"None"
Environment name displayed in the admin interface (e.g., “Development”, “Staging”, “Production”).
​
ENVIRONMENT_TITLE_PREFIX
string
default:"None"
Prefix added to browser tab titles based on environment.

​
Dashboard

​
DASHBOARD_CALLBACK
string
default:"None"
Python path to a callback function that customizes the dashboard view.

​
Forms

​
FORMS
object
default:"{classes: {...}}"
Configuration for form widget styles and classes.

​
Account

​
ACCOUNT
object
default:"{navigation: []}"
Account menu configuration.

​
Languages

​
LANGUAGES
object
default:"{action: None, navigation: []}"
Language switcher configuration.

​
Command palette

​
COMMAND
object
Command palette search configuration.
​
SIDEBAR
object
Sidebar navigation configuration.

​
Tabs

​
TABS
array
default:"[]"
Configuration for tab navigation in the admin interface. Define custom tabs for organizing admin sections.

​
Extensions

​
EXTENSIONS
object
default:"{modeltranslation: {flags: {}}}"
Configuration for Django Unfold extensions.

​
Example configuration

settings.py
UNFOLD = {
    "SITE_TITLE": "My Admin Panel",
    "SITE_HEADER": "Administration",
    "SITE_URL": "/",
    "SITE_ICON": "/static/icon.svg",
    "SHOW_HISTORY": True,
    "SHOW_VIEW_ON_SITE": True,
    "ENVIRONMENT": "production",
    "SIDEBAR": {
        "show_search": True,
        "show_all_applications": True,
    },
    "TABS": [
        {
            "models": [
                "app.Model1",
                "app.Model2",
            ],
            "items": [
                {
                    "title": "Dashboard",
                    "link": "/admin/",
                },
            ],
        },
    ],
}
Settings are merged with defaults using deep merging. You only need to specify the settings you want to override.

Build docs developers (and LLMs) love

Get started for freeTalk to us