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 sys
  20 import os.path
  21 import dj_database_url
  22
  23 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
  24
  25 # http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges#ChangedthewayURLpathsaredetermined
  26 FORCE_SCRIPT_NAME=""
  27
  28 DEBUG = True
  29 TEMPLATE_DEBUG = DEBUG
  30
  31 ADMINS = ()
  32
  33 MANAGERS = ADMINS
  34
  35 DATABASES = {
  36     'default': dj_database_url.config(
  37                 default='postgres://mygpo:mygpo@localhost/mygpo'),
  38 }
  39
  40 COUCHDB_DATABASES = {
  41     'mygpo.directory':
  42         {'URL': 'http://127.0.0.1:5984/mygpo_categories'},
  43
  44     'mygpo.users':
  45         {'URL': 'http://127.0.0.1:5984/mygpo_users'},
  46
  47     'mygpo.pubsub':
  48         {'URL': 'http://127.0.0.1:5984/mygpo_pubsub'},
  49
  50     'mygpo.suggestions':
  51         {'URL': 'http://127.0.0.1:5984/mygpo_suggestions'},
  52
  53     'mygpo.share':
  54         {'URL': 'http://127.0.0.1:5984/mygpo_podcastlists'},
  55
  56     'mygpo.podcastlists':
  57         {'URL': 'http://127.0.0.1:5984/mygpo_podcastlists'},
  58
  59     'mygpo.categories':
  60         {'URL': 'http://127.0.0.1:5984/mygpo_categories'},
  61
  62     'mygpo.userdata':
  63         {'URL': 'http://127.0.0.1:5984/mygpo_userdata'},
  64 }
  65
  66 # Maps design documents to databases. The keys correspond to the directories in
  67 # mygpo/couch/, the values are the app labels which are mapped to the actual
  68 # databases in COUCHDB_DATABASES. This indirect mapping is used because
  69 # COUCHDB_DATABASES is likely to be overwritten in settings_prod.py while
  70 # COUCHDB_DDOC_MAPPING is most probably not overwritten.
  71 COUCHDB_DDOC_MAPPING = {
  72     'categories': 'categories',
  73     'pubsub':     'pubsub',
  74     'userdata':   'userdata',
  75     'users':      'users',
  76     'suggestions': 'suggestions',
  77 }
  78
  79 # Local time zone for this installation. Choices can be found here:
  80 # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
  81 # although not all choices may be available on all operating systems.
  82 # If running in a Windows environment this must be set to the same as your
  83 # system time zone.
  84 TIME_ZONE = 'UTC'
  85
  86 # Language code for this installation. All choices can be found here:
  87 # http://www.i18nguy.com/unicode/language-identifiers.html
  88 LANGUAGE_CODE = 'en-us'
  89
  90 SITE_ID = 1
  91
  92 # If you set this to False, Django will make some optimizations so as not
  93 # to load the internationalization machinery.
  94 USE_I18N = True
  95
  96 STATIC_ROOT = 'staticfiles'
  97 STATIC_URL = '/media/'
  98
  99 STATICFILES_DIRS = (
 100     os.path.abspath(os.path.join(BASE_DIR, '..', 'htdocs', 'media')),
 101 )
 102
 103 # List of callables that know how to import templates from various sources.
 104 TEMPLATE_LOADERS = (
 105     'django.template.loaders.app_directories.Loader',
 106 )
 107
 108 MIDDLEWARE_CLASSES = (
 109     'django.middleware.cache.UpdateCacheMiddleware',
 110     'django.middleware.common.CommonMiddleware',
 111     'django.middleware.csrf.CsrfViewMiddleware',
 112     'django.middleware.cache.FetchFromCacheMiddleware',
 113     'django.contrib.sessions.middleware.SessionMiddleware',
 114     'django.contrib.auth.middleware.AuthenticationMiddleware',
 115     'django.middleware.locale.LocaleMiddleware',
 116     'django.contrib.messages.middleware.MessageMiddleware',
 117 )
 118
 119 ROOT_URLCONF = 'mygpo.urls'
 120
 121 TEMPLATE_DIRS = ()
 122
 123 INSTALLED_APPS = (
 124     'django.contrib.contenttypes',  # unused, but tests fail otherwise (?)
 125     'django.contrib.messages',
 126     'django.contrib.admin',
 127     'django.contrib.humanize',
 128     'django.contrib.auth',
 129     'django.contrib.sessions',
 130     'django.contrib.staticfiles',
 131     'djcelery',
 132     'mygpo.core',
 133     'mygpo.podcasts',
 134     'mygpo.chapters',
 135     'mygpo.search',
 136     'mygpo.users',
 137     'mygpo.api',
 138     'mygpo.web',
 139     'mygpo.publisher',
 140     'mygpo.subscriptions',
 141     'mygpo.history',
 142     'mygpo.favorites',
 143     'mygpo.data',
 144     'mygpo.userfeeds',
 145     'mygpo.directory',
 146     'mygpo.maintenance',
 147     'mygpo.share',
 148     'mygpo.administration',
 149     'mygpo.pubsub',
 150     'mygpo.db.couchdb',
 151 )
 152
 153 try:
 154     import debug_toolbar
 155     INSTALLED_APPS += ('debug_toolbar', )
 156
 157 except ImportError:
 158     print >> sys.stderr, 'Could not load django-debug-toolbar'
 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.contrib.auth.backends.ModelBackend',
 172     'mygpo.web.auth.EmailAuthenticationBackend',
 173 )
 174
 175 SESSION_ENGINE = "django.contrib.sessions.backends.cached_db"
 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 CELERY_SEND_TASK_ERROR_EMAILS = True,
 298 ADMINS=ADMINS,
 299 SERVER_EMAIL = "no-reply@example.com",
 300
 301
 302 ### Google API
 303
 304 GOOGLE_CLIENT_ID=''
 305 GOOGLE_CLIENT_SECRET=''
 306
 307 # URL where users of the site can get support
 308 SUPPORT_URL=''
 309
 310
 311 # Elasticsearch settings
 312
 313 ELASTICSEARCH_SERVER = os.getenv('ELASTICSEARCH_SERVER', '127.0.0.1:9200')
 314 ELASTICSEARCH_INDEX = os.getenv('ELASTICSEARCH_INDEX', 'mygpo')
 315 ELASTICSEARCH_TIMEOUT = float(os.getenv('ELASTICSEARCH_TIMEOUT', '2'))
 316
 317 # time for how long an activation is valid; after that, an unactivated user
 318 # will be deleted
 319 ACTIVATION_VALID_DAYS = int(os.getenv('ACTIVATION_VALID_DAYS', 10))
 320
 321 import sys
 322 if 'test' in sys.argv:
 323     SECRET_KEY = 'test'
 324
 325
 326 INTERNAL_IPS = os.getenv('INTERNAL_IPS', '').split()
 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'