Admin Manual

This section of the documentation is direceted at server administrators that want to set up django-ddm for institutional or personal use.

Getting Started

Todo

Extend section with general steps to set up Django. Add ckeditor settings.

  1. Install the Django DDM package:

    pip install django-ddm
    
  2. Add the necessary entries to INSTALLED_APPS in your settings.py:

    INSTALLED_APPS = [
        ...,
        'ddm',
        'ckeditor',
        'webpack_loader',
        'rest_framework',
        'rest_framework.authtoken',
    ]
    
  3. Add the following configuration for webpack-loader to your settings.py:

    WEBPACK_LOADER = {
        'DEFAULT': {
            'CACHE': True,
            'BUNDLE_DIR_NAME': 'ddm/vue/',
            'STATS_FILE': os.path.join(STATIC_ROOT, 'ddm/vue/webpack-stats.json'),
            'POLL_INTERVAL': 0.1,
            'IGNORE': [r'.+\.hot-update.js', r'.+\.map'],
        }
    }
    
  4. Include the ddm URLconf in your projects urls.py:

    url(r'^ddm/', include('ddm.urls')),
    
  5. Add time zone support mto your settings.py:

    USE_TZ = True
    
  6. Optionally, an e-mail address restriction can be defined in settings.py. Only users whose e-mail address matches the defined regex pattern will be allowed to set up data donation projects:

    DDM_SETTINGS={
        'EMAIL_PERMISSION_CHECK':  r'.*(\.|@)somedomain\.com$',
    },
    
  7. Run python manage.py migrate to create the ddm models in your database.

  8. You should now be good to go.