Jan Dittberner
251e8a54f6
- add __version__ to gnuviechadmin/__init__.py - change docs/conf.py to use version number from gnuviechadmin - add gnuviechadmin.context_processors.version_info to add gnuviechadmin_version to template context - add version and technology links to templates/base.html footer - add CSS styles for footer formatting
381 lines
11 KiB
Python
381 lines
11 KiB
Python
# -*- python -*-
|
|
# pymode:lint_ignore=E501
|
|
"""Common settings and globals."""
|
|
|
|
|
|
from os import environ
|
|
from os.path import abspath, basename, dirname, join, normpath
|
|
from sys import path
|
|
|
|
# Normally you should not import ANYTHING from Django directly
|
|
# into your settings, but ImproperlyConfigured is an exception.
|
|
from django.core.exceptions import ImproperlyConfigured
|
|
from django.contrib.messages import constants as messages
|
|
|
|
|
|
def get_env_variable(var_name):
|
|
"""
|
|
Get a setting from an environment variable.
|
|
|
|
:param str var_name: variable name
|
|
|
|
"""
|
|
try:
|
|
return environ[var_name]
|
|
except KeyError:
|
|
error_msg = "Set the %s environment variable" % var_name
|
|
raise ImproperlyConfigured(error_msg)
|
|
|
|
|
|
########## PATH CONFIGURATION
|
|
# Absolute filesystem path to the Django project directory:
|
|
DJANGO_ROOT = dirname(dirname(abspath(__file__)))
|
|
|
|
# Absolute filesystem path to the top-level project folder:
|
|
SITE_ROOT = dirname(DJANGO_ROOT)
|
|
|
|
# Site name:
|
|
SITE_NAME = basename(DJANGO_ROOT)
|
|
|
|
# Add our project to our pythonpath, this way we don't need to type our project
|
|
# name in our dotted import paths:
|
|
path.append(DJANGO_ROOT)
|
|
########## END PATH CONFIGURATION
|
|
|
|
|
|
########## DEBUG CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#debug
|
|
DEBUG = False
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#template-debug
|
|
TEMPLATE_DEBUG = DEBUG
|
|
########## END DEBUG CONFIGURATION
|
|
|
|
|
|
########## MANAGER CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#admins
|
|
ADMINS = (
|
|
(get_env_variable('GVA_ADMIN_NAME'), get_env_variable('GVA_ADMIN_EMAIL')),
|
|
)
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#managers
|
|
MANAGERS = ADMINS
|
|
########## END MANAGER CONFIGURATION
|
|
|
|
|
|
########## DATABASE CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#databases
|
|
DATABASES = {
|
|
'default': {
|
|
'ENGINE': 'django.db.backends.postgresql_psycopg2',
|
|
'NAME': get_env_variable('GVA_PGSQL_DATABASE'),
|
|
'USER': get_env_variable('GVA_PGSQL_USER'),
|
|
'PASSWORD': get_env_variable('GVA_PGSQL_PASSWORD'),
|
|
'HOST': get_env_variable('GVA_PGSQL_HOSTNAME'),
|
|
'PORT': get_env_variable('GVA_PGSQL_PORT'),
|
|
}
|
|
}
|
|
########## END DATABASE CONFIGURATION
|
|
|
|
|
|
########## GENERAL CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#time-zone
|
|
TIME_ZONE = 'Europe/Berlin'
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#language-code
|
|
LANGUAGE_CODE = 'en-us'
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#site-id
|
|
SITE_ID = 1
|
|
SITES_DOMAIN_NAME = get_env_variable('GVA_DOMAIN_NAME')
|
|
SITES_SITE_NAME = get_env_variable('GVA_SITE_NAME')
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#use-i18n
|
|
USE_I18N = True
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#use-l10n
|
|
USE_L10N = True
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#use-tz
|
|
USE_TZ = True
|
|
########## END GENERAL CONFIGURATION
|
|
|
|
|
|
LOCALE_PATHS = (
|
|
normpath(join(SITE_ROOT, 'locale')),
|
|
)
|
|
|
|
|
|
########## MEDIA CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#media-root
|
|
MEDIA_ROOT = normpath(join(SITE_ROOT, 'media'))
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#media-url
|
|
MEDIA_URL = '/media/'
|
|
########## END MEDIA CONFIGURATION
|
|
|
|
|
|
########## STATIC FILE CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#static-root
|
|
STATIC_ROOT = normpath(join(SITE_ROOT, 'assets'))
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#static-url
|
|
STATIC_URL = '/static/'
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#std:setting-STATICFILES_DIRS
|
|
STATICFILES_DIRS = (
|
|
normpath(join(SITE_ROOT, 'static')),
|
|
)
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#staticfiles-finders
|
|
STATICFILES_FINDERS = (
|
|
'django.contrib.staticfiles.finders.FileSystemFinder',
|
|
'django.contrib.staticfiles.finders.AppDirectoriesFinder',
|
|
)
|
|
########## END STATIC FILE CONFIGURATION
|
|
|
|
|
|
########## SECRET CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#secret-key
|
|
# Note: This key should only be used for development and testing.
|
|
SECRET_KEY = get_env_variable('GVA_SITE_SECRET')
|
|
########## END SECRET CONFIGURATION
|
|
|
|
|
|
########## SITE CONFIGURATION
|
|
# Hosts/domain names that are valid for this site
|
|
# See https://docs.djangoproject.com/en/1.5/ref/settings/#allowed-hosts
|
|
ALLOWED_HOSTS = []
|
|
########## END SITE CONFIGURATION
|
|
|
|
|
|
########## FIXTURE CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-FIXTURE_DIRS
|
|
FIXTURE_DIRS = (
|
|
normpath(join(SITE_ROOT, 'fixtures')),
|
|
)
|
|
########## END FIXTURE CONFIGURATION
|
|
|
|
|
|
########## TEMPLATE CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#template-context-processors
|
|
TEMPLATE_CONTEXT_PROCESSORS = (
|
|
'django.contrib.auth.context_processors.auth',
|
|
'django.core.context_processors.debug',
|
|
'django.core.context_processors.i18n',
|
|
'django.core.context_processors.media',
|
|
'django.core.context_processors.static',
|
|
'django.core.context_processors.tz',
|
|
'django.contrib.messages.context_processors.messages',
|
|
'django.core.context_processors.request',
|
|
# allauth specific context processors
|
|
'allauth.account.context_processors.account',
|
|
'allauth.socialaccount.context_processors.socialaccount',
|
|
# custom context processors
|
|
'gnuviechadmin.context_processors.navigation',
|
|
'gnuviechadmin.context_processors.version_info',
|
|
)
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#template-loaders
|
|
TEMPLATE_LOADERS = (
|
|
'django.template.loaders.filesystem.Loader',
|
|
'django.template.loaders.app_directories.Loader',
|
|
)
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#template-dirs
|
|
TEMPLATE_DIRS = (
|
|
normpath(join(SITE_ROOT, 'templates')),
|
|
)
|
|
########## END TEMPLATE CONFIGURATION
|
|
|
|
|
|
########## MIDDLEWARE CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#middleware-classes
|
|
MIDDLEWARE_CLASSES = (
|
|
# Default Django middleware.
|
|
'django.middleware.common.CommonMiddleware',
|
|
'django.contrib.sessions.middleware.SessionMiddleware',
|
|
'django.middleware.csrf.CsrfViewMiddleware',
|
|
'django.contrib.auth.middleware.AuthenticationMiddleware',
|
|
'django.contrib.messages.middleware.MessageMiddleware',
|
|
# uncomment next line to enable translation to browser locale
|
|
'django.middleware.locale.LocaleMiddleware',
|
|
'django.middleware.clickjacking.XFrameOptionsMiddleware',
|
|
)
|
|
########## END MIDDLEWARE CONFIGURATION
|
|
|
|
|
|
AUTHENTICATION_BACKENDS = (
|
|
# Needed to login by username in Django admin, regardless of `allauth`
|
|
"django.contrib.auth.backends.ModelBackend",
|
|
|
|
# `allauth` specific authentication methods, such as login by e-mail
|
|
"allauth.account.auth_backends.AuthenticationBackend",
|
|
)
|
|
|
|
|
|
########## URL CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#root-urlconf
|
|
ROOT_URLCONF = '%s.urls' % SITE_NAME
|
|
########## END URL CONFIGURATION
|
|
|
|
|
|
########## TEST RUNNER CONFIGURATION
|
|
TEST_RUNNER = 'django.test.runner.DiscoverRunner'
|
|
########## END TEST RUNNER CONFIGURATION
|
|
|
|
|
|
########## APP CONFIGURATION
|
|
DJANGO_APPS = (
|
|
# Default Django apps:
|
|
'django.contrib.auth',
|
|
'django.contrib.contenttypes',
|
|
'django.contrib.sessions',
|
|
'django.contrib.sites',
|
|
'django.contrib.messages',
|
|
'django.contrib.staticfiles',
|
|
|
|
# Useful template tags:
|
|
'django.contrib.humanize',
|
|
|
|
# Admin panel and documentation:
|
|
'django.contrib.admin',
|
|
|
|
# Flatpages for about page
|
|
'django.contrib.flatpages',
|
|
|
|
'crispy_forms',
|
|
)
|
|
|
|
ALLAUTH_APPS = (
|
|
'allauth',
|
|
'allauth.account',
|
|
'allauth.socialaccount',
|
|
'allauth.socialaccount.providers.google',
|
|
'allauth.socialaccount.providers.linkedin_oauth2',
|
|
'allauth.socialaccount.providers.twitter',
|
|
'allauth.socialaccount.providers.xing',
|
|
)
|
|
|
|
# Apps specific for this project go here.
|
|
LOCAL_APPS = (
|
|
'dashboard',
|
|
'taskresults',
|
|
'mysqltasks',
|
|
'pgsqltasks',
|
|
'fileservertasks',
|
|
'webtasks',
|
|
'domains',
|
|
'osusers',
|
|
'managemails',
|
|
'userdbs',
|
|
'hostingpackages',
|
|
'websites',
|
|
'contact_form',
|
|
)
|
|
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#installed-apps
|
|
INSTALLED_APPS = DJANGO_APPS + ALLAUTH_APPS + LOCAL_APPS
|
|
|
|
MESSAGE_TAGS = {
|
|
messages.DEBUG: '',
|
|
messages.ERROR: 'alert-danger',
|
|
messages.INFO: 'alert-info',
|
|
messages.SUCCESS: 'alert-success',
|
|
messages.WARNING: 'alert-warning',
|
|
}
|
|
########## END APP CONFIGURATION
|
|
|
|
|
|
########## ALLAUTH CONFIGURATION
|
|
ACCOUNT_EMAIL_REQUIRED = True
|
|
ACCOUNT_EMAIL_VERIFICATION = 'mandatory'
|
|
LOGIN_REDIRECT_URL = '/'
|
|
SOCIALACCOUNT_QUERY_EMAIL = True
|
|
########## END ALLAUTH CONFIGURATION
|
|
|
|
|
|
########## CRISPY FORMS CONFIGURATION
|
|
CRISPY_TEMPLATE_PACK = 'bootstrap3'
|
|
########## END CRISPY_FORMS CONFIGURATION
|
|
|
|
|
|
########## LOGGING CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#logging
|
|
# A sample logging configuration. The only tangible logging
|
|
# performed by this configuration is to send an email to
|
|
# the site admins on every HTTP 500 error when DEBUG=False.
|
|
# See http://docs.djangoproject.com/en/dev/topics/logging for
|
|
# more details on how to customize your logging configuration.
|
|
LOGGING = {
|
|
'version': 1,
|
|
'disable_existing_loggers': False,
|
|
'formatters': {
|
|
'verbose': {
|
|
'format': '%(levelname)s %(asctime)s %(name)s '
|
|
'%(module)s:%(lineno)d %(process)d %(thread)d %(message)s',
|
|
},
|
|
'simple': {
|
|
'format': '%(levelname)s %(name)s:%(lineno)d %(message)s',
|
|
},
|
|
},
|
|
'filters': {
|
|
'require_debug_false': {
|
|
'()': 'django.utils.log.RequireDebugFalse'
|
|
}
|
|
},
|
|
'handlers': {
|
|
'mail_admins': {
|
|
'level': 'ERROR',
|
|
'filters': ['require_debug_false'],
|
|
'class': 'django.utils.log.AdminEmailHandler'
|
|
}
|
|
},
|
|
'loggers': {
|
|
'django.request': {
|
|
'handlers': ['mail_admins'],
|
|
'level': 'ERROR',
|
|
'propagate': True,
|
|
},
|
|
}
|
|
}
|
|
########## END LOGGING CONFIGURATION
|
|
|
|
|
|
########## WSGI CONFIGURATION
|
|
# See: https://docs.djangoproject.com/en/dev/ref/settings/#wsgi-application
|
|
WSGI_APPLICATION = '%s.wsgi.application' % SITE_NAME
|
|
########## END WSGI CONFIGURATION
|
|
|
|
|
|
########## CELERY CONFIGURATION
|
|
BROKER_URL = get_env_variable('GVA_BROKER_URL')
|
|
CELERY_RESULT_BACKEND = 'amqp'
|
|
CELERY_RESULT_PERSISTENT = True
|
|
CELERY_TASK_RESULT_EXPIRES = None
|
|
CELERY_ROUTES = (
|
|
'gvacommon.celeryrouters.GvaRouter',
|
|
)
|
|
CELERY_TIMEZONE = 'Europe/Berlin'
|
|
CELERY_ENABLE_UTC = True
|
|
CELERY_ACCEPT_CONTENT = ['json']
|
|
CELERY_TASK_SERIALIZER = 'json'
|
|
CELERY_RESULT_SERIALIZER = 'json'
|
|
########## END CELERY CONFIGURATION
|
|
|
|
|
|
########## CUSTOM APP CONFIGURATION
|
|
OSUSER_MINUID = int(get_env_variable('GVA_MIN_OS_UID'))
|
|
OSUSER_MINGID = int(get_env_variable('GVA_MIN_OS_GID'))
|
|
OSUSER_USERNAME_PREFIX = get_env_variable('GVA_OSUSER_PREFIX')
|
|
OSUSER_HOME_BASEPATH = get_env_variable('GVA_OSUSER_HOME_BASEPATH')
|
|
OSUSER_DEFAULT_SHELL = get_env_variable('GVA_OSUSER_DEFAULT_SHELL')
|
|
OSUSER_SFTP_GROUP = 'sftponly'
|
|
OSUSER_SSH_GROUP = 'sshusers'
|
|
OSUSER_DEFAULT_GROUPS = [OSUSER_SFTP_GROUP]
|
|
OSUSER_UPLOAD_SERVER = get_env_variable('GVA_OSUSER_UPLOADSERVER')
|
|
|
|
GVA_LINK_WEBMAIL = get_env_variable('GVA_WEBMAIL_URL')
|
|
GVA_LINK_PHPMYADMIN = get_env_variable('GVA_PHPMYADMIN_URL')
|
|
GVA_LINK_PHPPGADMIN = get_env_variable('GVA_PHPPGADMIN_URL')
|
|
########## END CUSTOM APP CONFIGURATION
|