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 # Local time zone for this installation. Choices can be found here:
  41 # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
  42 # although not all choices may be available on all operating systems.
  43 # If running in a Windows environment this must be set to the same as your
  44 # system time zone.
  45 TIME_ZONE = 'UTC'
  46
  47 # Language code for this installation. All choices can be found here:
  48 # http://www.i18nguy.com/unicode/language-identifiers.html
  49 LANGUAGE_CODE = 'en-us'
  50
  51 SITE_ID = 1
  52
  53 # If you set this to False, Django will make some optimizations so as not
  54 # to load the internationalization machinery.
  55 USE_I18N = True
  56
  57 STATIC_ROOT = 'staticfiles'
  58 STATIC_URL = '/media/'
  59
  60 STATICFILES_DIRS = (
  61     os.path.abspath(os.path.join(BASE_DIR, '..', 'htdocs', 'media')),
  62 )
  63
  64 # List of callables that know how to import templates from various sources.
  65 TEMPLATE_LOADERS = (
  66     'django.template.loaders.app_directories.Loader',
  67 )
  68
  69 MIDDLEWARE_CLASSES = (
  70     'django.middleware.cache.UpdateCacheMiddleware',
  71     'django.middleware.common.CommonMiddleware',
  72     'django.middleware.csrf.CsrfViewMiddleware',
  73     'django.middleware.cache.FetchFromCacheMiddleware',
  74     'django.contrib.sessions.middleware.SessionMiddleware',
  75     'django.contrib.auth.middleware.AuthenticationMiddleware',
  76     'django.middleware.locale.LocaleMiddleware',
  77     'django.contrib.messages.middleware.MessageMiddleware',
  78 )
  79
  80 ROOT_URLCONF = 'mygpo.urls'
  81
  82 TEMPLATE_DIRS = ()
  83
  84 INSTALLED_APPS = (
  85     'django.contrib.contenttypes',
  86     'django.contrib.messages',
  87     'django.contrib.admin',
  88     'django.contrib.humanize',
  89     'django.contrib.auth',
  90     'django.contrib.sessions',
  91     'django.contrib.staticfiles',
  92     'djcelery',
  93     'mygpo.core',
  94     'mygpo.podcasts',
  95     'mygpo.chapters',
  96     'mygpo.search',
  97     'mygpo.users',
  98     'mygpo.api',
  99     'mygpo.web',
 100     'mygpo.publisher',
 101     'mygpo.subscriptions',
 102     'mygpo.history',
 103     'mygpo.favorites',
 104     'mygpo.usersettings',
 105     'mygpo.data',
 106     'mygpo.userfeeds',
 107     'mygpo.suggestions',
 108     'mygpo.directory',
 109     'mygpo.categories',
 110     'mygpo.episodestates',
 111     'mygpo.maintenance',
 112     'mygpo.share',
 113     'mygpo.administration',
 114     'mygpo.pubsub',
 115     'mygpo.podcastlists',
 116     'mygpo.votes',
 117 )
 118
 119 try:
 120     import debug_toolbar
 121     INSTALLED_APPS += ('debug_toolbar', )
 122
 123 except ImportError:
 124     print >> sys.stderr, 'Could not load django-debug-toolbar'
 125
 126 TEST_RUNNER = 'django.test.runner.DiscoverRunner'
 127
 128 ACCOUNT_ACTIVATION_DAYS = 7
 129
 130 AUTHENTICATION_BACKENDS = (
 131     'django.contrib.auth.backends.ModelBackend',
 132     'mygpo.web.auth.EmailAuthenticationBackend',
 133 )
 134
 135 SESSION_ENGINE = "django.contrib.sessions.backends.cached_db"
 136
 137 # TODO: use (default) JSON serializer for security
 138 # this would currently fail as we're (de)serializing datetime objects
 139 # https://docs.djangoproject.com/en/1.5/topics/http/sessions/#session-serialization
 140 SESSION_SERIALIZER = 'django.contrib.sessions.serializers.PickleSerializer'
 141
 142
 143 from django.conf.global_settings import TEMPLATE_CONTEXT_PROCESSORS
 144
 145 TEMPLATE_CONTEXT_PROCESSORS += (
 146     "mygpo.web.google.analytics",
 147     "mygpo.web.google.adsense",
 148
 149     # make the debug variable available in templates
 150     # https://docs.djangoproject.com/en/dev/ref/templates/api/#django-core-context-processors-debug
 151     "django.core.context_processors.debug",
 152
 153     # required so that the request obj can be accessed from templates.
 154     # this is used to direct users to previous page after login
 155     'django.core.context_processors.request',
 156 )
 157
 158 MESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'
 159
 160 USER_CLASS = 'mygpo.users.models.User'
 161
 162 LOGIN_URL = '/login/'
 163
 164 CSRF_FAILURE_VIEW='mygpo.web.views.security.csrf_failure'
 165
 166
 167 # The following entries should be set in settings_prod.py
 168 DEFAULT_FROM_EMAIL = ''
 169 SECRET_KEY = os.getenv('SECRET_KEY', '')
 170 GOOGLE_ANALYTICS_PROPERTY_ID=''
 171 DIRECTORY_EXCLUDED_TAGS = ()
 172 FLICKR_API_KEY = ''
 173
 174 MAINTENANCE = os.path.exists(os.path.join(BASE_DIR, 'MAINTENANCE'))
 175
 176
 177 LOGGING = {
 178     'version': 1,
 179     'disable_existing_loggers': True,
 180     'formatters': {
 181         'verbose': {
 182             'format': '%(asctime)s %(name)s %(levelname)s %(message)s',
 183         },
 184     },
 185     'filters': {
 186         'require_debug_false': {
 187             '()': 'django.utils.log.RequireDebugFalse'
 188         },
 189     },
 190     'handlers': {
 191         'console':{
 192             'level': 'DEBUG',
 193             'class': 'logging.StreamHandler',
 194             'formatter': 'verbose'
 195         },
 196         'mail_admins': {
 197             'level': 'ERROR',
 198             'filters': ['require_debug_false'],
 199             'class': 'django.utils.log.AdminEmailHandler'
 200         },
 201     },
 202     'loggers': {
 203         'django': {
 204             'handlers': ['console'],
 205             'propagate': True,
 206             'level': 'WARN',
 207         },
 208         'mygpo': {
 209             'handlers': ['console'],
 210             'level': 'INFO',
 211         },
 212         'celery': {
 213             'handlers': ['console'],
 214             'level': 'DEBUG',
 215         },
 216     },
 217 }
 218
 219 # minimum number of subscribers a podcast must have to be assigned a slug
 220 PODCAST_SLUG_SUBSCRIBER_LIMIT = 10
 221
 222 # minimum number of subscribers that a podcast needs to "push" one of its
 223 # categories to the top
 224 MIN_SUBSCRIBERS_CATEGORY=10
 225
 226 # maximum number of episode actions that the API processes immediatelly before
 227 # returning the response. Larger requests will be handled in background.
 228 # Handler can be set to None to disable
 229 API_ACTIONS_MAX_NONBG=100
 230 API_ACTIONS_BG_HANDLER='mygpo.api.tasks.episode_actions_celery_handler'
 231
 232
 233 ADSENSE_CLIENT = ''
 234 ADSENSE_SLOT_BOTTOM = ''
 235
 236 # enabled access to staff-only areas with ?staff=<STAFF_TOKEN>
 237 STAFF_TOKEN = None
 238
 239 # Flattr settings -- available after you register your app
 240 FLATTR_KEY = ''
 241 FLATTR_SECRET = ''
 242
 243 # Flattr thing of the webservice. Will be flattr'd when a user sets the "Auto-Flattr gpodder.net" option
 244 FLATTR_MYGPO_THING='https://flattr.com/submit/auto?user_id=stefankoegl&url=http://gpodder.net'
 245
 246 # The User-Agent string used for outgoing HTTP requests
 247 USER_AGENT = 'gpodder.net (+https://github.com/gpodder/mygpo)'
 248
 249 # Base URL of the website that is used if the actually used parameters is not
 250 # available.  Request handlers, for example, can access the requested domain.
 251 # Code that runs in background can not do this, and therefore requires a
 252 # default value. This should be set to something like 'http://example.com'
 253 DEFAULT_BASE_URL = ''
 254
 255
 256 ### Celery
 257
 258 BROKER_URL='redis://localhost'
 259 CELERY_RESULT_BACKEND='redis://localhost'
 260
 261 #CELERY_SEND_TASK_ERROR_EMAILS = True
 262 SERVER_EMAIL = "no-reply@example.com"
 263
 264
 265 ### Google API
 266
 267 GOOGLE_CLIENT_ID=''
 268 GOOGLE_CLIENT_SECRET=''
 269
 270 # URL where users of the site can get support
 271 SUPPORT_URL=''
 272
 273
 274 # Elasticsearch settings
 275
 276 ELASTICSEARCH_SERVER = os.getenv('ELASTICSEARCH_SERVER', '127.0.0.1:9200')
 277 ELASTICSEARCH_INDEX = os.getenv('ELASTICSEARCH_INDEX', 'mygpo')
 278 ELASTICSEARCH_TIMEOUT = float(os.getenv('ELASTICSEARCH_TIMEOUT', '2'))
 279
 280 # time for how long an activation is valid; after that, an unactivated user
 281 # will be deleted
 282 ACTIVATION_VALID_DAYS = int(os.getenv('ACTIVATION_VALID_DAYS', 10))
 283
 284 import sys
 285 if 'test' in sys.argv:
 286     SECRET_KEY = 'test'
 287
 288
 289 INTERNAL_IPS = os.getenv('INTERNAL_IPS', '').split()
 290
 291 try:
 292     from settings_prod import *
 293 except ImportError, e:
 294     import sys
 295     print >> sys.stderr, 'create settings_prod.py with your customized settings'