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