1. Introductory Tutorial

This guide assumes your machine meets the requirements outlined in the Installation section of this documentation.

1.1. Getting help

Should you run into trouble and can’t figure out how to solve it yourself, you can get help from either our mailinglist or IRC channel #django-cms on the irc.freenode.net network.

1.2. Configuration and setup

1.2.1. Preparing the environment

Gathering the requirements is a good start, but we now need to give the CMS a Django project to live in, and configure it.

1.2.1.1. Starting your Django project

The following assumes your project will be in ~/workspace/myproject/.

Set up your Django project:

  1. cd ~/workspace
  2. django-admin.py startproject myproject
  3. cd myproject
  4. python manage.py runserver

Open 127.0.0.1:8000 in your browser. You should see a nice “It Worked” message from Django.

it-worked

1.2.1.2. Installing and configuring django CMS in your Django project

Open the file ~/workspace/myproject/settings.py.

To make your life easier, add the following at the top of the file:

  1. # -*- coding: utf-8 -*-
  2. import os
  3. gettext = lambda s: s
  4. PROJECT_PATH = os.path.split(os.path.abspath(os.path.dirname(__file__)))[0]

Add the following apps to your INSTALLED_APPS. This includes django CMS itself as well as its dependenices and other highly recommended applications/libraries:

  • 'cms', django CMS itself
  • 'mptt', utilities for implementing a modified pre-order traversal tree
  • 'menus', helper for model independent hierarchical website navigation
  • 'south', intelligent schema and data migrations
  • 'sekizai', for javascript and css management

Also add any (or all) of the following plugins, depending on your needs:

  • 'cms.plugins.file'
  • 'cms.plugins.flash'
  • 'cms.plugins.googlemap'
  • 'cms.plugins.link'
  • 'cms.plugins.picture'
  • 'cms.plugins.snippet'
  • 'cms.plugins.teaser'
  • 'cms.plugins.text'
  • 'cms.plugins.video'
  • 'cms.plugins.twitter'

Warning

Adding the 'cms.plugins.snippet' plugin is a potential security hazard. For more information, refer to Snippet.

The plugins are described in more detail in chapter Plugins reference. There are even more plugins available on the django CMS extensions page.

In addition, make sure you uncomment (enable) 'django.contrib.admin'

you may also wish to use django-filer and its components with the django CMS plugin instead of the cms.plugins.file, cms.plugins.picture, cms.plugins.teaser and cms.plugins.video core plugins. In this case you should not add them to INSTALLED_APPS but add the following instead:

  • 'filer'
  • 'cmsplugin_filer_file'
  • 'cmsplugin_filer_folder'
  • 'cmsplugin_filer_image'
  • 'cmsplugin_filer_teaser'
  • 'cmsplugin_filer_video'

Note

See the django-filer documentation and django CMS plugin documentation for detailed installation information.

If you opt for the core plugins you should take care that directory to which the CMS_PAGE_MEDIA_PATH setting points (by default cms_page_media/ relative to MEDIA_ROOT) is writable by the user under which Django will be running. If you have opted for django-filer there is a similar requirement for its configuration.

If you want versioning of your content you should also install django-reversion and add it to INSTALLED_APPS:

  • 'reversion'

You need to add the django CMS middlewares to your MIDDLEWARE_CLASSES at the right position:

  1. MIDDLEWARE_CLASSES = (
  2.     'django.contrib.sessions.middleware.SessionMiddleware',
  3.     'django.middleware.csrf.CsrfViewMiddleware',
  4.     'django.contrib.auth.middleware.AuthenticationMiddleware',
  5.     'django.contrib.messages.middleware.MessageMiddleware',
  6.     'django.middleware.locale.LocaleMiddleware',
  7.     'django.middleware.doc.XViewMiddleware',
  8.     'django.middleware.common.CommonMiddleware',
  9.     'cms.middleware.page.CurrentPageMiddleware',
  10.     'cms.middleware.user.CurrentUserMiddleware',
  11.     'cms.middleware.toolbar.ToolbarMiddleware',
  12.     'cms.middleware.language.LanguageCookieMiddleware',
  13. )

