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.search',
 152     'mygpo.users',
 153     'mygpo.api',
 154     'mygpo.web',
 155     'mygpo.publisher',
 156     'mygpo.data',
 157     'mygpo.userfeeds',
 158     'mygpo.directory',
 159     'mygpo.maintenance',
 160     'mygpo.share',
 161     'mygpo.administration',
 162     'mygpo.pubsub',
 163     'mygpo.db.couchdb',
 164 )
 165
 166 try:
 167     import debug_toolbar
 168     INSTALLED_APPS += ('debug_toolbar.apps.DebugToolbarConfig', )
 169
 170 except ImportError:
 171     pass
 172
 173
 174 TEST_EXCLUDE = (
 175     'django',
 176     'couchdbkit',
 177 )
 178
 179 TEST_RUNNER='mygpo.test.MygpoTestSuiteRunner'
 180
 181 ACCOUNT_ACTIVATION_DAYS = 7
 182
 183 AUTHENTICATION_BACKENDS = (
 184     'django_couchdb_utils.couchauth.backends.CouchDBAuthBackend',
 185     'mygpo.web.auth.EmailAuthenticationBackend',
 186     'django.contrib.auth.backends.ModelBackend',
 187 )
 188
 189 SESSION_ENGINE = "django_couchdb_utils.sessions.cached_couchdb"
 190
 191 # TODO: use (default) JSON serializer for security
 192 # this would currently fail as we're (de)serializing datetime objects
 193 # https://docs.djangoproject.com/en/1.5/topics/http/sessions/#session-serialization
 194 SESSION_SERIALIZER = 'django.contrib.sessions.serializers.PickleSerializer'
 195
 196
 197 from django.conf.global_settings import TEMPLATE_CONTEXT_PROCESSORS
 198
 199 TEMPLATE_CONTEXT_PROCESSORS += (
 200     "mygpo.web.google.analytics",
 201     "mygpo.web.google.adsense",
 202
 203     # make the debug variable available in templates
 204     # https://docs.djangoproject.com/en/dev/ref/templates/api/#django-core-context-processors-debug
 205     "django.core.context_processors.debug",
 206
 207     # required so that the request obj can be accessed from templates.
 208     # this is used to direct users to previous page after login
 209     'django.core.context_processors.request',
 210 )
 211
 212 MESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'
 213
 214 USER_CLASS = 'mygpo.users.models.User'
 215
 216 LOGIN_URL = '/login/'
 217
 218 CSRF_FAILURE_VIEW='mygpo.web.views.security.csrf_failure'
 219
 220
 221 # The following entries should be set in settings_prod.py
 222 DEFAULT_FROM_EMAIL = ''
 223 SECRET_KEY = ''
 224 GOOGLE_ANALYTICS_PROPERTY_ID=''
 225 DIRECTORY_EXCLUDED_TAGS = ()
 226 FLICKR_API_KEY = ''
 227
 228 MAINTENANCE = os.path.exists(os.path.join(BASE_DIR, 'MAINTENANCE'))
 229
 230
 231 LOGGING = {
 232     'version': 1,
 233     'disable_existing_loggers': True,
 234     'formatters': {
 235         'verbose': {
 236             'format': '%(asctime)s %(name)s %(levelname)s %(message)s',
 237         },
 238     },
 239     'filters': {
 240         'require_debug_false': {
 241             '()': 'django.utils.log.RequireDebugFalse'
 242         },
 243     },
 244     'handlers': {
 245         'console':{
 246             'level': 'DEBUG',
 247             'class': 'logging.StreamHandler',
 248             'formatter': 'verbose'
 249         },
 250         'mail_admins': {
 251             'level': 'ERROR',
 252             'filters': ['require_debug_false'],
 253             'class': 'django.utils.log.AdminEmailHandler'
 254         },
 255     },
 256     'loggers': {
 257         'django': {
 258             'handlers': ['console'],
 259             'propagate': True,
 260             'level': 'WARN',
 261         },
 262         'mygpo': {
 263             'handlers': ['console'],
 264             'level': 'INFO',
 265         },
 266     },
 267 }
 268
 269 # minimum number of subscribers a podcast must have to be assigned a slug
 270 PODCAST_SLUG_SUBSCRIBER_LIMIT = 10
 271
 272 # minimum number of subscribers that a podcast needs to "push" one of its
 273 # categories to the top
 274 MIN_SUBSCRIBERS_CATEGORY=10
 275
 276 # maximum number of episode actions that the API processes immediatelly before
 277 # returning the response. Larger requests will be handled in background.
 278 # Handler can be set to None to disable
 279 API_ACTIONS_MAX_NONBG=100
 280 API_ACTIONS_BG_HANDLER='mygpo.api.tasks.episode_actions_celery_handler'
 281
 282
 283 ADSENSE_CLIENT = ''
 284 ADSENSE_SLOT_BOTTOM = ''
 285
 286 # enabled access to staff-only areas with ?staff=<STAFF_TOKEN>
 287 STAFF_TOKEN = None
 288
 289 # Flattr settings -- available after you register your app
 290 FLATTR_KEY = ''
 291 FLATTR_SECRET = ''
 292
 293 # Flattr thing of the webservice. Will be flattr'd when a user sets the "Auto-Flattr gpodder.net" option
 294 FLATTR_MYGPO_THING='https://flattr.com/submit/auto?user_id=stefankoegl&url=http://gpodder.net'
 295
 296 # The User-Agent string used for outgoing HTTP requests
 297 USER_AGENT = 'gpodder.net (+https://github.com/gpodder/mygpo)'
 298
 299 # Base URL of the website that is used if the actually used parameters is not
 300 # available.  Request handlers, for example, can access the requested domain.
 301 # Code that runs in background can not do this, and therefore requires a
 302 # default value. This should be set to something like 'http://example.com'
 303 DEFAULT_BASE_URL = ''
 304
 305
 306 ### Celery
 307
 308 BROKER_URL='redis://localhost'
 309 CELERY_RESULT_BACKEND='redis://localhost'
 310
 311 import djcelery
 312 djcelery.setup_loader()
 313
 314 # a dictionary containing celery settings from
 315 # http://docs.celeryproject.org/en/latest/configuration.html
 316 CELERY_CONF = dict(
 317     CELERY_SEND_TASK_ERROR_EMAILS = True,
 318     ADMINS=ADMINS,
 319     SERVER_EMAIL = "no-reply@example.com",
 320 )
 321
 322
 323 ### Google API
 324
 325 GOOGLE_CLIENT_ID=''
 326 GOOGLE_CLIENT_SECRET=''
 327
 328 # URL where users of the site can get support
 329 SUPPORT_URL=''
 330
 331
 332 # Elasticsearch settings
 333
 334 ELASTICSEARCH_SERVER = os.getenv('ELASTICSEARCH_SERVER', '127.0.0.1:9200')
 335 ELASTICSEARCH_INDEX = os.getenv('ELASTICSEARCH_INDEX', 'mygpo')
 336
 337
 338 import sys
 339 if 'test' in sys.argv:
 340     SECRET_KEY = 'test'
 341
 342
 343 try:
 344     from settings_prod import *
 345 except ImportError, e:
 346     import sys
 347     print >> sys.stderr, 'create settings_prod.py with your customized settings'