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