mygpo/settings.py

   1 # Django settings for mygpo project.
   2 #
   3 # This file is part of my.gpodder.org.
   4 #
   5 # my.gpodder.org is free software: you can redistribute it and/or modify it
   6 # under the terms of the GNU Affero General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or (at your
   8 # option) any later version.
   9 #
  10 # my.gpodder.org is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
  13 # License for more details.
  14 #
  15 # You should have received a copy of the GNU Affero General Public License
  16 # along with my.gpodder.org. If not, see <http://www.gnu.org/licenses/>.
  17 #
  18
  19 import os.path
  20 import dj_database_url
  21
  22 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
  23
  24 # http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges#ChangedthewayURLpathsaredetermined
  25 FORCE_SCRIPT_NAME=""
  26
  27 DEBUG = True
  28 TEMPLATE_DEBUG = DEBUG
  29
  30 ADMINS = ()
  31
  32 MANAGERS = ADMINS
  33
  34 DATABASES = {
  35     'default': dj_database_url.config(
  36                 default='postgres://mygpo:mygpo@localhost/mygpo'),
  37 }
  38
  39 COUCHDB_DATABASES = {
  40     'mygpo.directory':
  41         {'URL': 'http://127.0.0.1:5984/mygpo'},
  42
  43     'mygpo.core':
  44         {'URL': 'http://127.0.0.1:5984/mygpo'},
  45
  46     'mygpo.api':
  47         {'URL': 'http://127.0.0.1:5984/mygpo'},
  48
  49     'mygpo.users':
  50         {'URL': 'http://127.0.0.1:5984/mygpo_users'},
  51
  52     'mygpo.share':
  53         {'URL': 'http://127.0.0.1:5984/mygpo'},
  54
  55     'mygpo.maintenance':
  56         {'URL': 'http://127.0.0.1:5984/mygpo'},
  57
  58     'mygpo.pubsub':
  59         {'URL': 'http://127.0.0.1:5984/mygpo_pubsub'},
  60
  61     'mygpo.suggestions':
  62         {'URL': 'http://127.0.0.1:5984/mygpo_suggestions'},
  63
  64     'django_couchdb_utils_auth':
  65         {'URL': 'http://127.0.0.1:5984/mygpo_users'},
  66
  67     'django_couchdb_utils_sessions':
  68         {'URL': 'http://127.0.0.1:5984/mygpo_sessions'},
  69
  70     'django_couchdb_utils_registration':
  71         {'URL': 'http://127.0.0.1:5984/mygpo_users'},
  72
  73     'mygpo.categories':
  74         {'URL': 'http://127.0.0.1:5984/mygpo_categories'},
  75
  76     'mygpo.userdata':
  77         {'URL': 'http://127.0.0.1:5984/mygpo_userdata'},
  78 }
  79
  80 # Maps design documents to databases. The keys correspond to the directories in
  81 # mygpo/couch/, the values are the app labels which are mapped to the actual
  82 # databases in COUCHDB_DATABASES. This indirect mapping is used because
  83 # COUCHDB_DATABASES is likely to be overwritten in settings_prod.py while
  84 # COUCHDB_DDOC_MAPPING is most probably not overwritten.
  85 COUCHDB_DDOC_MAPPING = {
  86     'general':    'core',
  87     'categories': 'categories',
  88     'pubsub':     'pubsub',
  89     'userdata':   'userdata',
  90     'users':      'users',
  91     'suggestions': 'suggestions',
  92 }
  93
  94 # Local time zone for this installation. Choices can be found here:
  95 # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
  96 # although not all choices may be available on all operating systems.
  97 # If running in a Windows environment this must be set to the same as your
  98 # system time zone.
  99 TIME_ZONE = 'UTC'
 100
 101 # Language code for this installation. All choices can be found here:
 102 # http://www.i18nguy.com/unicode/language-identifiers.html
 103 LANGUAGE_CODE = 'en-us'
 104
 105 SITE_ID = 1
 106
 107 # If you set this to False, Django will make some optimizations so as not
 108 # to load the internationalization machinery.
 109 USE_I18N = True
 110
 111 STATIC_ROOT = 'staticfiles'
 112 STATIC_URL = '/media/'
 113
 114 STATICFILES_DIRS = (
 115     os.path.abspath(os.path.join(BASE_DIR, '..', 'htdocs', 'media')),
 116 )
 117
 118 # List of callables that know how to import templates from various sources.
 119 TEMPLATE_LOADERS = (
 120     'django.template.loaders.app_directories.Loader',
 121 )
 122
 123 MIDDLEWARE_CLASSES = (
 124     'django.middleware.cache.UpdateCacheMiddleware',
 125     'django.middleware.common.CommonMiddleware',
 126     'django.middleware.csrf.CsrfViewMiddleware',
 127     'django.middleware.cache.FetchFromCacheMiddleware',
 128     'django.contrib.sessions.middleware.SessionMiddleware',
 129     'django.contrib.auth.middleware.AuthenticationMiddleware',
 130     'django.middleware.locale.LocaleMiddleware',
 131     'django.contrib.messages.middleware.MessageMiddleware',
 132 )
 133
 134 ROOT_URLCONF = 'mygpo.urls'
 135
 136 TEMPLATE_DIRS = ()
 137
 138 INSTALLED_APPS = (
 139     'django.contrib.contenttypes',  # unused, but tests fail otherwise (?)
 140     'django.contrib.messages',
 141     'django.contrib.admin',
 142     'django.contrib.humanize',
 143     'django.contrib.auth',
 144     'django.contrib.sessions',
 145     'django.contrib.staticfiles',
 146     'django_couchdb_utils.couchauth',
 147     'django_couchdb_utils.registration',
 148     'djcelery',
 149     'mygpo.core',
 150     'mygpo.podcasts',
 151     'mygpo.users',
 152     'mygpo.api',
 153     'mygpo.web',
 154     'mygpo.publisher',
 155     'mygpo.data',
 156     'mygpo.userfeeds',
 157     'mygpo.directory',
 158     'mygpo.maintenance',
 159     'mygpo.share',
 160     'mygpo.administration',
 161     'mygpo.pubsub',
 162     'mygpo.db.couchdb',
 163 )
 164
 165 TEST_EXCLUDE = (
 166     'django',
 167     'couchdbkit',
 168 )
 169
 170 TEST_RUNNER='mygpo.test.MygpoTestSuiteRunner'
 171
 172 ACCOUNT_ACTIVATION_DAYS = 7
 173
 174 AUTHENTICATION_BACKENDS = (
 175     'django_couchdb_utils.couchauth.backends.CouchDBAuthBackend',
 176     'mygpo.web.auth.EmailAuthenticationBackend',
 177     'django.contrib.auth.backends.ModelBackend',
 178 )
 179
 180 SESSION_ENGINE = "django_couchdb_utils.sessions.cached_couchdb"
 181
 182 # TODO: use (default) JSON serializer for security
 183 # this would currently fail as we're (de)serializing datetime objects
 184 # https://docs.djangoproject.com/en/1.5/topics/http/sessions/#session-serialization
 185 SESSION_SERIALIZER = 'django.contrib.sessions.serializers.PickleSerializer'
 186
 187
 188 from django.conf.global_settings import TEMPLATE_CONTEXT_PROCESSORS
 189
 190 TEMPLATE_CONTEXT_PROCESSORS += (
 191     "mygpo.web.google.analytics",
 192     "mygpo.web.google.adsense",
 193
 194     # make the debug variable available in templates
 195     # https://docs.djangoproject.com/en/dev/ref/templates/api/#django-core-context-processors-debug
 196     "django.core.context_processors.debug",
 197
 198     # required so that the request obj can be accessed from templates.
 199     # this is used to direct users to previous page after login
 200     'django.core.context_processors.request',
 201 )
 202
 203 MESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'
 204
 205 USER_CLASS = 'mygpo.users.models.User'
 206
 207 LOGIN_URL = '/login/'
 208
 209 CSRF_FAILURE_VIEW='mygpo.web.views.security.csrf_failure'
 210
 211
 212 # The following entries should be set in settings_prod.py
 213 DEFAULT_FROM_EMAIL = ''
 214 SECRET_KEY = ''
 215 GOOGLE_ANALYTICS_PROPERTY_ID=''
 216 DIRECTORY_EXCLUDED_TAGS = ()
 217 FLICKR_API_KEY = ''
 218
 219 MAINTENANCE = os.path.exists(os.path.join(BASE_DIR, 'MAINTENANCE'))
 220
 221
 222 LOGGING = {
 223     'version': 1,
 224     'disable_existing_loggers': True,
 225     'formatters': {
 226         'verbose': {
 227             'format': '%(asctime)s %(name)s %(levelname)s %(message)s',
 228         },
 229     },
 230     'filters': {
 231         'require_debug_false': {
 232             '()': 'django.utils.log.RequireDebugFalse'
 233         },
 234     },
 235     'handlers': {
 236         'console':{
 237             'level': 'DEBUG',
 238             'class': 'logging.StreamHandler',
 239             'formatter': 'verbose'
 240         },
 241         'mail_admins': {
 242             'level': 'ERROR',
 243             'filters': ['require_debug_false'],
 244             'class': 'django.utils.log.AdminEmailHandler'
 245         },
 246     },
 247     'loggers': {
 248         'django': {
 249             'handlers': ['console'],
 250             'propagate': True,
 251             'level': 'WARN',
 252         },
 253         'mygpo': {
 254             'handlers': ['console'],
 255             'level': 'INFO',
 256         },
 257     },
 258 }
 259
 260 # minimum number of subscribers a podcast must have to be assigned a slug
 261 PODCAST_SLUG_SUBSCRIBER_LIMIT = 10
 262
 263 # minimum number of subscribers that a podcast needs to "push" one of its
 264 # categories to the top
 265 MIN_SUBSCRIBERS_CATEGORY=10
 266
 267 # maximum number of episode actions that the API processes immediatelly before
 268 # returning the response. Larger requests will be handled in background.
 269 # Handler can be set to None to disable
 270 API_ACTIONS_MAX_NONBG=100
 271 API_ACTIONS_BG_HANDLER='mygpo.api.tasks.episode_actions_celery_handler'
 272
 273
 274 ADSENSE_CLIENT = ''
 275 ADSENSE_SLOT_BOTTOM = ''
 276
 277 # enabled access to staff-only areas with ?staff=<STAFF_TOKEN>
 278 STAFF_TOKEN = None
 279
 280 # Flattr settings -- available after you register your app
 281 FLATTR_KEY = ''
 282 FLATTR_SECRET = ''
 283
 284 # Flattr thing of the webservice. Will be flattr'd when a user sets the "Auto-Flattr gpodder.net" option
 285 FLATTR_MYGPO_THING='https://flattr.com/submit/auto?user_id=stefankoegl&url=http://gpodder.net'
 286
 287 # The User-Agent string used for outgoing HTTP requests
 288 USER_AGENT = 'gpodder.net (+https://github.com/gpodder/mygpo)'
 289
 290 # Base URL of the website that is used if the actually used parameters is not
 291 # available.  Request handlers, for example, can access the requested domain.
 292 # Code that runs in background can not do this, and therefore requires a
 293 # default value. This should be set to something like 'http://example.com'
 294 DEFAULT_BASE_URL = ''
 295
 296
 297 ### Celery
 298
 299 BROKER_URL='redis://localhost'
 300 CELERY_RESULT_BACKEND='redis://localhost'
 301
 302 import djcelery
 303 djcelery.setup_loader()
 304
 305 # a dictionary containing celery settings from
 306 # http://docs.celeryproject.org/en/latest/configuration.html
 307 CELERY_CONF = dict(
 308     CELERY_SEND_TASK_ERROR_EMAILS = True,
 309     ADMINS=ADMINS,
 310     SERVER_EMAIL = "no-reply@example.com",
 311 )
 312
 313
 314 ### Google API
 315
 316 GOOGLE_CLIENT_ID=''
 317 GOOGLE_CLIENT_SECRET=''
 318
 319 # URL where users of the site can get support
 320 SUPPORT_URL=''
 321
 322
 323 import sys
 324 if 'test' in sys.argv:
 325     SECRET_KEY = 'test'
 326
 327
 328 try:
 329     from settings_prod import *
 330 except ImportError, e:
 331     import sys
 332     print >> sys.stderr, 'create settings_prod.py with your customized settings'