Application Configuration

Before running the app, you need to configure it through the site_settings.py file. While some of theses settings are easy to understand, some others are not that trivial. This section is here to guide through the laters.

If this is the first time you’re configuring this app, you should start by copying site_settings.py.sample to site_settings.py.

Basic settings

Database

You need to define at least an ENGINE, NAME and USER for the database to be configured. For a typical PostGreSQL configuration, that would look like this:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
        'NAME': 'imaginationforpeople', # Or path to database file if using sqlite3.
        'USER': 'imaginationforpeople', # Not used with sqlite3.
        'PASSWORD': 'plop', # Not used with sqlite3.
        'HOST': '', # Set to empty string for localhost. Not used with sqlite3.
        'PORT': '', # Set to empty string for default. Not used with sqlite3.
    }
}

Social authentication

This section describes how to setup your instance of the application to support authentication against social services.

Services configuration

For each supported authentication service, you need an account with that service and you need to use that account to create and configure an application using their web interface. Each service will provide you with a pair of ID/Key and secret.

Most services requires that you provide one or more URLs pointing to your site. In development you can’t use the real site URL but you can make up one. It doesn’t need to be based on a valid hostname but it needs to look valid, so http://127.0.0.1:8000 won’t work but something like http://i4p-dev.com:8000 will do. You’ll need to configure your machine so that your site URL points to your local instance. On Unix systems you can do this by adding an entry to /etc/hosts:

127.0.0.1   i4p-dev.com

You can also use your zeroconf (avahi, bonjour) host, such as mymachine.local.

In the subsequent sections we assume that the hostname pointing to your development machine is i4p-dev.com but you can use another hostname if you wish.

Facebook

Go to https://developers.facebook.com/ and create a new app. You’ll need to enter a site URL: http://i4p-dev.com:8000.

Google

Google offers several authentication options. We use OAuth2. Go to https://code.google.com/apis/console and create a new Client ID. Redirect URIs should contain http://i4p-dev.com:8000/member/complete/google-oauth2/ and JavaScript origins should contain https://i4p-dev.com.

Twitter

Go to https://dev.twitter.com/k and create a new app. Your callback URL should be http://i4p-dev.com:8000/.

LinkedIn

Go to https://www.linkedin.com/secure/developer and add a new application.

OpenID

No configuration is required for basic OpenID authentication.

Local configuration

Then you need to enter an ID/Key and secret pair for each authentication service in site_settings.py (remember that you should never store this file into version control).

# Social auth
FACEBOOK_APP_ID              = 'XXXXXXXXX'
FACEBOOK_API_SECRET          = 'XXXXXXXXXXXXXXXXXXXXXXXXXXX'

TWITTER_CONSUMER_KEY         = 'XXXXXXXXXXXX'
TWITTER_CONSUMER_SECRET      = 'XXXXXXXXXXXXXXXXXXXX'

GOOGLE_OAUTH2_CLIENT_KEY     = 'XXXXXXXX.apps.googleusercontent.com'
GOOGLE_OAUTH2_CLIENT_SECRET  = 'XXXXXXXXXXXXXXX'

LINKEDIN_CONSUMER_KEY        = 'XXXXXXXX'
LINKEDIN_CONSUMER_SECRET     = 'XXXXXXXXXXXX'

Reference configuration

Site configuration template:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# Sample site configuration
# Edit as needed

DEBUG = True
TEMPLATE_DEBUG = True

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
        'NAME': 'imaginationforpeople', # Or path to database file if using sqlite3.
        'USER': 'imaginationforpeople', # Not used with sqlite3.
        'PASSWORD': 'plop', # Not used with sqlite3.
        'HOST': '', # Set to empty string for localhost. Not used with sqlite3.
        'PORT': '', # Set to empty string for default. Not used with sqlite3.
    }
}

# URL that handles the media served from MEDIA_ROOT. Make sure to use a
# trailing slash if there is a path component (optional in other cases).
# Examples: "http://media.lawrence.com", "http://example.com/media/"
# If you're using a dev server, just use '/site_media/'
MEDIA_URL = 'http://imaginationforpeople.org/site_media/'

FACEBOOK_APP_ID = "TO_COMPLETE"
FACEBOOK_API_SECRET = "TO_COMPLETE"

