This document explain how to install Django Basic CMS into an existing Django project. This document assume that you already know how to setup a Django project.
If you have any problem installing this CMS, take a look at the example application that stands in the example directory. This application works out of the box and will certainly help you to get started.
After you have installed all the dependencies you can simply checkout the code with git:
git clone git://github.com/YD-Technology/django-basic-cms.git django-basic-cms
And then, run the example project:
cd django-basic-cms/example/
python manage.py syncdb
python manage.py build_static pages
python manage.py runserver
Then visit http://127.0.0.1:8000/admin/ and create a few pages.
The pip install is the easiest and the recommended installation method. Use:
$ sudo easy_install pip
$ wget -c http://github.com/YD-Technology/django-basic-cms/raw/master/requirements/external_apps.txt
$ sudo pip install -r external_apps.txt
Every package listed in the external_app.txt should be downloaded and installed.
If you are not using the source code version of the application then install it using:
$ sudo pip install django-basic-cms
On debian linux you can do:
$ sudo easy_install html5lib django django-authority
Optionnaly:
$ sudo easy_install django-haystack
If you are not using the source code version of the application then install it using:
$ sudo easy_install django-page-cms
Note
Django-Tagging and Django-mptt maybe required to be installed by hand or with subversion because the available packages are not compatible with django 1.0.
Take a look in the example/urls.py and copy desired URLs in your own urls.py. Basically you need to have something like this:
urlpatterns = patterns('',
...
url(r'^cms/', include('basic_cms.urls')),
(r'^admin/', include(admin.site.urls)),
)
When you will visit the site the first time (/cms/), you will get a 404 error because there is no published page. Go to the admin first and create and publish some pages.
You will certainly want to activate the static file serve view in your urls.py if you are in developement mode:
if settings.DEBUG:
urlpatterns += patterns('',
# Trick for Django to support static files (security hole: only for Dev environement! remove this on Prod!!!)
url(r'^media/(?P<path>.*)$', 'django.views.static.serve', {'document_root': settings.MEDIA_ROOT}),
url(r'^admin_media/(?P<path>.*)$', 'django.views.static.serve', {'document_root': settings.ADMIN_MEDIA_ROOT}),
)
All the Django Basic CMS specific settings and options are listed and explained in the pages/settings.py file.
Django Basic CMS require several of these settings to be set. They are marked in this document with a bold “must”.
Note
If you want a complete list of the available settings for this CMS visit the list of all available settings.
You must set PAGE_DEFAULT_TEMPLATE to the path of your default CMS template:
PAGE_DEFAULT_TEMPLATE = 'pages/index.html'
This template must exist somewhere in your project. If you want you can copy the example templates from the directory pages/templates/pages/examples/ into the directory page of your root template directory.
Optionally you can set PAGE_TEMPLATES if you want additional templates choices. In the the example application you have actually this:
PAGE_TEMPLATES = (
('pages/nice.html', 'nice one'),
('pages/cool.html', 'cool one'),
)
The django CMS come with some javascript and CSS files. These files are standing in the pages/static/pages directory.
Please first read how django handle languages
This CMS use the PAGE_LANGUAGES setting in order to present which language are supported by the CMS.
Django itself use the LANGUAGES setting to set the request.LANGUAGE_CODE value that is used by this CMS. So if the language you want to support is not present in the LANGUAGES setting the request.LANGUAGE_CODE will not be set correctly.
A possible solution is to redefine settings.LANGUAGES. For example you can do:
# Default language code for this installation. All choices can be found here:
# http://www.i18nguy.com/unicode/language-identifiers.html
LANGUAGE_CODE = 'en-us'
# This is defined here as a do-nothing function because we can't import
# django.utils.translation -- that module depends on the settings.
gettext_noop = lambda s: s
# here is all the languages supported by the CMS
PAGE_LANGUAGES = (
('de', gettext_noop('German')),
('fr-ch', gettext_noop('Swiss french')),
('en-us', gettext_noop('US English')),
)
# copy PAGE_LANGUAGES
languages = list(PAGE_LANGUAGES)
# redefine the LANGUAGES setting in order to be sure to have the correct request.LANGUAGE_CODE
LANGUAGES = languages
You must have these context processors into your TEMPLATE_CONTEXT_PROCESSORS setting:
TEMPLATE_CONTEXT_PROCESSORS = (
'django.core.context_processors.auth',
'django.core.context_processors.i18n',
'django.core.context_processors.debug',
'django.core.context_processors.media',
'django.core.context_processors.request',
'basic_cms.context_processors.media',
...
)
You must have these middleware into your MIDDLEWARE_CLASSES setting:
MIDDLEWARE_CLASSES = (
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.middleware.doc.XViewMiddleware',
'django.middleware.locale.LocaleMiddleware',
...
)
Django Basic CMS use the caching framework quite intensively. You should definitely setting-up a cache-backend to have decent performance.
You can easily setup a local memory cache this way:
CACHE_BACKEND = "locmem:///?max_entries=5000"
If you want to use the Django sites framework with Django Basic CMS, you must define the SITE_ID and PAGE_USE_SITE_ID settings and create the appropriate Site object into the admin interface:
PAGE_USE_SITE_ID = True
SITE_ID = 1
The Site object should have the domain that match your actual domain (ie: 127.0.0.1:8000)
Tagging is optional and disabled by default.
If you want to use it set PAGE_TAGGING at True into your setting file and add it to your installed apps:
INSTALLED_APPS = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.admin',
'django.contrib.sites',
'mptt',
'tagging',
'basic_cms',
...
)