example_project/settings.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (C) 1998-2022 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     'postorius',
  73     'django_mailman3',
  74     'django_gravatar',
  75     'allauth',
  76     'allauth.account',
  77     'allauth.socialaccount',
  78     'allauth.socialaccount.providers.openid',
  79     'django_mailman3.lib.auth.fedora',
  80     'allauth.socialaccount.providers.github',
  81     'allauth.socialaccount.providers.gitlab',
  82     'allauth.socialaccount.providers.google',
  83     # 'allauth.socialaccount.providers.facebook',
  84     'allauth.socialaccount.providers.twitter',
  85     'allauth.socialaccount.providers.stackexchange',
  86 )
  87
  88
  89 MIDDLEWARE = [
  90     'django.contrib.sessions.middleware.SessionMiddleware',
  91     'django.middleware.common.CommonMiddleware',
  92     'django.middleware.csrf.CsrfViewMiddleware',
  93     'django.middleware.locale.LocaleMiddleware',
  94     'django.contrib.auth.middleware.AuthenticationMiddleware',
  95     'django.contrib.messages.middleware.MessageMiddleware',
  96     'django.middleware.clickjacking.XFrameOptionsMiddleware',
  97     'django.middleware.security.SecurityMiddleware',
  98     'django_mailman3.middleware.TimezoneMiddleware',
  99     'postorius.middleware.PostoriusMiddleware',
 100 ]
 101
 102 # Set `postorius.urls` as main url config if Postorius
 103 # is the only app you want to serve.
 104 ROOT_URLCONF = 'urls'
 105
 106
 107 TEMPLATES = [
 108     {
 109         'BACKEND': 'django.template.backends.django.DjangoTemplates',
 110         'DIRS': [],
 111         'APP_DIRS': True,
 112         'OPTIONS': {
 113             'context_processors': [
 114                 'django.template.context_processors.debug',
 115                 'django.template.context_processors.i18n',
 116                 'django.template.context_processors.media',
 117                 'django.template.context_processors.static',
 118                 'django.template.context_processors.tz',
 119                 'django.template.context_processors.csrf',
 120                 'django.template.context_processors.request',
 121                 'django.contrib.auth.context_processors.auth',
 122                 'django.contrib.messages.context_processors.messages',
 123                 'django_mailman3.context_processors.common',
 124                 'postorius.context_processors.postorius',
 125             ],
 126         },
 127     },
 128 ]
 129
 130 WSGI_APPLICATION = 'wsgi.application'
 131
 132
 133 # Database
 134 # https://docs.djangoproject.com/en/1.9/ref/settings/#databases
 135
 136 DATABASES = {
 137     'default': {
 138         'ENGINE': 'django.db.backends.sqlite3',
 139         'NAME': os.path.join(BASE_DIR, 'postorius.db'),
 140     }
 141 }
 142
 143 # Maintain type of autogenerated keys going forward
 144 # https://docs.djangoproject.com/en/3.2/releases/3.2/#customizing-type-of-auto-created-primary-keys
 145 DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
 146
 147 # Password validation
 148 # https://docs.djangoproject.com/en/1.9/ref/settings/#auth-password-validators
 149
 150 AUTH_PASSWORD_VALIDATORS = [
 151     {
 152         'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
 153     },
 154     {
 155         'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
 156     },
 157     {
 158         'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
 159     },
 160     {
 161         'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
 162     },
 163 ]
 164
 165 # Internationalization
 166 # https://docs.djangoproject.com/en/1.9/topics/i18n/
 167
 168 LANGUAGE_CODE = 'en-us'
 169
 170 TIME_ZONE = 'UTC'
 171
 172 USE_I18N = True
 173
 174 USE_L10N = True
 175
 176 USE_TZ = True
 177
 178
 179 # Static files (CSS, JavaScript, Images)
 180 # https://docs.djangoproject.com/en/1.9/howto/static-files/
 181
 182
 183 # Absolute path to the directory static files should be collected to.
 184 # Don't put anything in this directory yourself; store your static files
 185 # in apps' "static/" subdirectories and in STATICFILES_DIRS.
 186 # Example: "/var/www/example.com/static/"
 187 STATIC_ROOT = os.path.join(BASE_DIR, 'static')
 188
 189 # URL prefix for static files.
 190 # Example: "http://example.com/static/", "http://static.example.com/"
 191 STATIC_URL = '/static/'
 192
 193 LOGIN_URL = 'account_login'
 194 LOGIN_REDIRECT_URL = 'list_index'
 195 LOGOUT_URL = 'account_logout'
 196
 197
 198
 199 # From Address for emails sent to users
 200 DEFAULT_FROM_EMAIL = 'postorius@localhost.local'
 201 # From Address for emails sent to admins
 202 SERVER_EMAIL = 'root@localhost.local'
 203 MESSAGE_TAGS = {
 204     messages.ERROR: 'danger'
 205 }
 206
 207
 208 AUTHENTICATION_BACKENDS = (
 209     'django.contrib.auth.backends.ModelBackend',
 210     'allauth.account.auth_backends.AuthenticationBackend',
 211 )
 212
 213 # Django Allauth
 214 ACCOUNT_AUTHENTICATION_METHOD = "username_email"
 215 ACCOUNT_EMAIL_REQUIRED = True
 216 ACCOUNT_EMAIL_VERIFICATION = "mandatory"
 217 ACCOUNT_DEFAULT_HTTP_PROTOCOL = "https"
 218 ACCOUNT_UNIQUE_EMAIL  = True
 219
 220 SOCIALACCOUNT_PROVIDERS = {
 221     'openid': {
 222         'SERVERS': [
 223             dict(id='yahoo',
 224                  name='Yahoo',
 225                  openid_url='http://me.yahoo.com'),
 226         ],
 227     },
 228     'google': {
 229         'SCOPE': ['profile', 'email'],
 230         'AUTH_PARAMS': {'access_type': 'online'},
 231     },
 232     'facebook': {
 233        'METHOD': 'oauth2',
 234        'SCOPE': ['email'],
 235        'FIELDS': [
 236            'email',
 237            'name',
 238            'first_name',
 239            'last_name',
 240            'locale',
 241            'timezone',
 242            ],
 243        'VERSION': 'v2.4',
 244     },
 245 }
 246
 247
 248
 249 # These can be set to override the defaults but are not mandatory:
 250 # EMAIL_CONFIRMATION_TEMPLATE = 'postorius/address_confirmation_message.txt'
 251 # EMAIL_CONFIRMATION_SUBJECT = 'Confirmation needed'
 252
 253
 254 LOGGING = {
 255     'version': 1,
 256     'disable_existing_loggers': False,
 257     'handlers': {
 258         'console': {
 259             'class': 'logging.StreamHandler',
 260             'formatter': 'simple',
 261         },
 262         'file':{
 263             'level': 'INFO',
 264             #'class': 'logging.handlers.RotatingFileHandler',
 265             'class': 'logging.handlers.WatchedFileHandler',
 266             'filename': os.path.join(BASE_DIR, 'logs', 'postorius.log'),
 267             'formatter': 'verbose',
 268         },
 269     },
 270     'loggers': {
 271         'django': {
 272             'handlers': ['console', 'file'],
 273             'level': 'INFO',
 274         },
 275         'django.request': {
 276             'handlers': ['console', 'file'],
 277             'level': 'ERROR',
 278         },
 279         'postorius': {
 280             'handlers': ['console', 'file'],
 281             'level': 'DEBUG',
 282         }
 283     },
 284     'formatters': {
 285         'simple': {
 286             'format': '%(levelname)s: %(message)s'
 287         },
 288         'verbose': {
 289             'format': '%(levelname)s %(asctime)s %(process)d %(name)s %(message)s'
 290         },
 291     },
 292 }
 293
 294
 295 POSTORIUS_TEMPLATE_BASE_URL = "http://localhost:8000"
 296
 297
 298 if DEBUG:
 299     MIDDLEWARE.append('postorius.middleware.APICountingMiddleware')
 300
 301 try:
 302     from settings_local import *
 303 except ImportError:
 304     pass