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