GOOGLE_OAUTH2_CLIENT_ID = "TO_COMPLETE"
GOOGLE_OAUTH2_CLIENT_SECRET = "TO_COMPLETE"

## Dynamicsites
DEFAULT_HOST = 'imaginationforpeople.org'
HOSTNAME_REDIRECTS = {
    'example.dev':           'example.com',
    'example2.dev':          'example2.com',
    'other.example2.dev':    'other.example2.com',
}

# Use this for developement aliases
ENV_HOSTNAMES = {
  'localhost': 'imaginationforpeople.org',
}

# If you need error reporting via Raven, configure this
# RAVEN_CONFIG = {
#     'dsn': 'http://public:secret@example.com/1',
# }

Common configuration:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# -*- coding:utf-8 -*-
# Django settings for imaginationforpeople project.

import os
import re
import sys
from django.utils.translation import ugettext_lazy as _

# Import settings for the given site
from site_settings import *

PROJECT_ROOT = os.path.dirname(__file__)
sys.path.append(os.path.join(PROJECT_ROOT, '..'))

ADMINS = (
    ('Simon Sarazin', 'simonsarazin@imaginationforpeople.org'),
    ('Sylvain Maire', 'sylvainmaire@imaginationforpeople.org'),
    ('Guillaume Libersat', 'guillaumelibersat@imaginationforpeople.org'),
    ('Alban Tiberghien', 'albantiberghien@imaginationforpeople.org'),
)

MANAGERS = (
    ('IP Team', 'team@imaginationforpeople.org'),
)

## Project path
PROJECT_PATH = os.path.abspath('%s' % os.path.dirname(__file__))

## Dynamicsites
SITES_DIR = os.path.join(PROJECT_ROOT, 'sites')

# Local time zone for this installation. Choices can be found here:
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
# although not all choices may be available on all operating systems.
# On Unix systems, a value of None will cause Django to use the same
# timezone as the operating system.
# If running in a Windows environment this must be set to the same as your
# system time zone.
TIME_ZONE = 'Europe/Paris'

# Language code for this installation. All choices can be found here:
# http://www.i18nguy.com/unicode/language-identifiers.html
LANGUAGE_CODE = 'en'

LANGUAGES = (
  ('en', u'English'),
  ('fr', u'Français'),
  ('el', u'Ελληνικά'),
  ('es', u'Español'),
  ('pt', u'Português'),
  ('de', u'Deutsch'),
  ('it', u'Italiano'),
  ('ru', u'Русский'),
  ('zh', u'中文'),
)

# If you set this to False, Django will make some optimizations so as not
# to load the internationalization machinery.
USE_I18N = True

# If you set this to False, Django will not format dates, numbers and
# calendars according to the current locale
USE_L10N = True

# Absolute filesystem path to the directory that will hold user-uploaded files.
# Example: "/home/media/media.lawrence.com/"
MEDIA_ROOT = os.path.join(PROJECT_PATH, 'media/')


# Make this unique, and don't share it with anybody.
SECRET_KEY = '-m2v@6wb7+$!*nsed$1m5_f=1p5pf-lg^_m3+@x*%fl5a$qpqd'

# Cache
if DEBUG:
    CACHE_BACKEND = 'django.core.cache.backends.dummy.DummyCache'
else:
    CACHE_BACKEND = 'django.core.cache.backends.locmem.LocMemCache'
CACHES = {
    'default': {
        'BACKEND': CACHE_BACKEND,
    }
}

# List of callables that know how to import templates from various sources.
TEMPLATE_LOADERS = (
    'django.template.loaders.filesystem.Loader',
    'django.template.loaders.app_directories.Loader',
#     'django.template.loaders.eggs.Loader',
)

