Configuration
There are various configuration options that can be set via Django Settings to control the overall look, feel, and functionality of the package. All settings are listed here for reference even though some of these settings such as the Menu and Authorization can become quite complex and have dedicated documentation pages to better explain the full extent of these settings.
Home Configuration
ADMINLTE2_HOME_ROUTE
Set the “Home” route for you project so that the package knows where to redirect users when they click a link that is designed to take the user home.
- Type
string
- Default
django_adminlte_2:home
Example:
ADMINLTE2_HOME_ROUTE = 'django_adminlte_2:home'
Logo & Skin Color Configuration
ADMINLTE2_LOGO_TEXT
Set the Logo text for your site that will be shown in the top left of the top bar.
Note
If you would like to include html in your text, you will need to import
and use mark_safe
from django.utils.safestring
. Otherwise, your
html will be escaped.
- Type
string
- Default
AdminLTE
Example:
ADMINLTE2_LOGO_TEXT = 'My Awesome Site'
ADMINLTE2_LOGO_TEXT_SMALL
Set the small Logo text for your site that will be shown in the top left of the top bar when the side bar is collapsed.
Note
If you would like to include html in your text, you will need to import
and use mark_safe
from django.utils.safestring
. Otherwise, your
html will be escaped.
- Type
string
- Default
ALTE
Example:
ADMINLTE2_LOGO_TEXT = 'MAS'
ADMINLTE2_SKIN_CLASS
Set the skin class to use for the site. Valid skin classes can be found on the AdminLTE documentation page.
- Type
string
- Default
skin-blue
Example:
ADMINLTE2_SKIN_CLASS = 'skin-green-light'
Admin Configuration
Important
All of the settings in this section manipulate the admin section of the sidebar.
However, by default, the admin sidebar section is only shown on Django Admin pages . If you would like to change this behavior so that the admin sidebar section is available on all pages, please see the ADMINLTE2_INCLUDE_ADMIN_NAV_ON_MAIN_PAGES section for more information.
ADMINLTE2_INCLUDE_ADMIN_HOME_LINK
By default the admin menu sidebar will not have a link to the admin index page.
If you would like to see a link to the admin index page in the sidebar, set this
setting to True
.
Note
This link is in essence another Admin link and as such will be treated like all other admin links. If you do not see this link in your sidebar after enabling, please refer to the ADMINLTE2_INCLUDE_ADMIN_NAV_ON_MAIN_PAGES setting for more information.
- Type
bool
- Default
False
Example:
ADMINLTE2_INCLUDE_ADMIN_HOME_LINK = {True|False}
ADMINLTE2_ADMIN_INDEX_USE_APP_LIST
By default Django-AdminLTE-2 will put the Apps on the Admin Index page
into AdminLTE Info Boxes. Setting this to True
will change that look
to the traditional Django list view but still within the main AdminLTE site
styling.
Note
If you do not see a link for the admin index page in the sidebar, please refer to the ADMINLTE2_INCLUDE_ADMIN_HOME_LINK setting for information on how to enable it.
- Type
bool
- Default
False
Example:
ADMINLTE2_ADMIN_INDEX_USE_APP_LIST = {True|False}