You need at least the following TEMPLATE_CONTEXT_PROCESSORS:

  1. TEMPLATE_CONTEXT_PROCESSORS = (
  2.     'django.contrib.auth.context_processors.auth',
  3.     'django.core.context_processors.i18n',
  4.     'django.core.context_processors.request',
  5.     'django.core.context_processors.media',
  6.     'django.core.context_processors.static',
  7.     'cms.context_processors.media',
  8.     'sekizai.context_processors.sekizai',
  9. )

Note

This setting will be missing from automatically generated Django settings files, so you will have to add it.

Point your STATIC_ROOT to where the static files should live (that is, your images, CSS files, Javascript files, etc.):

  1. STATIC_ROOT = os.path.join(PROJECT_PATH, "static")
  2. STATIC_URL = "/static/"

For uploaded files, you will need to set up the MEDIA_ROOT setting:

  1. MEDIA_ROOT = os.path.join(PROJECT_PATH, "media")
  2. MEDIA_URL = "/media/"

Note

Please make sure both the static and media subfolders exist in your project and are writable.

Now add a little magic to the TEMPLATE_DIRS section of the file:

  1. TEMPLATE_DIRS = (
  2.     # The docs say it should be absolute path: PROJECT_PATH is precisely one.
  3.     # Life is wonderful!
  4.     os.path.join(PROJECT_PATH, "templates"),
  5. )

Add at least one template to CMS_TEMPLATES; for example:

  1. CMS_TEMPLATES = (
  2.     ('template_1.html', 'Template One'),
  3.     ('template_2.html', 'Template Two'),
  4. )

We will create the actual template files at a later step, don’t worry about it for now. Simply paste this code into your settings file.

Note

The templates you define in CMS_TEMPLATES have to exist at runtime and contain at least one {% placeholder <name> %} template tag to be useful for django CMS. For more details see Creating templates

The django CMS allows you to edit all languages for which Django has built in translations. Since these are numerous, we’ll limit it to English for now:

  1. LANGUAGES = [
  2.     ('en', 'English'),
  3. ]

Finally, set up the DATABASES part of the file to reflect your database deployment. If you just want to try out things locally, sqlite3 is the easiest database to set up, however it should not be used in production. If you still wish to use it for now, this is what your DATABASES setting should look like:

  1. DATABASES = {
  2.     'default': {
  3.         'ENGINE': 'django.db.backends.sqlite3',
  4.         'NAME': os.path.join(PROJECT_PATH, 'database.sqlite'),
  5.     }
  6. }

1.2.2. URL configuration

You need to include the 'cms.urls' urlpatterns at the end of your urlpatterns. We suggest starting with the following urls.py:

  1. from django.conf.urls.defaults import *
  2. from django.conf.urls.i18n import i18n_patterns
  3. from django.contrib import admin
  4. from django.conf import settings
  6. admin.autodiscover()
  8. urlpatterns = i18n_patterns('',
  9.     url(r'^admin/', include(admin.site.urls)),
  10.     url(r'^', include('cms.urls')),
  11. )
  13. if settings.DEBUG:
  14.     urlpatterns = patterns('',
  15.     url(r'^media/(?P<path>.*)$', 'django.views.static.serve',
  16.         {'document_root': settings.MEDIA_ROOT, 'show_indexes': True}),
  17.     url(r'', include('django.contrib.staticfiles.urls')),
  18. ) + urlpatterns

1.3. Creating templates

django CMS uses templates to define how a page should look and what parts of it are editable. Editable areas are called placeholders. These templates are standard Django templates and you may use them as described in the official documentation.

Templates you wish to use on your pages must be declared in the CMS_TEMPLATES setting:

  1. CMS_TEMPLATES = (
  2.     ('template_1.html', 'Template One'),
  3.     ('template_2.html', 'Template Two'),
  4. )

If you have followed this tutorial from the beginning, this code should already be in your settings file.

Now, on with the actual template files!

Fire up your favorite editor and create a file called base.html in a folder called templates in your myproject directory.

Here is a simple example for a base template called base.html:

  1. {% load cms_tags sekizai_tags %}
  2. <html>
  3.   <head>
  4.       {% render_block "css" %}
  5.   </head>
  6.   <body>
  7.       {% cms_toolbar %}
  8.       {% placeholder base_content %}
  9.       {% block base_content %}{% endblock %}
  10.       {% render_block "js" %}
  11.   </body>
  12. </html>

Now, create a file called template_1.html in the same directory. This will use your base template, and add extra content to it:

  1. {% extends "base.html" %}
  2. {% load cms_tags %}
  4. {% block base_content %}
  5.   {% placeholder template_1_content %}
  6. {% endblock %}

