Skip to content
This repository has been archived by the owner on Oct 25, 2019. It is now read-only.

Latest commit

 

History

History
78 lines (52 loc) · 1.75 KB

installation.rst

File metadata and controls

78 lines (52 loc) · 1.75 KB

Installation

Requirements

  • django>=1.4
  • lxml
  • html5lib

Installation

To get started using django-html5-appcache install it with pip:

$ pip install django-html5-appcache

If you want to use the development version install from github:

$ pip install git+https://github.com/nephila/django-html5-appcache.git#egg=django-html5-appcache

Requirements will be automatically installed.

Run migrate command to sync your database:

$ python manage.py migrate html5_appcache

Warning

Migrations have been added in 0.3.0. Don't skip this if you are upgrading from 0.2.

Basic configuration

  • Add html5_appcache to INSTALLED_APPS.
  • Include in your URLCONF:

    urlpatterns += patterns('',
        url('^', include('html5_appcache.urls')),
    )

Warning

on Django 1.4+ (or django CMS 2.4+) you may need to use i18npatterns instead of patterns above, depending on you project layout.

  • Enable appcache discovery by adding the lines below in urls.py:

    import html5_appcache
    html5_appcache.autodiscover()
  • Add the middleware just below django.middleware.cache.UpdateCacheMiddleware, if used, or at the topmost position:

    'html5_appcache.middleware.appcache_middleware.AppCacheAssetsFromResponse'
  • Insert appcache_link template tag in your templates:

    {% load appcache_tags  %}
    <html {% appcache_link %} >
     <head>
     ...
     </head>
     <body>
     ...
     </body>
    </html>
  • Enable the cache for your project. Refer to Django :djangoCACHES configuration.

django CMS integration

See django CMS installation <djangocms-installation>.