diff options
Diffstat (limited to '_deploy/SnowWhite/localsettings-SnowWhite.py')
| -rw-r--r-- | _deploy/SnowWhite/localsettings-SnowWhite.py | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/_deploy/SnowWhite/localsettings-SnowWhite.py b/_deploy/SnowWhite/localsettings-SnowWhite.py new file mode 100644 index 0000000..3f6ab6b --- /dev/null +++ b/_deploy/SnowWhite/localsettings-SnowWhite.py @@ -0,0 +1,182 @@ +import sys +from pathlib import Path + +"""Settings for a troggle installation which may vary among different +installations: for development or deployment, in a docker image or +python virtual environment (venv), on ubuntu, debian or in Windows +System for Linux (WSL), on the main server or in the potato hut, +using SQLite or mariaDB. + +It sets the directory locations for the major parts of the system so +that e.g. expofiles can be on a different filesystem, or /javascript/ can be in +a system-wide location rather than just a local directory. + +This file is included at the end of the main troggle/settings.py file so that +it overwrites defaults in that file. + +Read https://realpython.com/python-pathlib/ +Read https://adamj.eu/tech/2020/03/16/use-pathlib-in-your-django-project/ +""" + +print(" * importing troggle/localsettings.py") + + +EXPOUSER = 'expo' +EXPOADMINUSER = 'expoadmin' +EXPOUSER_EMAIL = 'wookey@wookware.org' +EXPOADMINUSER_EMAIL = 'wookey@wookware.org' + +from secret_credentials import * +SECRET_KEY = "real-SECRET_KEY--imported-from-localsettings.py" +SECRET_KEY = "real-SECRET_KEY--imported-from-localsettings.py" +EXPOUSERPASS = "nnn:gggggg - real-expo-password---imported-from-localsettings.py" +EXPOADMINUSERPASS = "gggggg:nnn - real-expo-password---imported-from-localsettings.py" +EMAIL_HOST_PASSWORD = "real-email-password---imported-from-localsettings.py" +# MARIADB_SERVER_PASSWORD = + +EMAIL_HOST = "smtp-auth.mythic-beasts.com" +EMAIL_HOST_USER = "django-test@klebos.eu" # Philip Sargent really +EMAIL_PORT = 587 +EMAIL_USE_TLS = True +DEFAULT_FROM_EMAIL = "EXPO SERVER AUTOMATIC <django-test@klebos.eu>" +# ----------------------------------------------------------------- +# THINK before you push this to a repo +# - have you checked that secret_credentials.py is in .gitignore ? +# - we don't want to have to change the expo system password ! +# ----------------------------------------------------------------- +# default values, real secrets will be imported from credentials.py in future + +SQLITEFILE = "/home/philip/expo/troggle.sqlite" # can be ':memory:' + +PHOTOSREMOTE = False # if True, then re-routes urls in expofiles/photos to remote server. Not implemented yet +EXPOFILESREMOTE = False # if True, then re-routes urls in expofiles to remote server. Tests are then less accurate. +# SECURE_SSL_REDIRECT = True # breaks 7 tests in test suite 301 not 200 (or 302) and runserver fails completely +SERVERPORT = "8000" # not needed as it is the default + +ADMINS = ( + ('Philip', 'philip.sargent@klebos.eu'), # only on dev +) + +PV = "python" + str(sys.version_info.major) + "." + str(sys.version_info.minor) + +# Troggle does a lot of file-handling. This is very error-prone when using primitive methods, +# so we use pathlib which has been standard since python 3.4 +# If pathlib is new to you, you will need to read https://realpython.com/python-pathlib/ + +# --------------------- MEDIA redirections BEGIN --------------------- +REPOS_ROOT_PATH = Path(__file__).parent.parent # folder above troggle, expoweb, drawings, loser +LIBDIR = REPOS_ROOT_PATH / "lib" / PV +sys.path.append(str(REPOS_ROOT_PATH)) + +TROGGLE_PATH = Path(__file__).parent +TEMPLATE_PATH = TROGGLE_PATH / "templates" +MEDIA_ROOT = TROGGLE_PATH / "media" +JSLIB_ROOT = TROGGLE_PATH / "media" / "jslib" # used for CaveViewer JS utility + +EXPOFILES = REPOS_ROOT_PATH / "expofiles" # sometimes on a different filesystem + +SCANS_ROOT = EXPOFILES / "surveyscans" +PHOTOS_ROOT = EXPOFILES / "photos" # sometimes on a different filesystem +PHOTOS_YEAR = "2025" + +KMZ_ICONS_PATH = REPOS_ROOT_PATH / "troggle" / "kmz_icons" # Google Earth export in /caves/ + +# URL that handles the media served from MEDIA_ROOT. +# Note that MEDIA_URL and PHOTOS_URL are not actually used in urls.py, they should be.. +# and they all need to end with / so using 'Path' doesn't work.. +URL_ROOT = "/" +MEDIA_URL = Path(URL_ROOT, "/site_media/") +PHOTOS_URL = Path(URL_ROOT, "/photos/") + +STATIC_URL = Path(URL_ROOT, "/static/") # used by Django admin pages. Do not delete. +JSLIB_URL = Path(URL_ROOT, "/javascript/") # used for CaveViewer JS utility + +# STATIC_ROOT removed after merging content into MEDIA_ROOT. See urls.py & core/views/surveys.py +# --------------------- MEDIA redirections END --------------------- + +PUBLIC_SITE = True +DEBUG = True # Always keep this True, even when on public server. Otherwise NO USEFUL ERROR MESSAGES ! +CACHEDPAGES = True # experimental page cache for a handful of page types + +DBSQLITE = { + "default": { + "ENGINE": "django.db.backends.sqlite3", # 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'. + "NAME": SQLITEFILE, + # 'NAME' : ':memory:', + "USER": "expo", # Not used with sqlite3. + "PASSWORD": "sekrit", # Not used with sqlite3. + "HOST": "", # Set to empty string for localhost. Not used with sqlite3. + "PORT": "", # Set to empty string for default. Not used with sqlite3. + } +} +DBMARIADB = { + "default": { + "ENGINE": "django.db.backends.mysql", # 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'. + "OPTIONS": { + "charset": "utf8mb4", + }, + "NAME": "troggle", # Or path to database file if using sqlite3. + "USER": "expo", + "PASSWORD": MARIADB_SERVER_PASSWORD, + "HOST": "", # Set to empty string for localhost. Not used with sqlite3. + "PORT": "", # Set to empty string for default. Not used with sqlite3. + } +} + +# default database for me is squlite +DBSWITCH = "sqlite" + +if DBSWITCH == "sqlite": + DATABASES = DBSQLITE +if DBSWITCH == "mariadb": + DATABASES = DBMARIADB + +TEMPLATES = [ + { + "BACKEND": "django.template.backends.django.DjangoTemplates", + "DIRS": [TEMPLATE_PATH], + "OPTIONS": { + "debug": "DEBUG", + "context_processors": [ + # django.template.context_processors.csrf, # is always enabled and cannot be removed, sets csrf_token + "django.contrib.auth.context_processors.auth", # knowledge of logged-on user & permissions + "core.context.troggle_context", # in core/context.py - only used in expedition.html + "django.template.context_processors.debug", + "django.template.context_processors.i18n", + "django.template.context_processors.media", # includes a variable MEDIA_URL + "django.template.context_processors.static", # includes a variable STATIC_URL used by admin pages + "django.template.context_processors.tz", + "django.template.context_processors.request", # must be enabled in DjangoTemplates (TEMPLATES) in order to use the admin navigation sidebar. + "django.contrib.messages.context_processors.messages", + ], + "loaders": [ + "django.template.loaders.filesystem.Loader", # default lcation is troggle/templates/ + "django.template.loaders.app_directories.Loader", # needed for admin 'app' + ], + }, + }, +] + + + +SURVEX_DATA = REPOS_ROOT_PATH / "loser" +DRAWINGS_DATA = REPOS_ROOT_PATH / "drawings" +EXPOWEB = REPOS_ROOT_PATH / "expoweb" +CAVEDESCRIPTIONS = EXPOWEB / "cave_data" +ENTRANCEDESCRIPTIONS = EXPOWEB / "entrance_data" + +# Sanitise these to be strings as Django seems to be particularly sensitive to crashing if they aren't +STATIC_URL = str(STATIC_URL) + "/" +MEDIA_URL = str(MEDIA_URL) + "/" + +# Re-enable TinyMCE when Dj upgraded to v3. Also templates/editexpopage.html +# TINYMCE_DEFAULT_CONFIG = { +# 'plugins': "table,spellchecker,paste,searchreplace", +# 'theme': "advanced", +# } +# TINYMCE_SPELLCHECKER = False +# TINYMCE_COMPRESSOR = True +#TINY_MCE_MEDIA_ROOT = STATIC_ROOT + '/tiny_mce/' # not needed while TinyMCE not installed +#TINY_MCE_MEDIA_URL = STATIC_URL + '/tiny_mce/' # not needed while TinyMCE not installed + +print(" + finished importing troggle/localsettings.py")
\ No newline at end of file |