MIDDLEWARE_CLASSES = (
    'django.contrib.sessions.middleware.SessionMiddleware',


    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'dynamicsites.middleware.DynamicSitesMiddleware',
     ## The order of these locale middleware classes matters
    # Language selection based on profile
    # URL based language selection (eg. from top panel)
    # We don't use django cms one, for compatibility reasons
    'django.middleware.locale.LocaleMiddleware',
    # CommonMiddleware MUST come after LocaleMiddleware, otherwise, 
    # url matching will not work properly
    'django.middleware.common.CommonMiddleware',
    #'userena.middleware.UserenaLocaleMiddleware',
    'linaro_django_pagination.middleware.PaginationMiddleware',

    'reversion.middleware.RevisionMiddleware',



    'honeypot.middleware.HoneypotMiddleware',

    'cms.middleware.page.CurrentPageMiddleware',
    'cms.middleware.user.CurrentUserMiddleware',
    'cms.middleware.toolbar.ToolbarMiddleware',

    'raven.contrib.django.middleware.SentryResponseErrorIdMiddleware',
)

if DEBUG:
    MIDDLEWARE_CLASSES += (
        'debug_toolbar.middleware.DebugToolbarMiddleware',
    )
    LETTUCE_APPS = (
            'apps.member',
            'apps.project_sheet',
            'apps.i4p_base',
            )

AUTHENTICATION_BACKENDS = (
    'social_auth.backends.twitter.TwitterBackend',
    'social_auth.backends.facebook.FacebookBackend',
    'social_auth.backends.google.GoogleOAuth2Backend',
    'social_auth.backends.contrib.linkedin.LinkedinBackend',
    'social_auth.backends.OpenIDBackend',
    'userena.backends.UserenaAuthenticationBackend',
    'guardian.backends.ObjectPermissionBackend',
    'django.contrib.auth.backends.ModelBackend',
)

TEMPLATE_CONTEXT_PROCESSORS = (
    "django.contrib.auth.context_processors.auth",
    "django.core.context_processors.debug",
    "django.core.context_processors.i18n",
    "django.core.context_processors.media",
    "django.core.context_processors.request",
    'backcap.context_processors.backcap_forms',

    'django.core.context_processors.static',
    'apps.project_sheet.context_processors.project_search_forms',
    'apps.member.context_processors.member_forms',

    'cms.context_processors.media',
    'sekizai.context_processors.sekizai',
    
    'dynamicsites.context_processors.current_site',
)


ROOT_URLCONF = 'imaginationforpeople.urls'

TEMPLATE_DIRS = (
    # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
    # Always use forward slashes, even on Windows.
    # Don't forget to use absolute paths, not relative paths.
    os.path.join(PROJECT_PATH, 'apps/member/templates'),
    os.path.join(PROJECT_PATH, 'apps/i4p_base/templates'),
    os.path.join(PROJECT_PATH, 'apps/project_sheet/templates'),
    os.path.join(PROJECT_PATH, 'templates'),
)

INSTALLED_APPS = (
    # External Apps
    'dynamicsites',
    'south',
    'django_nose',
    'django_extensions',
    'userena',
    'userena.contrib.umessages',
    'guardian',
    'nani',
    'honeypot',

    'raven.contrib.django',

    'tinymce',
    'tagging',
    'imagekit',
    'oembed_works',
    'reversion',
    'django_countries',
    'easy_thumbnails',
    'licenses',
    'haystack',
    'voting',
    'notification',
    'backcap',
    'compressor',
    'robots',
    'ajax_select',
    'ajaxcomments',
    'django_mailman',
    'linaro_django_pagination',
    'template_utils',
    'simplegravatar',
    'social_auth',


    #'grappelli',
    'filebrowser',

    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.sites',
    'django.contrib.sitemaps',
    'django.contrib.messages',
    'django.contrib.admin',
    'django.contrib.admindocs',
    'django.contrib.comments',
    'django.contrib.staticfiles',
    'django.contrib.humanize',
    'django.contrib.syndication',
    'django.contrib.redirects',

    'emencia.django.newsletter',
    'emencia.django.newsletter.cmsplugin_newsletter',    
    'cms',
    'mptt',
    'menus',
    'sekizai',
    'cms.plugins.text',
    'cms.plugins.link',
    'cms.plugins.file',
    'cms.plugins.picture',
    'cms.plugins.googlemap',
    'cms.plugins.video',
    'cms.plugins.twitter',
    'cms.plugins.teaser',
    'cms.plugins.snippet',

    'cmsplugin_facebook',

    # Internal Apps
    'apps.i4p_base',
    'apps.member',
    'apps.project_sheet',
    'apps.partner',
    'apps.workgroup',
)

