Installation

You can install Aldryn FAQ either on Aldryn or by hand into your own project.

Aldryn Platform Users

To install the addon on Aldryn, all you need to do is follow this installation link on the Aldryn Marketplace and follow the instructions.

Manually you can:

  1. Choose a site you want to install the add-on to from the dashboard.
  2. Go to Apps > Install App
  3. Click Install next to the FAQ app.
  4. Redeploy the site.

Manual Installation

Requirements

  • This project requires django CMS 3.4 or later.

PIP dependency

If you’re installing into an existing django CMS project, you can run either:

pip install aldryn-faq

or:

pip install -e git+https://github.com/aldryn/aldryn-faq.git#egg=aldryn-faq

If you need to start a new project, we recommend that first you use the django CMS Installer to create it, and then install Aldryn FAQ on top of that.

settings.py

In your project’s settings.py make sure you have all of:

'adminsortable2',
'aldryn_boilerplates',
'aldryn_translation_tools',
'djangocms_text_ckeditor',
'parler',
'sortedm2m',
'aldryn_faq',
'taggit',

listed in INSTALLED_APPS, after 'cms'.

Additional Configuration

Important

To get Aldryn FAQ to work you need to add additional configurations:

1. Aldryn-Boilerplates

You need set additional configurations to settings.py for Aldryn Boilerplates.

To use the old templates, set ALDRYN_BOILERPLATE_NAME='legacy'. To use https://github.com/aldryn/aldryn-boilerplate-bootstrap3 (recommended) set ALDRYN_BOILERPLATE_NAME='bootstrap3'.

2. Django-Parler

If you plan to use translations, configure django-parler.

Be sure to add PARLER_LANGUAGES to your settings with the appropriate configuration for your project. Example:

PARLER_LANGUAGES = {
   1: (
       {'code': 'en',},
       {'code': 'fr',},
       {'code': 'de',},
   ),
   'default': {
       'fallback': 'en',             # defaults to PARLER_DEFAULT_LANGUAGE_CODE
       'hide_untranslated': False,   # the default; let .active_translations() return fallbacks too.
   }
}

Migrations

Now run python manage.py migrate if you have not already done so, followed by python manage.py migrate to prepare the database for the new applications.

Now run python manage.py migrate aldryn_faq.

Server

To finish the setup, you need to create a page, change to the Advanced Settings and choose FAQ within the Application drop-down.

You also need to set the Application configurations and publish the changes.

Finally you just need to restart your local development server and you are ready to go.

This process is described in more depth within Basic Usage.