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
  21 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
  22
  23 # http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges#ChangedthewayURLpathsaredetermined
  24 FORCE_SCRIPT_NAME=""
  25
  26 DEBUG = True
  27 TEMPLATE_DEBUG = DEBUG
  28
  29 ADMINS = ()
  30
  31 MANAGERS = ADMINS
  32
  33 # dummy entry.
  34 # not needed for production, but tests fail otherwise in Django 1.4
  35 DATABASES = {
  36     'default': {
  37         'ENGINE': 'django.db.backends.sqlite3',
  38         'NAME': 'tmp',
  39     }
  40 }
  41
  42 COUCHDB_DATABASES = {
  43     'mygpo.directory':
  44         {'URL': 'http://127.0.0.1:5984/mygpo'},
  45
  46     'mygpo.core':
  47         {'URL': 'http://127.0.0.1:5984/mygpo'},
  48
  49     'mygpo.api':
  50         {'URL': 'http://127.0.0.1:5984/mygpo'},
  51
  52     'mygpo.users':
  53         {'URL': 'http://127.0.0.1:5984/mygpo'},
  54
  55     'mygpo.share':
  56         {'URL': 'http://127.0.0.1:5984/mygpo'},
  57
  58     'mygpo.maintenance':
  59         {'URL': 'http://127.0.0.1:5984/mygpo'},
  60
  61     'mygpo.pubsub':
  62         {'URL': 'http://127.0.0.1:5984/mygpo_pubsub'},
  63
  64     'django_couchdb_utils_auth':
  65         {'URL': 'http://127.0.0.1:5984/mygpo'},
  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'},
  72 }
  73
  74 # Maps design documents to databases. The keys correspond to the directories in
  75 # mygpo/couch/, the values are the app labels which are mapped to the actual
  76 # databases in COUCHDB_DATABASES. This indirect mapping is used because
  77 # COUCHDB_DATABASES is likely to be overwritten in settings_prod.py while
  78 # COUCHDB_DDOC_MAPPING is most probably not overwritten.
  79 COUCHDB_DDOC_MAPPING = {
  80     'general':    'core',
  81     'pubsub':     'pubsub',
  82 }
  83
  84 # Local time zone for this installation. Choices can be found here:
  85 # http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
  86 # although not all choices may be available on all operating systems.
  87 # If running in a Windows environment this must be set to the same as your
  88 # system time zone.
  89 TIME_ZONE = 'UTC'
  90
  91 # Language code for this installation. All choices can be found here:
  92 # http://www.i18nguy.com/unicode/language-identifiers.html
  93 LANGUAGE_CODE = 'en-us'
  94
  95 SITE_ID = 1
  96
  97 # If you set this to False, Django will make some optimizations so as not
  98 # to load the internationalization machinery.
  99 USE_I18N = True
 100
 101 # Absolute path to the directory that holds media.
 102 # Example: "/home/media/media.lawrence.com/"
 103 MEDIA_ROOT = os.path.abspath('%s/../htdocs/media/' % os.path.dirname(__file__))
 104
 105 # URL that handles the media served from MEDIA_ROOT. Make sure to use a
 106 # trailing slash if there is a path component (optional in other cases).
 107 # Examples: "http://media.lawrence.com", "http://example.com/media/"
 108 MEDIA_URL = ''
 109
 110 # List of callables that know how to import templates from various sources.
 111 TEMPLATE_LOADERS = (
 112     'django.template.loaders.app_directories.Loader',
 113 )
 114
 115 MIDDLEWARE_CLASSES = (
 116     'django.middleware.cache.UpdateCacheMiddleware',
 117     'django.middleware.common.CommonMiddleware',
 118     'django.middleware.csrf.CsrfViewMiddleware',
 119     'django.middleware.cache.FetchFromCacheMiddleware',
 120     'django.contrib.sessions.middleware.SessionMiddleware',
 121     'django.contrib.auth.middleware.AuthenticationMiddleware',
 122     'django.middleware.locale.LocaleMiddleware',
 123     'django.contrib.messages.middleware.MessageMiddleware',
 124 )
 125
 126 ROOT_URLCONF = 'mygpo.urls'
 127
 128 TEMPLATE_DIRS = ()
 129
 130 INSTALLED_APPS = (
 131     'django.contrib.contenttypes',  # unused, but tests fail otherwise (?)
 132     'django.contrib.messages',
 133     'django.contrib.humanize',
 134     'couchdbkit.ext.django',
 135     'django_couchdb_utils.auth',
 136     'django_couchdb_utils.sessions',
 137     'django_couchdb_utils.registration',
 138     'mygpo.core',
 139     'mygpo.users',
 140     'mygpo.api',
 141     'mygpo.web',
 142     'mygpo.publisher',
 143     'mygpo.data',
 144     'mygpo.userfeeds',
 145     'mygpo.directory',
 146     'mygpo.maintenance',
 147     'mygpo.share',
 148     'mygpo.admin',
 149     'mygpo.pubsub',
 150     'mygpo.db.couchdb',
 151 )
 152
 153 TEST_EXCLUDE = (
 154     'django',
 155     'couchdbkit',
 156 )
 157
 158 TEST_RUNNER='mygpo.test.MygpoTestSuiteRunner'
 159
 160 ACCOUNT_ACTIVATION_DAYS = 7
 161
 162 AUTHENTICATION_BACKENDS = (
 163     'django_couchdb_utils.auth.backends.CouchDBAuthBackend',
 164     'mygpo.web.auth.EmailAuthenticationBackend',
 165 )
 166
 167 SESSION_ENGINE = "django_couchdb_utils.sessions.cached_couchdb"
 168
 169 TEMPLATE_CONTEXT_PROCESSORS = (
 170     "django.contrib.auth.context_processors.auth",
 171     "django.core.context_processors.debug",
 172     "django.core.context_processors.i18n",
 173     "django.core.context_processors.media",
 174     "django.contrib.messages.context_processors.messages",
 175     "mygpo.web.google.analytics",
 176     "mygpo.web.google.adsense",
 177 )
 178
 179 MESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'
 180
 181 USER_CLASS = 'mygpo.users.models.User'
 182
 183 AUTH_PROFILE_MODULE = "api.UserProfile"
 184
 185
 186 LOGIN_URL = '/login/'
 187
 188 CSRF_FAILURE_VIEW='mygpo.web.views.security.csrf_failure'
 189
 190
 191 # The following entries should be set in settings_prod.py
 192 DEFAULT_FROM_EMAIL = ''
 193 SECRET_KEY = ''
 194 GOOGLE_ANALYTICS_PROPERTY_ID=''
 195 DIRECTORY_EXCLUDED_TAGS = ()
 196 FLICKR_API_KEY = ''
 197
 198 MAINTENANCE = os.path.exists(os.path.join(BASE_DIR, 'MAINTENANCE'))
 199
 200 EMAIL_BACKEND = 'django_couchdb_utils.email.backends.CouchDBEmailBackend'
 201
 202
 203 LOGGING = {
 204     'version': 1,
 205     'disable_existing_loggers': True,
 206     'formatters': {
 207         'verbose': {
 208             'format': '%(asctime)s %(name)s %(levelname)s %(message)s',
 209         },
 210     },
 211     'filters': {
 212         'require_debug_false': {
 213             '()': 'django.utils.log.RequireDebugFalse'
 214         },
 215     },
 216     'handlers': {
 217         'console':{
 218             'level': 'DEBUG',
 219             'class': 'logging.StreamHandler',
 220             'formatter': 'verbose'
 221         },
 222         'mail_admins': {
 223             'level': 'ERROR',
 224             'filters': ['require_debug_false'],
 225             'class': 'django.utils.log.AdminEmailHandler'
 226         },
 227     },
 228     'loggers': {
 229         'django': {
 230             'handlers': ['console'],
 231             'propagate': True,
 232             'level': 'WARN',
 233         },
 234         'mygpo': {
 235             'handlers': ['console'],
 236             'level': 'INFO',
 237         },
 238     },
 239 }
 240
 241 # minimum number of subscribers a podcast must have to be assigned a slug
 242 PODCAST_SLUG_SUBSCRIBER_LIMIT = 10
 243
 244 # minimum number of subscribers that a podcast needs to "push" one of its
 245 # categories to the top
 246 MIN_SUBSCRIBERS_CATEGORY=10
 247
 248 # maximum number of episode actions that the API processes immediatelly before
 249 # returning the response. Larger requests will be handled in background.
 250 # Handler can be set to None to disable
 251 API_ACTIONS_MAX_NONBG=100
 252 API_ACTIONS_BG_HANDLER='mygpo.api.tasks.episode_actions_celery_handler'
 253
 254
 255 ADSENSE_CLIENT = ''
 256 ADSENSE_SLOT_BOTTOM = ''
 257
 258 # enabled access to staff-only areas with ?staff=<STAFF_TOKEN>
 259 STAFF_TOKEN = None
 260
 261 # Flattr settings -- available after you register your app
 262 FLATTR_KEY = ''
 263 FLATTR_SECRET = ''
 264
 265 # Flattr thing of the webservice. Will be flattr'd when a user sets the "Auto-Flattr gpodder.net" option
 266 FLATTR_MYGPO_THING='https://flattr.com/submit/auto?user_id=stefankoegl&url=http://gpodder.net'
 267
 268 # The User-Agent string used for outgoing HTTP requests
 269 USER_AGENT = 'gpodder.net (+https://github.com/gpodder/mygpo)'
 270
 271 # Base URL of the website that is used if the actually used parameters is not
 272 # available.  Request handlers, for example, can access the requested domain.
 273 # Code that runs in background can not do this, and therefore requires a
 274 # default value. This should be set to something like 'http://example.com'
 275 DEFAULT_BASE_URL = ''
 276
 277
 278 ### Celery
 279
 280 BROKER_URL='redis://localhost'
 281 BACKEND_URL='redis://localhost'
 282
 283
 284 # a dictionary containing celery settings from
 285 # http://docs.celeryproject.org/en/latest/configuration.html
 286 CELERY_CONF = dict(
 287     CELERY_SEND_TASK_ERROR_EMAILS = True,
 288     ADMINS=ADMINS,
 289     SERVER_EMAIL = "no-reply@example.com",
 290 )
 291
 292
 293 ### Google API
 294
 295 GOOGLE_CLIENT_ID=''
 296 GOOGLE_CLIENT_SECRET=''
 297
 298
 299
 300 try:
 301     from settings_prod import *
 302 except ImportError, e:
 303     import sys
 304     print >> sys.stderr, 'create settings_prod.py with your customized settings'