example_project/settings.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (C) 1998-2023 by the Free Software Foundation, Inc.
   3 #
   4 # This file is part of Postorius.
   5 #
   6 # Postorius is free software: you can redistribute it and/or modify it under
   7 # the terms of the GNU General Public License as published by the Free
   8 # Software Foundation, either version 3 of the License, or (at your option)
   9 # any later version.
  10 #
  11 # Postorius is distributed in the hope that it will be useful, but WITHOUT
  12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14 # more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Postorius.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 """
  20 Django settings for postorius project.
  21
  22 For more information on this file, see
  23 https://docs.djangoproject.com/en/1.9/topics/settings/
  24
  25 For the full list of settings and their values, see
  26 https://docs.djangoproject.com/en/1.9/ref/settings/
  27 """
  28
  29 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
  30 import os
  31
  32 # Compatibility with Bootstrap 3
  33 from django.contrib.messages import constants as messages
  34
  35
  36 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
  37
  38
  39 # Quick-start development settings - unsuitable for production
  40 # See https://docs.djangoproject.com/en/1.9/howto/deployment/checklist/
  41
  42 # SECURITY WARNING: keep the secret key used in production secret!
  43 SECRET_KEY = '$!-7^wl#wiifjbh)5@f7ji%x!vp7s1vzbvwt26hxv$idixq0u0'
  44
  45 # SECURITY WARNING: don't run with debug turned on in production!
  46 DEBUG = True
  47
  48 ADMINS = (
  49     # ('Admin', 'webmaster@example.com'),
  50 )
  51
  52 SITE_ID = 1
  53
  54 ALLOWED_HOSTS = []
  55
  56 # Mailman API credentials
  57 MAILMAN_REST_API_URL = 'http://localhost:8001'
  58 MAILMAN_REST_API_USER = 'restadmin'
  59 MAILMAN_REST_API_PASS = 'restpass'
  60
  61
  62 # Application definition
  63
  64 INSTALLED_APPS = (
  65     'django.contrib.admin',
  66     'django.contrib.auth',
  67     'django.contrib.contenttypes',
  68     'django.contrib.sessions',
  69     'django.contrib.sites',
  70     'django.contrib.messages',
  71     'django.contrib.staticfiles',
  72     'django.contrib.humanize',
  73     'postorius',
  74     'django_mailman3',
  75     'django_gravatar',
  76     'allauth',
  77     'allauth.account',
  78     'allauth.socialaccount',
  79     'allauth.socialaccount.providers.openid',
  80     'django_mailman3.lib.auth.fedora',
  81     'allauth.socialaccount.providers.github',
  82     'allauth.socialaccount.providers.gitlab',
  83     'allauth.socialaccount.providers.google',
  84     # 'allauth.socialaccount.providers.facebook',
  85     'allauth.socialaccount.providers.twitter',
  86     'allauth.socialaccount.providers.stackexchange',
  87     # Dev only dependencies. Do not include in any production site.
  88     'debug_toolbar',
  89     'requests_panel',
  90 )
  91
  92
  93 MIDDLEWARE = [
  94     'allauth.account.middleware.AccountMiddleware',
  95     'django.contrib.sessions.middleware.SessionMiddleware',
  96     # NOTE: Do not include DebugToolbarMiddleware in any production site.
  97     'debug_toolbar.middleware.DebugToolbarMiddleware',
  98     'django.middleware.common.CommonMiddleware',
  99     'django.middleware.csrf.CsrfViewMiddleware',
 100     'django.middleware.locale.LocaleMiddleware',
 101     'django.contrib.auth.middleware.AuthenticationMiddleware',
 102     'django.contrib.messages.middleware.MessageMiddleware',
 103     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 104     'django.middleware.security.SecurityMiddleware',
 105     'django_mailman3.middleware.TimezoneMiddleware',
 106     'postorius.middleware.PostoriusMiddleware',
 107 ]
 108
 109 # Set `postorius.urls` as main url config if Postorius
 110 # is the only app you want to serve.
 111 ROOT_URLCONF = 'urls'
 112
 113
 114 TEMPLATES = [
 115     {
 116         'BACKEND': 'django.template.backends.django.DjangoTemplates',
 117         'DIRS': [],
 118         'APP_DIRS': True,
 119         'OPTIONS': {
 120             'context_processors': [
 121                 'django.template.context_processors.debug',
 122                 'django.template.context_processors.i18n',
 123                 'django.template.context_processors.media',
 124                 'django.template.context_processors.static',
 125                 'django.template.context_processors.tz',
 126                 'django.template.context_processors.request',
 127                 'django.contrib.auth.context_processors.auth',
 128                 'django.contrib.messages.context_processors.messages',
 129                 'django_mailman3.context_processors.common',
 130                 'postorius.context_processors.postorius',
 131             ],
 132         },
 133     },
 134 ]
 135
 136 WSGI_APPLICATION = 'wsgi.application'
 137
 138
 139 # Database
 140 # https://docs.djangoproject.com/en/1.9/ref/settings/#databases
 141
 142 DATABASES = {
 143     'default': {
 144         'ENGINE': 'django.db.backends.sqlite3',
 145         'NAME': os.path.join(BASE_DIR, 'postorius.db'),
 146     }
 147 }
 148
 149 # Maintain type of autogenerated keys going forward
 150 # https://docs.djangoproject.com/en/3.2/releases/3.2/#customizing-type-of-auto-created-primary-keys
 151 DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
 152
 153 # Password validation
 154 # https://docs.djangoproject.com/en/1.9/ref/settings/#auth-password-validators
 155
 156 AUTH_PASSWORD_VALIDATORS = [
 157     {
 158         'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
 159     },
 160     {
 161         'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
 162     },
 163     {
 164         'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
 165     },
 166     {
 167         'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
 168     },
 169 ]
 170
 171 # Internationalization
 172 # https://docs.djangoproject.com/en/1.9/topics/i18n/
 173
 174 LANGUAGE_CODE = 'en-us'
 175
 176 TIME_ZONE = 'UTC'
 177
 178 USE_I18N = True
 179
 180 USE_L10N = True
 181
 182 USE_TZ = True
 183
 184
 185 # Static files (CSS, JavaScript, Images)
 186 # https://docs.djangoproject.com/en/1.9/howto/static-files/
 187
 188
 189 # Absolute path to the directory static files should be collected to.
 190 # Don't put anything in this directory yourself; store your static files
 191 # in apps' "static/" subdirectories and in STATICFILES_DIRS.
 192 # Example: "/var/www/example.com/static/"
 193 STATIC_ROOT = os.path.join(BASE_DIR, 'static')
 194
 195 # URL prefix for static files.
 196 # Example: "http://example.com/static/", "http://static.example.com/"
 197 STATIC_URL = '/static/'
 198
 199 LOGIN_URL = 'account_login'
 200 LOGIN_REDIRECT_URL = 'list_index'
 201 LOGOUT_URL = 'account_logout'
 202
 203
 204 # From Address for emails sent to users
 205 DEFAULT_FROM_EMAIL = 'postorius@localhost.local'
 206 # From Address for emails sent to admins
 207 SERVER_EMAIL = 'root@localhost.local'
 208 MESSAGE_TAGS = {messages.ERROR: 'danger'}
 209
 210
 211 AUTHENTICATION_BACKENDS = (
 212     'django.contrib.auth.backends.ModelBackend',
 213     'allauth.account.auth_backends.AuthenticationBackend',
 214 )
 215
 216 # Django Allauth
 217 ACCOUNT_AUTHENTICATION_METHOD = 'username_email'
 218 ACCOUNT_EMAIL_REQUIRED = True
 219 ACCOUNT_EMAIL_VERIFICATION = 'mandatory'
 220 ACCOUNT_DEFAULT_HTTP_PROTOCOL = 'https'
 221 ACCOUNT_UNIQUE_EMAIL = True
 222 ACCOUNT_EMAIL_UNKNOWN_ACCOUNTS = False
 223
 224 SOCIALACCOUNT_PROVIDERS = {
 225     'openid': {
 226         'SERVERS': [
 227             dict(id='yahoo', name='Yahoo', openid_url='http://me.yahoo.com'),
 228         ],
 229     },
 230     'google': {
 231         'SCOPE': ['profile', 'email'],
 232         'AUTH_PARAMS': {'access_type': 'online'},
 233     },
 234     'facebook': {
 235         'METHOD': 'oauth2',
 236         'SCOPE': ['email'],
 237         'FIELDS': [
 238             'email',
 239             'name',
 240             'first_name',
 241             'last_name',
 242             'locale',
 243             'timezone',
 244         ],
 245         'VERSION': 'v2.4',
 246     },
 247 }
 248
 249
 250 # These can be set to override the defaults but are not mandatory:
 251 # EMAIL_CONFIRMATION_TEMPLATE = 'postorius/address_confirmation_message.txt'
 252 # EMAIL_CONFIRMATION_SUBJECT = 'Confirmation needed'
 253
 254
 255 LOGGING = {
 256     'version': 1,
 257     'disable_existing_loggers': False,
 258     'handlers': {
 259         'console': {
 260             'class': 'logging.StreamHandler',
 261             'formatter': 'simple',
 262         },
 263         'file': {
 264             'level': 'INFO',
 265             #'class': 'logging.handlers.RotatingFileHandler',
 266             'class': 'logging.handlers.WatchedFileHandler',
 267             'filename': os.path.join(BASE_DIR, 'logs', 'postorius.log'),
 268             'formatter': 'verbose',
 269         },
 270     },
 271     'loggers': {
 272         'django': {
 273             'handlers': ['console', 'file'],
 274             'level': 'INFO',
 275         },
 276         'django.request': {
 277             'handlers': ['console', 'file'],
 278             'level': 'ERROR',
 279         },
 280         'postorius': {
 281             'handlers': ['console', 'file'],
 282             'level': 'DEBUG',
 283         },
 284     },
 285     'formatters': {
 286         'simple': {'format': '%(levelname)s: %(message)s'},
 287         'verbose': {
 288             'format': '%(levelname)s %(asctime)s %(process)d %(name)s %(message)s'
 289         },
 290     },
 291 }
 292
 293
 294 POSTORIUS_TEMPLATE_BASE_URL = 'http://localhost:8000'
 295
 296 #: Debug the API calls made by Postorius.
 297 POSTORIUS_API_DEBUG = False
 298
 299 if DEBUG and POSTORIUS_API_DEBUG:
 300     MIDDLEWARE.append('postorius.middleware.APICountingMiddleware')
 301
 302
 303 # Needed for django debug toolbar to show up.
 304 INTERNAL_IPS = ('127.0.0.1',)
 305
 306 # List of panels that show up for django-debug-toolbar. They are
 307 # very useful for debugging and are ONLY REQUIRED FOR TESTING.
 308 DEBUG_TOOLBAR_PANELS = [
 309     'requests_panel.panel.RequestsDebugPanel',
 310     'debug_toolbar.panels.sql.SQLPanel',
 311     'debug_toolbar.panels.templates.TemplatesPanel',
 312     'debug_toolbar.panels.history.HistoryPanel',
 313     'debug_toolbar.panels.versions.VersionsPanel',
 314     'debug_toolbar.panels.timer.TimerPanel',
 315     'debug_toolbar.panels.settings.SettingsPanel',
 316     'debug_toolbar.panels.headers.HeadersPanel',
 317     'debug_toolbar.panels.request.RequestPanel',
 318     'debug_toolbar.panels.staticfiles.StaticFilesPanel',
 319     'debug_toolbar.panels.cache.CachePanel',
 320     'debug_toolbar.panels.signals.SignalsPanel',
 321     'debug_toolbar.panels.logging.LoggingPanel',
 322     'debug_toolbar.panels.redirects.RedirectsPanel',
 323     'debug_toolbar.panels.profiling.ProfilingPanel',
 324 ]
 325
 326 try:
 327     from settings_local import *
 328 except ImportError:
 329     pass