Installation

Before Installing Grappelli, please take a look at the known Django Issues.

1. Download Grappelli

Install Grappelli anywhere on your python-path.

svn checkout http://django-grappelli.googlecode.com/svn/trunk/grappelli/ grappelli

2. Add Grappelli to your INSTALLED APPS

Open your projects settings-file (settings.py) and add Grappelli to your INSTALLED APPS.

INSTALLED_APPS = (
    ...
    'grappelli',
)

3. Add context-processors

Open your projects settings-file. For Grappelli, you need the request context processor. The authentication context processor is needed for the admin-interface anyway.

TEMPLATE_CONTEXT_PROCESSORS = (
    "django.core.context_processors.auth",
    "django.core.context_processors.request",
)

4. Change urls.py

Add Grappelli to your url-definitions.

(r'^grappelli/', include('grappelli.urls')),

5. Change grappelli/settings.py

Take a look at the available grappelli-settings and change them (if needed).

6. Sync your Database

Run the Django 'syncdb' command to create the appropriate tables.

python manage.py syncdb

This will create the tables for Bookmarks, Help & Navigation.

7. Optional: Load Fixtures

It´s recommended to load some initial data.

python manage.py loaddata grappelli_navigation.json --settings=settings
python manage.py loaddata grappelli_help.json --settings=settings

Note that the Admin-Links within the Fixtures begin with /admin/ ... if your Admin-Interface is accessible via a different URL, you have to change this (either change the json-files before loading or change the URLs afterwards).

8. Copy/Symlink media

Copy the folder /media/ to your admin media-directory. Alternatively, you might want to use a symlink.

cp -R /path/to/grappelli/media /path/to/your/admin/media

Note: If possible, avoid using /django/contrib/admin/media/ as your media directory (since it will break future django-updates).
If your ADMIN_MEDIA_PREFIX is /media/admin/ (for example), you need a directory "admin" within your media-directory. Inside of /admin/, you need all Grappelli media files.

9. Copy/Symlink Templates

Copy the folder /template/ to your admin templates-directory. Alternatively, you might want to use a symlink. Note: Avoid using "/django/contrib/admin/templates/" since it will break future django-updates.

cp -R /path/to/grappelli/templates /path/to/your/admin/templates

In order to overwrite the original admin-templates you need to make sure that your TEMPLATE_LOADERS are looking at the Filesystem first:

TEMPLATE_LOADERS = (
    'django.template.loaders.filesystem.load_template_source',
    'django.template.loaders.app_directories.load_template_source',
)

This step is necessary in order to overwrite Djangos Admin-Templates.