# django-ajax_select
AJAX_LOOKUP_CHANNELS = {
    'members' : ('apps.member.lookups', 'UserLookup'),
}
AJAX_SELECT_BOOTSTRAP = True
AJAX_SELECT_INLINES = 'inline'


OEMBED_PROVIDERS = {
  'YouTube': ('http://www.youtube.com/oembed/',
              [r'http://(?:www\.)?youtube\.com/watch\?v=[A-Za-z0-9\-=_]{11}']),
  'Vimeo': ('http://vimeo.com/api/oembed.json',
            [r'http://(?:www\.)?vimeo\.com/\d+']),
  'Dailymotion': ('http://www.dailymotion.com/services/oembed/?wmode=transparent',
                  [r'http://(?:www\.)?dailymotion\.com/video/\S+']),
   'Flickr': ('http://www.flickr.com/services/oembed',
              [r'http://(?:www\.)?flickr\.com/photos/\S+?/(?:sets/)?\d+/?']),
}

if DEBUG:
    INSTALLED_APPS += (
        'debug_toolbar',
        'lettuce.django',
        )


## Userena
USERENA_WITHOUT_USERNAMES = True
USERENA_MUGSHOT_DEFAULT = 'monsterid'
USERENA_MUGSHOT_SIZE = 160
USERENA_MUGSHOT_PATH = 'mugshots/'

USERENA_DEFAULT_PRIVACY = 'open'

## Social auth
FACEBOOK_EXTENDED_PERMISSIONS = ['email', 'user_location', 'user_website',
                                 'user_work_history']
GOOGLE_OAUTH_EXTRA_SCOPE = ['https://www.googleapis.com/auth/userinfo.profile']

# Catch social auth exceptions even in debug mode
SOCIAL_AUTH_RAISE_EXCEPTIONS = DEBUG
SOCIAL_AUTH_PIPELINE = (
    'social_auth.backends.pipeline.social.social_auth_user',
    'social_auth.backends.pipeline.associate.associate_by_email',
    'social_auth.backends.pipeline.user.get_username',
    'apps.member.social.create_user',
    'apps.member.social.associate_user', # Override default pipeline function
    'social_auth.backends.pipeline.social.load_extra_data',
    'social_auth.backends.pipeline.user.update_user_details'
)

# Honeypot
HONEYPOT_FIELD_NAME = "homepage"

# Userena
ANONYMOUS_USER_ID = -1
AUTH_PROFILE_MODULE = 'member.I4pProfile'

### Nose test runner
TEST_RUNNER = 'django_nose.NoseTestSuiteRunner'

### Debug-tool-bar
INTERNAL_IPS = ('127.0.0.1', '192.168.0.18')
DEBUG_TOOLBAR_CONFIG = {
    # useful for testing dynamicsites
    'INTERCEPT_REDIRECTS': False,
}

DEBUG_TOOLBAR_PANELS = (
    'debug_toolbar.panels.version.VersionDebugPanel',
    'debug_toolbar.panels.timer.TimerDebugPanel',
    'debug_toolbar.panels.settings_vars.SettingsVarsDebugPanel',
    'debug_toolbar.panels.headers.HeaderDebugPanel',
    'debug_toolbar.panels.request_vars.RequestVarsDebugPanel',
    'debug_toolbar.panels.template.TemplateDebugPanel',
    #'debug_toolbar.panels.sql.SQLDebugPanel',
    'debug_toolbar.panels.signals.SignalDebugPanel',
    'debug_toolbar.panels.logger.LoggingPanel',
)


### Tagging
FORCE_LOWERCASE_TAGS = True

### Mailer
SERVER_EMAIL = 'noreply@imaginationforpeople.org'

DEFAULT_FROM_EMAIL = SERVER_EMAIL

if not 'EMAIL_SUBJECT_PREFIX' in locals():
    EMAIL_SUBJECT_PREFIX = '[ImaginationForPeople] '

# Write emails to console if in development mode
if DEBUG:
    EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
# else, use SMTP
else:
    EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
    EMAIL_HOST = 'localhost'
    EMAIL_PORT = 25


## LOG IN
LOGIN_REDIRECT_URL = '/'
USERENA_SIGNIN_REDIRECT_URL = '/'
LOGIN_URL = "/member/signin/"