When you set template_1.html as a template on a page you will get two placeholders to put plugins in. One is template_1_content from the page template template_1.html and another is base_content from the extended base.html.

When working with a lot of placeholders, make sure to give descriptive names to your placeholders so you can identify them more easily in the admin panel.

Now, feel free to experiment and make a template_2.html file! If you don’t feel creative, just copy template_1 and name the second placeholder something like “template_2_content”.

1.3.1. Static files handling with sekizai

The django CMS handles media files (css stylesheets and javascript files) required by CMS plugins using django-sekizai. This requires you to define at least two sekizai namespaces in your templates: js and css. You can do so using the render_block template tag from the sekizai_tags template tag libary. We highly recommended putting the {% render_block "css" %} tag as the last thing before the closing </head> HTML tag and the {% render_block "js" %} tag as the last thing before the closing </body> HTML tag.

1.3.2. Initial database setup

This command depends on whether you upgrade your installation or do a fresh install. We recommend that you get familiar with the way South works, as it is a very powerful, easy and convenient tool. django CMS uses it extensively.

1.3.2.1. Fresh install

Run:

  1. python manage.py syncdb --all
  2. python manage.py migrate --fake

The first command will prompt you to create a super user. Choose ‘yes’ and enter appropriate values.

1.3.2.2. Upgrade

Run:

  1. python manage.py syncdb
  2. python manage.py migrate

1.3.3. Check you did everything right

Now, use the following command to check if you did everything correctly:

  1. python manage.py cms check

1.3.4. Up and running!

That should be it. Restart your development server using python manage.py runserver and point a web browser to 127.0.0.1:8000 :you should get the django CMS “It Worked” screen.

it-works-cms

Head over to the admin panel <http://127.0.0.1:8000/admin/&gt; and log in with the user you created during the database setup.

To deploy your django CMS project on a production webserver, please refer to the Django documentation.

1.4. Creating your first CMS Page!

That’s it. Now the best part: you can start using the CMS! Run your server with python manage.py runserver, then point a web browser to 127.0.0.1:8000/admin/ , and log in using the super user credentials you defined when you ran syncdb earlier.

Once in the admin part of your site, you should see something like the following:

first-admin

1.4.1. Adding a page

Adding a page is as simple as clicking “Pages” in the admin view, then the “add page” button at the top right-hand corner of the screen.

This is where you select which template to use (remember, we created two), as well as pretty obvious things like which language the page is in (used for internationalisation), the page’s title, and the url slug it will use.

Hitting the “Save” button, unsurprisingly, saves the page. It will now display in the list of pages.

my-first-page

Congratulations! You now have a fully functional django CMS installation!

1.4.2. Publishing a page

The following is a list of parameters that can be changed for each of your pages:

1.4.2.1. Visibility

By default, pages are “invisible”. To let people access them you should mark them as “published”.

1.4.2.2. Menus

Another option this view lets you tweak is whether or not the page should appear in your site’s navigation (that is, whether there should be a menu entry to reach it or not)

1.4.3. Adding content to a page

So far, our page doesn’t do much. Make sure it’s marked as “published”, then click on the page’s “edit” button.

Ignore most of the interface for now and click the “view on site” button at the top right-hand corner of the screen. As expected, your page is blank for the time being, since our template is a really minimal one.

Let’s get to it now then!

Press your browser’s back button, so as to see the page’s admin interface. If you followed the tutorial so far, your template (template_1.html) defines two placeholders. The admin interfaces shows you theses placeholders as sub menus:

first-placeholders

Scroll down the “Available plugins” drop-down list. This displays the plugins you added to your INSTALLED_APPS settings. Choose the “text” plugin in the drop-down, then press the “Add” button.

The right part of the plugin area displays a rich text editor (TinyMCE).

In the editor, type in some text and then press the “Save” button.

The new text is only visible on the draft copy so far, but you can see it by using the top button “Preview draft”. If you use the “View on site” button instead, you can see that the page is still blank to the normal users.

To publish the changes you have made, click on the “Publish draft” button. Go back to your website using the top right-hand “View on site” button. That’s it!

hello-cms-world

1.4.4. Where to go from here

Congratulations, you now have a fully functional CMS! Feel free to play around with the different plugins provided out of the box and to build great websites!