Wagtail Personalisation

Wagtail Personalisation is a fully-featured personalisation module for Wagtail CMS. It enables editors to create customised pages - or parts of pages - based on segments whose rules are configured directly in the admin interface.

Instructions

Wagtail Personalisation requires Wagtail 4.1+ and Django 3.2+

To install the package with pip:

pip install wagtail-personalisation

Next, include the wagtail_personalisation, 'wagtail_modeladmin' (if the Wagtail version is 5.1 and above, otherwise 'wagtail.contrib.modeladmin') and wagtailfontawesomesvg apps in your project's INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    'wagtail_modeladmin',          # if Wagtail >=5.1; Don't repeat if it's there already
    'wagtail.contrib.modeladmin',  # if Wagtail <5.1;  Don't repeat if it's there already
    'wagtail_personalisation',
    'wagtailfontawesomesvg',
    # ...
]

Make sure that django.contrib.sessions.middleware.SessionMiddleware has been added in first, this is a prerequisite for this project.

MIDDLEWARE = [
    'django.contrib.sessions.middleware.SessionMiddleware',
    # ...
]

Documentation

You can find more information about installing, extending and using this module on Read the Docs.

Sandbox

To experiment with the package you can use the sandbox provided in this repository. To install this you will need to create and activate a virtualenv and then run make sandbox. This will start a fresh Wagtail install, with the personalisation module enabled, on http://localhost:8000 and http://localhost:8000/cms/. The superuser credentials are superuser@example.com with the password testing.