# XXX To be removed as soon as google login is confirmed working
LOCALE_INDEPENDENT_PATHS = (
        re.compile('^/member/complete/google-oauth2/?'),
	)

## Flags
COUNTRIES_FLAG_URL = 'images/flags/%(code)s.gif'

### HAYSTACK
HAYSTACK_SITECONF = 'imaginationforpeople.search_sites'
HAYSTACK_SEARCH_ENGINE = 'whoosh'
HAYSTACK_WHOOSH_PATH = os.path.join(PROJECT_PATH, 'i4p_index')

### STATIC FILES
STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(PROJECT_ROOT, 'static/')

STATICFILES_FINDERS = (
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
    
    # For dynamic sites
    'sites.finders.SiteDirectoriesFinder',

    # Compressor finder
    'compressor.finders.CompressorFinder',
)

STATICFILES_DIRS = (
    ('js', os.path.join(STATIC_ROOT, 'js')),
    ('css', os.path.join(STATIC_ROOT, 'css')),
    ('css', os.path.join(STATIC_ROOT, 'compiled_sass')),
    ('fonts', os.path.join(STATIC_ROOT, 'fonts')),
    ('images', os.path.join(STATIC_ROOT, 'images')),
)

COMPRESS_CSS_FILTERS = (
    'compressor.filters.css_default.CssAbsoluteFilter',
    'compressor.filters.cssmin.CSSMinFilter'
    )

### COMPRESOR
COMPRESS_ROOT = STATIC_ROOT
COMPRESS_URL = STATIC_URL

## Backcap config
BACKCAP_NOTIFY_WHOLE_STAFF = False
BACKCAP_NOTIFIED_USERS = ['GuillaumeLibersat',
                          'SimonSarazin',
                          'AlbanTiberghien']


## TINYMCE
TINYMCE_DEFAULT_CONFIG = {'theme': "advanced",
                          'relative_urls': False,
                          'remove_script_host': 0,
                          'convert_urls': False,
                          'plugins': "contextmenu",
                          'width': '90%',
                          'height': '300px'}
TINYMCE_FILEBROWSER = True
FILEBROWSER_USE_UPLOADIFY = False

## Newsletter
DEFAULT_HEADER_SENDER = "Imagination For People Newsletter <contact@imaginationforpeople.org>"

## CMS
CMS_PERMISSION = True

CMS_TEMPLATES = (
  ('pages/homepage.html', _('Homepage')),
  ('pages/flatpage.html', _('Black Page')),
  ('pages/contrib.html', _('Contribution page')),
  ('pages/onemenu.html', _('One menu page')),
)

CMS_REDIRECTS = True
CMS_HIDE_UNTRANSLATED = False
CMS_SOFTROOT = True
CMS_SEO_FIELDS = True

APPEND_SLASH = True

NANI_TABLE_NAME_SEPARATOR = ''

LOGGING = {
    'version': 1,
    'disable_existing_loggers': True,
    
    'filters': {
        'require_debug_false': {
            '()': 'django.utils.log.RequireDebugFalse'
        }
    },

    'root': {
        'level': 'WARNING',
        'handlers': ['sentry'],
    },
    'formatters': {
        'verbose': {
            'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
        },
        'simple': {
            'format': '%(levelname)s %(message)s'
        },
    },
    
    'handlers': {
 	# Uncomment this if you don't use sentry
        #'mail_admins': {
        #    'level': 'ERROR',
        #    'filters': ['require_debug_false'],
        #    'class': 'django.utils.log.AdminEmailHandler'
        #},
        'sentry': {
            'level': 'ERROR',
            'class': 'raven.contrib.django.handlers.SentryHandler',
        },
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'formatter': 'verbose'
        }
    },
    'loggers': {
        'django.db.backends': {
            'level': 'ERROR',
            'handlers': ['console'],
            'propagate': False,
        },
        #'django.request': {
        #    'handlers': ['mail_admins'],
        #    'level': 'ERROR',
        #    'propagate': True,
        #},
        'raven': {
            'level': 'DEBUG',
            'handlers': ['console'],
            'propagate': False,
        },
        'sentry.errors': {
            'level': 'DEBUG',
            'handlers': ['console'],
            'propagate': False,
        },
    },
}