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