From 5b7838334e4c7a0980aeac24446eca68ee683e94 Mon Sep 17 00:00:00 2001 From: Tobias Herre Date: Wed, 19 Feb 2025 12:24:10 +0000 Subject: [PATCH] Added settings.py.example --- foerderbarometer/settings.py.example | 203 +++++++++++++++++++++++++++ 1 file changed, 203 insertions(+) create mode 100755 foerderbarometer/settings.py.example diff --git a/foerderbarometer/settings.py.example b/foerderbarometer/settings.py.example new file mode 100755 index 0000000..c668c9f --- /dev/null +++ b/foerderbarometer/settings.py.example @@ -0,0 +1,203 @@ +""" +Django settings for foerderbarometer project. + +Generated by 'django-admin startproject' using Django 3.1.1. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/3.1/ref/settings/ +""" + +import json +import os +from pathlib import Path + +from django.core.exceptions import ImproperlyConfigured + +# prefix for urls in mails +URLPREFIX = 'https://fdb-devel.wikimedia.de' + + +# mails in development go to stdout +EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend' + +CSRF_TRUSTED_ORIGINS = ['https://fdb-devel.wikimedia.de'] + +# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend' + +EMAIL_HOST = 'xemail.wikimedia.de' +EMAIL_PORT = '587' +EMAIL_USE_TLS = True +#EMAIL_HOST_USER = get_secret('EMAIL_HOST_USER') +#EMAIL_HOST_PASSWORD = get_secret('EMAIL_HOST_PASSWORD') + + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + +# get secrets +with open(os.path.join(BASE_DIR, 'secrets.json')) as secrets_file: + secrets = json.load(secrets_file) + +def get_secret(setting, secrets=secrets): + """Get secret setting or fail with ImproperlyConfigured""" + try: + return secrets[setting] + except KeyError: + raise ImproperlyConfigured("Set the {} setting".format(setting)) + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/3.1/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = get_secret('SECRET_KEY') + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +STATIC_ROOT = BASE_DIR / 'staticfiles' + +ALLOWED_HOSTS = ['*'] + + +# Application definition + +INSTALLED_APPS = [ + 'input.apps.InputConfig', + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'formtools', +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'whitenoise.middleware.WhiteNoiseMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.locale.LocaleMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', + 'input.middleware.oauth.OAuthMiddleware' +] + +ROOT_URLCONF = 'foerderbarometer.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'foerderbarometer.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/3.1/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.mysql', + 'NAME': 'fdbdevel', + 'USER': 'fdbdevel', + 'PASSWORD': get_secret('DATABASE_PASSWORD'), + 'HOST': '10.0.6.224', # Or an IP Address that your database is hosted on + # 'PORT': '3306', + #optional: + 'OPTIONS': { + 'charset' : 'utf8', + 'use_unicode' : True, + 'init_command': 'SET ' + 'storage_engine=INNODB,' + 'character_set_connection=utf8,' + 'collation_connection=utf8_bin' + #'sql_mode=STRICT_TRANS_TABLES,' # see note below + #'SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED', + }, + 'TEST_CHARSET': 'utf8', + 'TEST_COLLATION': 'utf8_general_ci', + } +} + +# Password validation +# https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/3.1/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/3.1/howto/static-files/ + +STATIC_URL = '/static/' + +# needed since django 3.2 +DEFAULT_AUTO_FIELD = 'django.db.models.AutoField' + + +# OAuth Settings +OAUTH_URL_WHITELISTS = ['/admin'] + +OAUTH_CLIENT_NAME = '' +OAUTH_CLIENT_NAME = get_secret('OAUTH_CLIENT_NAME') + + +OAUTH_CLIENT = { + 'client_id': get_secret('OAUTH_CLIENT_ID'), + 'client_secret': get_secret('OAUTH_CLIENT_SECRET'), + 'access_token_url': 'https://meta.wikimedia.org/w/rest.php/oauth2/access_token', + 'authorize_url': 'https://meta.wikimedia.org/w/rest.php/oauth2/authorize', + 'api_base_url': 'https://meta.wikimedia.org/w/rest.php/oauth2/resource', + 'redirect_uri': 'https://fdb-devel.wikimedia.de/oauth/callback', + 'client_kwargs': { + 'scope': 'basic', + 'token_placement': 'header' + }, + 'userinfo_endpoint': 'resource/profile', +} + +OAUTH_COOKIE_SESSION_ID = 'sso_session_id'