2021-03-08 16:49:10 +00:00
|
|
|
""" bookwyrm settings and configuration """
|
2020-01-25 06:32:41 +00:00
|
|
|
import os
|
2023-08-21 13:46:50 +00:00
|
|
|
from typing import AnyStr
|
|
|
|
|
2020-02-15 21:45:44 +00:00
|
|
|
from environs import Env
|
|
|
|
|
2023-10-19 09:29:59 +00:00
|
|
|
|
2020-12-30 11:35:11 +00:00
|
|
|
import requests
|
2021-02-27 21:43:17 +00:00
|
|
|
from django.utils.translation import gettext_lazy as _
|
2023-03-18 19:44:01 +00:00
|
|
|
from django.core.exceptions import ImproperlyConfigured
|
2021-02-27 21:43:17 +00:00
|
|
|
|
2020-12-30 11:35:11 +00:00
|
|
|
|
2022-02-19 23:29:47 +00:00
|
|
|
# pylint: disable=line-too-long
|
|
|
|
|
2020-02-15 21:45:44 +00:00
|
|
|
env = Env()
|
2021-10-11 20:22:12 +00:00
|
|
|
env.read_env()
|
2021-03-08 16:49:10 +00:00
|
|
|
DOMAIN = env("DOMAIN")
|
2023-10-19 09:29:59 +00:00
|
|
|
|
|
|
|
with open("VERSION", encoding="utf-8") as f:
|
|
|
|
version = f.read()
|
|
|
|
version = version.replace("\n", "")
|
|
|
|
|
|
|
|
VERSION = version
|
2020-02-15 21:45:44 +00:00
|
|
|
|
2022-02-18 00:23:15 +00:00
|
|
|
RELEASE_API = env(
|
|
|
|
"RELEASE_API",
|
2022-02-18 00:28:55 +00:00
|
|
|
"https://api.github.com/repos/bookwyrm-social/bookwyrm/releases/latest",
|
2022-02-18 00:23:15 +00:00
|
|
|
)
|
|
|
|
|
2023-03-18 19:23:51 +00:00
|
|
|
PAGE_LENGTH = env.int("PAGE_LENGTH", 15)
|
2021-04-29 17:40:49 +00:00
|
|
|
DEFAULT_LANGUAGE = env("DEFAULT_LANGUAGE", "English")
|
2024-01-24 18:30:45 +00:00
|
|
|
# TODO: extend maximum age to 1 year once termination of active sessions
|
|
|
|
# is implemented (see bookwyrm-social#2278, bookwyrm-social#3082).
|
|
|
|
SESSION_COOKIE_AGE = env.int("SESSION_COOKIE_AGE", 3600 * 24 * 30) # 1 month
|
2020-11-11 18:35:34 +00:00
|
|
|
|
2024-01-02 03:29:43 +00:00
|
|
|
JS_CACHE = "8a89cad7"
|
2021-09-10 17:57:16 +00:00
|
|
|
|
2020-12-02 23:19:29 +00:00
|
|
|
# email
|
2021-05-23 06:09:13 +00:00
|
|
|
EMAIL_BACKEND = env("EMAIL_BACKEND", "django.core.mail.backends.smtp.EmailBackend")
|
2021-03-08 16:49:10 +00:00
|
|
|
EMAIL_HOST = env("EMAIL_HOST")
|
2023-03-18 19:23:51 +00:00
|
|
|
EMAIL_PORT = env.int("EMAIL_PORT", 587)
|
2021-03-08 16:49:10 +00:00
|
|
|
EMAIL_HOST_USER = env("EMAIL_HOST_USER")
|
|
|
|
EMAIL_HOST_PASSWORD = env("EMAIL_HOST_PASSWORD")
|
2021-04-09 02:53:18 +00:00
|
|
|
EMAIL_USE_TLS = env.bool("EMAIL_USE_TLS", True)
|
2021-04-09 11:28:58 +00:00
|
|
|
EMAIL_USE_SSL = env.bool("EMAIL_USE_SSL", False)
|
2022-01-06 01:36:52 +00:00
|
|
|
EMAIL_SENDER_NAME = env("EMAIL_SENDER_NAME", "admin")
|
2022-01-13 04:49:57 +00:00
|
|
|
EMAIL_SENDER_DOMAIN = env("EMAIL_SENDER_DOMAIN", DOMAIN)
|
2022-01-06 01:35:42 +00:00
|
|
|
EMAIL_SENDER = f"{EMAIL_SENDER_NAME}@{EMAIL_SENDER_DOMAIN}"
|
2020-12-02 23:19:29 +00:00
|
|
|
|
2020-01-25 06:32:41 +00:00
|
|
|
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
|
2023-08-21 13:46:50 +00:00
|
|
|
BASE_DIR: AnyStr = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
2021-03-08 16:49:10 +00:00
|
|
|
LOCALE_PATHS = [
|
|
|
|
os.path.join(BASE_DIR, "locale"),
|
|
|
|
]
|
2021-10-06 20:01:29 +00:00
|
|
|
LANGUAGE_COOKIE_NAME = env.str("LANGUAGE_COOKIE_NAME", "django_language")
|
2020-01-25 06:32:41 +00:00
|
|
|
|
2022-01-25 08:22:13 +00:00
|
|
|
STATIC_ROOT = os.path.join(BASE_DIR, env("STATIC_ROOT", "static"))
|
|
|
|
MEDIA_ROOT = os.path.join(BASE_DIR, env("MEDIA_ROOT", "images"))
|
|
|
|
|
2021-04-26 18:28:33 +00:00
|
|
|
DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
|
2021-04-26 18:22:08 +00:00
|
|
|
|
2021-05-25 21:04:28 +00:00
|
|
|
# Preview image
|
2021-05-28 15:00:07 +00:00
|
|
|
ENABLE_PREVIEW_IMAGES = env.bool("ENABLE_PREVIEW_IMAGES", False)
|
|
|
|
PREVIEW_BG_COLOR = env.str("PREVIEW_BG_COLOR", "use_dominant_color_light")
|
|
|
|
PREVIEW_TEXT_COLOR = env.str("PREVIEW_TEXT_COLOR", "#363636")
|
|
|
|
PREVIEW_IMG_WIDTH = env.int("PREVIEW_IMG_WIDTH", 1200)
|
|
|
|
PREVIEW_IMG_HEIGHT = env.int("PREVIEW_IMG_HEIGHT", 630)
|
|
|
|
PREVIEW_DEFAULT_COVER_COLOR = env.str("PREVIEW_DEFAULT_COVER_COLOR", "#002549")
|
2022-01-25 08:22:13 +00:00
|
|
|
PREVIEW_DEFAULT_FONT = env.str("PREVIEW_DEFAULT_FONT", "Source Han Sans")
|
|
|
|
|
|
|
|
FONTS = {
|
|
|
|
"Source Han Sans": {
|
|
|
|
"directory": "source_han_sans",
|
|
|
|
"filename": "SourceHanSans-VF.ttf.ttc",
|
|
|
|
"url": "https://github.com/adobe-fonts/source-han-sans/raw/release/Variable/OTC/SourceHanSans-VF.ttf.ttc",
|
|
|
|
}
|
|
|
|
}
|
|
|
|
FONT_DIR = os.path.join(STATIC_ROOT, "fonts")
|
2021-05-24 22:41:53 +00:00
|
|
|
|
2020-01-25 06:32:41 +00:00
|
|
|
# Quick-start development settings - unsuitable for production
|
2021-05-10 21:19:50 +00:00
|
|
|
# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
|
2020-01-25 06:32:41 +00:00
|
|
|
|
|
|
|
# SECURITY WARNING: don't run with debug turned on in production!
|
2021-03-08 16:49:10 +00:00
|
|
|
DEBUG = env.bool("DEBUG", True)
|
2022-02-15 21:15:04 +00:00
|
|
|
USE_HTTPS = env.bool("USE_HTTPS", not DEBUG)
|
2020-01-25 06:32:41 +00:00
|
|
|
|
2023-03-18 19:44:01 +00:00
|
|
|
# SECURITY WARNING: keep the secret key used in production secret!
|
|
|
|
SECRET_KEY = env("SECRET_KEY")
|
|
|
|
if not DEBUG and SECRET_KEY == "7(2w1sedok=aznpq)ta1mc4i%4h=xx@hxwx*o57ctsuml0x%fr":
|
|
|
|
raise ImproperlyConfigured("You must change the SECRET_KEY env variable")
|
|
|
|
|
2021-03-08 16:49:10 +00:00
|
|
|
ALLOWED_HOSTS = env.list("ALLOWED_HOSTS", ["*"])
|
2020-01-25 06:32:41 +00:00
|
|
|
|
|
|
|
# Application definition
|
|
|
|
|
|
|
|
INSTALLED_APPS = [
|
2021-03-08 16:49:10 +00:00
|
|
|
"django.contrib.admin",
|
|
|
|
"django.contrib.auth",
|
|
|
|
"django.contrib.contenttypes",
|
|
|
|
"django.contrib.sessions",
|
|
|
|
"django.contrib.messages",
|
|
|
|
"django.contrib.staticfiles",
|
|
|
|
"django.contrib.humanize",
|
2023-11-14 13:18:12 +00:00
|
|
|
"oauth2_provider",
|
2023-10-30 08:43:39 +00:00
|
|
|
"file_resubmit",
|
2022-02-19 23:29:47 +00:00
|
|
|
"sass_processor",
|
2021-03-08 16:49:10 +00:00
|
|
|
"bookwyrm",
|
|
|
|
"celery",
|
2022-02-26 18:13:44 +00:00
|
|
|
"django_celery_beat",
|
2021-05-24 14:14:51 +00:00
|
|
|
"imagekit",
|
2023-11-25 01:26:13 +00:00
|
|
|
"pgtrigger",
|
2021-06-07 16:12:48 +00:00
|
|
|
"storages",
|
2020-01-25 06:32:41 +00:00
|
|
|
]
|
|
|
|
|
|
|
|
MIDDLEWARE = [
|
2021-03-08 16:49:10 +00:00
|
|
|
"django.middleware.security.SecurityMiddleware",
|
|
|
|
"django.contrib.sessions.middleware.SessionMiddleware",
|
|
|
|
"django.middleware.locale.LocaleMiddleware",
|
|
|
|
"django.middleware.common.CommonMiddleware",
|
|
|
|
"django.middleware.csrf.CsrfViewMiddleware",
|
2023-02-01 20:59:10 +00:00
|
|
|
"csp.middleware.CSPMiddleware",
|
2021-03-08 16:49:10 +00:00
|
|
|
"django.contrib.auth.middleware.AuthenticationMiddleware",
|
2021-09-17 18:31:19 +00:00
|
|
|
"bookwyrm.middleware.TimezoneMiddleware",
|
2021-09-17 18:43:47 +00:00
|
|
|
"bookwyrm.middleware.IPBlocklistMiddleware",
|
2021-03-08 16:49:10 +00:00
|
|
|
"django.contrib.messages.middleware.MessageMiddleware",
|
|
|
|
"django.middleware.clickjacking.XFrameOptionsMiddleware",
|
2023-11-18 11:10:36 +00:00
|
|
|
"bookwyrm.middleware.FileTooBig",
|
2020-01-25 06:32:41 +00:00
|
|
|
]
|
|
|
|
|
2021-03-08 16:49:10 +00:00
|
|
|
ROOT_URLCONF = "bookwyrm.urls"
|
2020-01-25 06:32:41 +00:00
|
|
|
|
|
|
|
TEMPLATES = [
|
|
|
|
{
|
2021-03-08 16:49:10 +00:00
|
|
|
"BACKEND": "django.template.backends.django.DjangoTemplates",
|
|
|
|
"DIRS": ["templates"],
|
|
|
|
"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",
|
|
|
|
"bookwyrm.context_processors.site_settings",
|
2020-01-25 06:32:41 +00:00
|
|
|
],
|
|
|
|
},
|
|
|
|
},
|
|
|
|
]
|
|
|
|
|
2022-01-10 07:53:23 +00:00
|
|
|
LOG_LEVEL = env("LOG_LEVEL", "INFO").upper()
|
2022-01-10 07:26:27 +00:00
|
|
|
# Override aspects of the default handler to our taste
|
|
|
|
# See https://docs.djangoproject.com/en/3.2/topics/logging/#default-logging-configuration
|
|
|
|
# for a reference to the defaults we're overriding
|
2022-01-17 23:56:24 +00:00
|
|
|
#
|
|
|
|
# It seems that in order to override anything you have to include its
|
|
|
|
# entire dependency tree (handlers and filters) which makes this a
|
|
|
|
# bit verbose
|
2022-01-10 06:43:43 +00:00
|
|
|
LOGGING = {
|
2022-01-10 07:53:23 +00:00
|
|
|
"version": 1,
|
|
|
|
"disable_existing_loggers": False,
|
2022-01-17 23:56:24 +00:00
|
|
|
"filters": {
|
|
|
|
# These are copied from the default configuration, required for
|
|
|
|
# implementing mail_admins below
|
|
|
|
"require_debug_false": {
|
|
|
|
"()": "django.utils.log.RequireDebugFalse",
|
|
|
|
},
|
|
|
|
"require_debug_true": {
|
|
|
|
"()": "django.utils.log.RequireDebugTrue",
|
|
|
|
},
|
2022-05-05 20:29:07 +00:00
|
|
|
"ignore_missing_variable": {
|
|
|
|
"()": "bookwyrm.utils.log.IgnoreVariableDoesNotExist",
|
|
|
|
},
|
2022-01-17 23:56:24 +00:00
|
|
|
},
|
2022-01-10 07:53:23 +00:00
|
|
|
"handlers": {
|
2022-01-17 23:56:24 +00:00
|
|
|
# Overrides the default handler to make it log to console
|
|
|
|
# regardless of the DEBUG setting (default is to not log to
|
|
|
|
# console if DEBUG=False)
|
2022-01-10 07:53:23 +00:00
|
|
|
"console": {
|
|
|
|
"level": LOG_LEVEL,
|
2022-05-05 20:29:07 +00:00
|
|
|
"filters": ["ignore_missing_variable"],
|
2022-01-10 07:53:23 +00:00
|
|
|
"class": "logging.StreamHandler",
|
2022-01-10 06:43:43 +00:00
|
|
|
},
|
2022-01-17 23:56:24 +00:00
|
|
|
# This is copied as-is from the default logger, and is
|
|
|
|
# required for the django section below
|
|
|
|
"mail_admins": {
|
|
|
|
"level": "ERROR",
|
|
|
|
"filters": ["require_debug_false"],
|
|
|
|
"class": "django.utils.log.AdminEmailHandler",
|
|
|
|
},
|
2022-01-10 06:43:43 +00:00
|
|
|
},
|
2022-01-10 07:53:23 +00:00
|
|
|
"loggers": {
|
2022-01-17 23:56:24 +00:00
|
|
|
# Install our new console handler for Django's logger, and
|
|
|
|
# override the log level while we're at it
|
2022-01-10 07:53:23 +00:00
|
|
|
"django": {
|
|
|
|
"handlers": ["console", "mail_admins"],
|
|
|
|
"level": LOG_LEVEL,
|
2022-01-10 06:43:43 +00:00
|
|
|
},
|
2022-01-25 08:37:05 +00:00
|
|
|
"django.utils.autoreload": {
|
|
|
|
"level": "INFO",
|
|
|
|
},
|
2022-01-10 07:26:27 +00:00
|
|
|
# Add a bookwyrm-specific logger
|
2022-01-10 07:53:23 +00:00
|
|
|
"bookwyrm": {
|
|
|
|
"handlers": ["console"],
|
|
|
|
"level": LOG_LEVEL,
|
|
|
|
},
|
2022-01-10 06:43:43 +00:00
|
|
|
},
|
|
|
|
}
|
|
|
|
|
2022-02-19 23:29:47 +00:00
|
|
|
STATICFILES_FINDERS = [
|
|
|
|
"django.contrib.staticfiles.finders.FileSystemFinder",
|
|
|
|
"django.contrib.staticfiles.finders.AppDirectoriesFinder",
|
|
|
|
"sass_processor.finders.CssFinder",
|
|
|
|
]
|
|
|
|
|
|
|
|
SASS_PROCESSOR_INCLUDE_FILE_PATTERN = r"^.+\.[s]{0,1}(?:a|c)ss$"
|
2022-12-19 17:37:44 +00:00
|
|
|
# when debug is disabled, make sure to compile themes once with `./bw-dev compile_themes`
|
|
|
|
SASS_PROCESSOR_ENABLED = DEBUG
|
2022-02-19 23:29:47 +00:00
|
|
|
|
|
|
|
# minify css is production but not dev
|
|
|
|
if not DEBUG:
|
|
|
|
SASS_OUTPUT_STYLE = "compressed"
|
2020-01-25 23:25:19 +00:00
|
|
|
|
2021-03-08 16:49:10 +00:00
|
|
|
WSGI_APPLICATION = "bookwyrm.wsgi.application"
|
2020-01-25 06:32:41 +00:00
|
|
|
|
2021-03-22 21:11:23 +00:00
|
|
|
# redis/activity streams settings
|
2021-03-22 17:44:42 +00:00
|
|
|
REDIS_ACTIVITY_HOST = env("REDIS_ACTIVITY_HOST", "localhost")
|
2023-03-18 19:23:51 +00:00
|
|
|
REDIS_ACTIVITY_PORT = env.int("REDIS_ACTIVITY_PORT", 6379)
|
2023-01-26 16:18:15 +00:00
|
|
|
REDIS_ACTIVITY_PASSWORD = requests.utils.quote(env("REDIS_ACTIVITY_PASSWORD", ""))
|
2023-03-18 19:23:51 +00:00
|
|
|
REDIS_ACTIVITY_DB_INDEX = env.int("REDIS_ACTIVITY_DB_INDEX", 0)
|
2023-01-14 23:44:10 +00:00
|
|
|
REDIS_ACTIVITY_URL = env(
|
|
|
|
"REDIS_ACTIVITY_URL",
|
2023-01-15 02:20:37 +00:00
|
|
|
f"redis://:{REDIS_ACTIVITY_PASSWORD}@{REDIS_ACTIVITY_HOST}:{REDIS_ACTIVITY_PORT}/{REDIS_ACTIVITY_DB_INDEX}",
|
2023-01-14 23:44:10 +00:00
|
|
|
)
|
2023-03-18 19:23:51 +00:00
|
|
|
MAX_STREAM_LENGTH = env.int("MAX_STREAM_LENGTH", 200)
|
2021-08-05 00:53:44 +00:00
|
|
|
|
|
|
|
STREAMS = [
|
|
|
|
{"key": "home", "name": _("Home Timeline"), "shortname": _("Home")},
|
|
|
|
{"key": "books", "name": _("Books Timeline"), "shortname": _("Books")},
|
|
|
|
]
|
2021-03-22 21:11:23 +00:00
|
|
|
|
2022-01-07 15:42:05 +00:00
|
|
|
# Search configuration
|
|
|
|
# total time in seconds that the instance will spend searching connectors
|
2023-03-18 19:23:51 +00:00
|
|
|
SEARCH_TIMEOUT = env.int("SEARCH_TIMEOUT", 8)
|
2022-01-07 15:42:05 +00:00
|
|
|
# timeout for a query to an individual connector
|
2023-04-06 05:18:35 +00:00
|
|
|
QUERY_TIMEOUT = env.int("INTERACTIVE_QUERY_TIMEOUT", env.int("QUERY_TIMEOUT", 5))
|
2022-01-07 15:42:05 +00:00
|
|
|
|
2024-02-09 04:47:23 +00:00
|
|
|
CACHE_KEY_PREFIX = "django_cache"
|
2022-01-05 16:27:31 +00:00
|
|
|
# Redis cache backend
|
2023-03-18 19:23:51 +00:00
|
|
|
if env.bool("USE_DUMMY_CACHE", False):
|
2022-01-06 19:40:27 +00:00
|
|
|
CACHES = {
|
2022-01-06 19:50:51 +00:00
|
|
|
"default": {
|
|
|
|
"BACKEND": "django.core.cache.backends.dummy.DummyCache",
|
2023-11-11 01:45:04 +00:00
|
|
|
},
|
|
|
|
"file_resubmit": {
|
|
|
|
"BACKEND": "django.core.cache.backends.dummy.DummyCache",
|
|
|
|
"LOCATION": "/tmp/file_resubmit_tests/",
|
|
|
|
},
|
2022-01-06 19:40:27 +00:00
|
|
|
}
|
|
|
|
else:
|
2022-01-05 18:16:49 +00:00
|
|
|
CACHES = {
|
|
|
|
"default": {
|
2024-04-01 20:07:01 +00:00
|
|
|
"BACKEND": "django.core.cache.backends.redis.RedisCache",
|
2023-01-14 22:52:54 +00:00
|
|
|
"LOCATION": REDIS_ACTIVITY_URL,
|
2024-02-09 04:47:23 +00:00
|
|
|
"KEY_PREFIX": CACHE_KEY_PREFIX,
|
2023-10-30 08:43:39 +00:00
|
|
|
},
|
|
|
|
"file_resubmit": {
|
|
|
|
"BACKEND": "django.core.cache.backends.filebased.FileBasedCache",
|
|
|
|
"LOCATION": "/tmp/file_resubmit/",
|
|
|
|
},
|
2022-01-05 16:27:31 +00:00
|
|
|
}
|
2022-01-05 17:51:00 +00:00
|
|
|
|
2022-01-05 18:16:49 +00:00
|
|
|
SESSION_ENGINE = "django.contrib.sessions.backends.cache"
|
|
|
|
SESSION_CACHE_ALIAS = "default"
|
2022-01-05 16:27:31 +00:00
|
|
|
|
2020-01-25 06:32:41 +00:00
|
|
|
# Database
|
2021-05-10 21:19:50 +00:00
|
|
|
# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
|
2020-01-25 06:32:41 +00:00
|
|
|
|
2021-06-07 19:53:57 +00:00
|
|
|
DATABASES = {
|
|
|
|
"default": {
|
2021-03-08 16:49:10 +00:00
|
|
|
"ENGINE": "django.db.backends.postgresql_psycopg2",
|
2021-12-17 06:11:19 +00:00
|
|
|
"NAME": env("POSTGRES_DB", "bookwyrm"),
|
|
|
|
"USER": env("POSTGRES_USER", "bookwyrm"),
|
|
|
|
"PASSWORD": env("POSTGRES_PASSWORD", "bookwyrm"),
|
2021-03-08 16:49:10 +00:00
|
|
|
"HOST": env("POSTGRES_HOST", ""),
|
2023-03-18 19:23:51 +00:00
|
|
|
"PORT": env.int("PGPORT", 5432),
|
2020-03-27 20:04:06 +00:00
|
|
|
},
|
2020-01-25 06:32:41 +00:00
|
|
|
}
|
|
|
|
|
2020-03-27 20:04:06 +00:00
|
|
|
|
2021-03-08 16:49:10 +00:00
|
|
|
LOGIN_URL = "/login/"
|
|
|
|
AUTH_USER_MODEL = "bookwyrm.User"
|
2020-01-25 06:32:41 +00:00
|
|
|
|
|
|
|
# Password validation
|
2021-05-10 21:19:50 +00:00
|
|
|
# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
|
2020-01-25 06:32:41 +00:00
|
|
|
|
|
|
|
AUTH_PASSWORD_VALIDATORS = [
|
|
|
|
{
|
2021-03-08 16:49:10 +00:00
|
|
|
"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
|
2020-01-25 06:32:41 +00:00
|
|
|
},
|
|
|
|
{
|
2021-03-08 16:49:10 +00:00
|
|
|
"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
|
2020-01-25 06:32:41 +00:00
|
|
|
},
|
|
|
|
{
|
2021-03-08 16:49:10 +00:00
|
|
|
"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
|
2020-01-25 06:32:41 +00:00
|
|
|
},
|
|
|
|
{
|
2021-03-08 16:49:10 +00:00
|
|
|
"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
|
2020-01-25 06:32:41 +00:00
|
|
|
},
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
|
# Internationalization
|
2021-05-10 21:19:50 +00:00
|
|
|
# https://docs.djangoproject.com/en/3.2/topics/i18n/
|
2020-01-25 06:32:41 +00:00
|
|
|
|
2022-01-21 00:04:42 +00:00
|
|
|
LANGUAGE_CODE = env("LANGUAGE_CODE", "en-us")
|
2021-02-28 00:18:24 +00:00
|
|
|
LANGUAGES = [
|
2021-03-08 16:49:10 +00:00
|
|
|
("en-us", _("English")),
|
2022-07-15 19:26:30 +00:00
|
|
|
("ca-es", _("Català (Catalan)")),
|
2021-10-11 16:23:28 +00:00
|
|
|
("de-de", _("Deutsch (German)")),
|
2023-03-28 21:10:29 +00:00
|
|
|
("eo-uy", _("Esperanto (Esperanto)")),
|
2021-10-11 19:17:39 +00:00
|
|
|
("es-es", _("Español (Spanish)")),
|
2022-12-21 18:09:01 +00:00
|
|
|
("eu-es", _("Euskara (Basque)")),
|
2021-11-17 18:02:39 +00:00
|
|
|
("gl-es", _("Galego (Galician)")),
|
2022-01-08 15:38:14 +00:00
|
|
|
("it-it", _("Italiano (Italian)")),
|
2024-02-10 07:08:41 +00:00
|
|
|
("ko-kr", _("한국어 (Korean)")),
|
2022-03-31 15:20:52 +00:00
|
|
|
("fi-fi", _("Suomi (Finnish)")),
|
2021-10-11 16:23:28 +00:00
|
|
|
("fr-fr", _("Français (French)")),
|
2021-11-17 18:02:39 +00:00
|
|
|
("lt-lt", _("Lietuvių (Lithuanian)")),
|
2023-07-23 19:27:42 +00:00
|
|
|
("nl-nl", _("Nederlands (Dutch)")),
|
2022-01-08 15:38:14 +00:00
|
|
|
("no-no", _("Norsk (Norwegian)")),
|
2022-08-02 17:59:04 +00:00
|
|
|
("pl-pl", _("Polski (Polish)")),
|
2022-01-04 22:30:41 +00:00
|
|
|
("pt-br", _("Português do Brasil (Brazilian Portuguese)")),
|
|
|
|
("pt-pt", _("Português Europeu (European Portuguese)")),
|
2022-03-26 17:03:50 +00:00
|
|
|
("ro-ro", _("Română (Romanian)")),
|
2022-02-02 19:43:54 +00:00
|
|
|
("sv-se", _("Svenska (Swedish)")),
|
2023-12-17 14:52:49 +00:00
|
|
|
("uk-ua", _("Українська (Ukrainian)")),
|
2021-10-11 16:23:28 +00:00
|
|
|
("zh-hans", _("简体中文 (Simplified Chinese)")),
|
|
|
|
("zh-hant", _("繁體中文 (Traditional Chinese)")),
|
2021-02-28 00:18:24 +00:00
|
|
|
]
|
|
|
|
|
2023-04-25 04:29:55 +00:00
|
|
|
LANGUAGE_ARTICLES = {
|
2023-04-26 00:46:38 +00:00
|
|
|
"English": {"the", "a", "an"},
|
2023-08-16 05:53:43 +00:00
|
|
|
"Español (Spanish)": {"un", "una", "unos", "unas", "el", "la", "los", "las"},
|
2023-04-25 04:29:55 +00:00
|
|
|
}
|
2020-01-25 06:32:41 +00:00
|
|
|
|
2021-03-08 16:49:10 +00:00
|
|
|
TIME_ZONE = "UTC"
|
2020-01-25 06:32:41 +00:00
|
|
|
|
|
|
|
USE_I18N = True
|
|
|
|
|
|
|
|
USE_TZ = True
|
|
|
|
|
2021-06-06 19:12:21 +00:00
|
|
|
# Imagekit generated thumbnails
|
2021-06-07 17:52:25 +00:00
|
|
|
ENABLE_THUMBNAIL_GENERATION = env.bool("ENABLE_THUMBNAIL_GENERATION", False)
|
2021-06-06 19:12:21 +00:00
|
|
|
IMAGEKIT_CACHEFILE_DIR = "thumbnails"
|
2022-01-08 16:41:44 +00:00
|
|
|
IMAGEKIT_DEFAULT_CACHEFILE_STRATEGY = "bookwyrm.thumbnail_generation.Strategy"
|
2021-06-19 09:53:05 +00:00
|
|
|
|
2021-06-07 16:12:48 +00:00
|
|
|
PROJECT_DIR = os.path.dirname(os.path.abspath(__file__))
|
2023-02-21 21:02:52 +00:00
|
|
|
CSP_ADDITIONAL_HOSTS = env.list("CSP_ADDITIONAL_HOSTS", [])
|
2021-06-07 16:12:48 +00:00
|
|
|
|
2021-06-19 15:09:53 +00:00
|
|
|
PROTOCOL = "http"
|
|
|
|
if USE_HTTPS:
|
|
|
|
PROTOCOL = "https"
|
2023-02-01 20:59:10 +00:00
|
|
|
SESSION_COOKIE_SECURE = True
|
|
|
|
CSRF_COOKIE_SECURE = True
|
2021-06-19 15:09:53 +00:00
|
|
|
|
2024-04-07 15:19:48 +00:00
|
|
|
PORT = env.int("PORT", 443 if USE_HTTPS else 80)
|
|
|
|
if (USE_HTTPS and PORT == 443) or (not USE_HTTPS and PORT == 80):
|
|
|
|
NETLOC = DOMAIN
|
|
|
|
else:
|
|
|
|
NETLOC = f"{DOMAIN}:{PORT}"
|
|
|
|
BASE_URL = f"{PROTOCOL}://{NETLOC}"
|
2024-04-02 10:38:53 +00:00
|
|
|
CSRF_TRUSTED_ORIGINS = [BASE_URL]
|
2024-04-07 15:19:48 +00:00
|
|
|
|
|
|
|
USER_AGENT = f"BookWyrm (BookWyrm/{VERSION}; +{BASE_URL})"
|
|
|
|
|
|
|
|
# Storage
|
|
|
|
|
2021-06-07 16:15:48 +00:00
|
|
|
USE_S3 = env.bool("USE_S3", False)
|
2023-03-05 15:05:20 +00:00
|
|
|
USE_AZURE = env.bool("USE_AZURE", False)
|
2024-03-24 09:53:49 +00:00
|
|
|
S3_SIGNED_URL_EXPIRY = env.int("S3_SIGNED_URL_EXPIRY", 900)
|
2021-06-07 16:12:48 +00:00
|
|
|
|
|
|
|
if USE_S3:
|
|
|
|
# AWS settings
|
|
|
|
AWS_ACCESS_KEY_ID = env("AWS_ACCESS_KEY_ID")
|
|
|
|
AWS_SECRET_ACCESS_KEY = env("AWS_SECRET_ACCESS_KEY")
|
|
|
|
AWS_STORAGE_BUCKET_NAME = env("AWS_STORAGE_BUCKET_NAME")
|
2023-10-29 00:29:49 +00:00
|
|
|
AWS_S3_CUSTOM_DOMAIN = env("AWS_S3_CUSTOM_DOMAIN", None)
|
2021-08-01 09:47:39 +00:00
|
|
|
AWS_S3_REGION_NAME = env("AWS_S3_REGION_NAME", "")
|
2023-10-29 00:29:49 +00:00
|
|
|
AWS_S3_ENDPOINT_URL = env("AWS_S3_ENDPOINT_URL", None)
|
2021-06-07 16:12:48 +00:00
|
|
|
AWS_DEFAULT_ACL = "public-read"
|
2021-06-07 16:15:48 +00:00
|
|
|
AWS_S3_OBJECT_PARAMETERS = {"CacheControl": "max-age=86400"}
|
2024-03-27 21:58:43 +00:00
|
|
|
AWS_S3_URL_PROTOCOL = env("AWS_S3_URL_PROTOCOL", f"{PROTOCOL}:")
|
2024-03-29 19:44:01 +00:00
|
|
|
# Storages
|
|
|
|
STORAGES = {
|
|
|
|
"default": {
|
2024-03-29 21:22:33 +00:00
|
|
|
"BACKEND": "storages.backends.s3.S3Storage",
|
|
|
|
"OPTIONS": {
|
|
|
|
"location": "images",
|
|
|
|
"default_acl": "public-read",
|
|
|
|
"file_overwrite": False,
|
|
|
|
},
|
2024-03-29 19:44:01 +00:00
|
|
|
},
|
|
|
|
"staticfiles": {
|
2024-03-29 21:22:33 +00:00
|
|
|
"BACKEND": "storages.backends.s3.S3Storage",
|
|
|
|
"OPTIONS": {
|
|
|
|
"location": "static",
|
|
|
|
"default_acl": "public-read",
|
|
|
|
},
|
2024-03-29 19:44:01 +00:00
|
|
|
},
|
2024-06-12 20:03:10 +00:00
|
|
|
"sass_processor": {
|
|
|
|
"BACKEND": "storages.backends.s3.S3Storage",
|
|
|
|
"OPTIONS": {
|
|
|
|
"location": "static",
|
|
|
|
"default_acl": "public-read",
|
|
|
|
},
|
|
|
|
},
|
2024-03-29 19:44:01 +00:00
|
|
|
"exports": {
|
2024-03-29 21:22:33 +00:00
|
|
|
"BACKEND": "storages.backends.s3.S3Storage",
|
|
|
|
"OPTIONS": {
|
|
|
|
"location": "images",
|
|
|
|
"default_acl": None,
|
|
|
|
"file_overwrite": False,
|
|
|
|
},
|
2024-03-29 19:44:01 +00:00
|
|
|
},
|
|
|
|
}
|
2021-06-07 16:12:48 +00:00
|
|
|
# S3 Static settings
|
2021-06-07 16:15:48 +00:00
|
|
|
STATIC_LOCATION = "static"
|
2024-03-27 21:58:43 +00:00
|
|
|
STATIC_URL = f"{AWS_S3_URL_PROTOCOL}//{AWS_S3_CUSTOM_DOMAIN}/{STATIC_LOCATION}/"
|
2024-03-26 11:41:04 +00:00
|
|
|
STATIC_FULL_URL = STATIC_URL
|
2021-06-07 16:12:48 +00:00
|
|
|
# S3 Media settings
|
2021-06-07 16:15:48 +00:00
|
|
|
MEDIA_LOCATION = "images"
|
2024-03-27 21:58:43 +00:00
|
|
|
MEDIA_URL = f"{AWS_S3_URL_PROTOCOL}//{AWS_S3_CUSTOM_DOMAIN}/{MEDIA_LOCATION}/"
|
2021-06-19 15:09:53 +00:00
|
|
|
MEDIA_FULL_URL = MEDIA_URL
|
2024-03-26 11:41:04 +00:00
|
|
|
# Content Security Policy
|
2024-03-27 21:58:43 +00:00
|
|
|
CSP_DEFAULT_SRC = [
|
|
|
|
"'self'",
|
|
|
|
f"{AWS_S3_URL_PROTOCOL}//{AWS_S3_CUSTOM_DOMAIN}"
|
|
|
|
if AWS_S3_CUSTOM_DOMAIN
|
|
|
|
else None,
|
|
|
|
] + CSP_ADDITIONAL_HOSTS
|
|
|
|
CSP_SCRIPT_SRC = [
|
|
|
|
"'self'",
|
|
|
|
f"{AWS_S3_URL_PROTOCOL}//{AWS_S3_CUSTOM_DOMAIN}"
|
|
|
|
if AWS_S3_CUSTOM_DOMAIN
|
|
|
|
else None,
|
|
|
|
] + CSP_ADDITIONAL_HOSTS
|
2023-03-05 15:05:20 +00:00
|
|
|
elif USE_AZURE:
|
2024-03-26 11:41:04 +00:00
|
|
|
# Azure settings
|
2023-03-05 15:05:20 +00:00
|
|
|
AZURE_ACCOUNT_NAME = env("AZURE_ACCOUNT_NAME")
|
|
|
|
AZURE_ACCOUNT_KEY = env("AZURE_ACCOUNT_KEY")
|
|
|
|
AZURE_CONTAINER = env("AZURE_CONTAINER")
|
|
|
|
AZURE_CUSTOM_DOMAIN = env("AZURE_CUSTOM_DOMAIN")
|
2024-03-29 19:44:01 +00:00
|
|
|
# Storages
|
|
|
|
STORAGES = {
|
|
|
|
"default": {
|
2024-03-29 21:22:33 +00:00
|
|
|
"BACKEND": "storages.backends.azure_storage.AzureStorage",
|
|
|
|
"OPTIONS": {
|
|
|
|
"location": "images",
|
|
|
|
"overwrite_files": False,
|
|
|
|
},
|
2024-03-29 19:44:01 +00:00
|
|
|
},
|
|
|
|
"staticfiles": {
|
2024-03-29 21:22:33 +00:00
|
|
|
"BACKEND": "storages.backends.azure_storage.AzureStorage",
|
|
|
|
"OPTIONS": {
|
|
|
|
"location": "static",
|
|
|
|
},
|
2024-03-29 19:44:01 +00:00
|
|
|
},
|
|
|
|
"exports": {
|
|
|
|
"BACKEND": None, # not implemented yet
|
|
|
|
},
|
|
|
|
}
|
2023-03-05 15:05:20 +00:00
|
|
|
# Azure Static settings
|
|
|
|
STATIC_LOCATION = "static"
|
2023-03-08 19:48:04 +00:00
|
|
|
STATIC_URL = (
|
|
|
|
f"{PROTOCOL}://{AZURE_CUSTOM_DOMAIN}/{AZURE_CONTAINER}/{STATIC_LOCATION}/"
|
|
|
|
)
|
2024-03-26 11:41:04 +00:00
|
|
|
STATIC_FULL_URL = STATIC_URL
|
2023-03-05 15:05:20 +00:00
|
|
|
# Azure Media settings
|
|
|
|
MEDIA_LOCATION = "images"
|
2023-03-08 19:48:04 +00:00
|
|
|
MEDIA_URL = (
|
|
|
|
f"{PROTOCOL}://{AZURE_CUSTOM_DOMAIN}/{AZURE_CONTAINER}/{MEDIA_LOCATION}/"
|
|
|
|
)
|
2023-03-05 15:05:20 +00:00
|
|
|
MEDIA_FULL_URL = MEDIA_URL
|
2024-03-26 11:41:04 +00:00
|
|
|
# Content Security Policy
|
2023-03-05 15:05:20 +00:00
|
|
|
CSP_DEFAULT_SRC = ["'self'", AZURE_CUSTOM_DOMAIN] + CSP_ADDITIONAL_HOSTS
|
|
|
|
CSP_SCRIPT_SRC = ["'self'", AZURE_CUSTOM_DOMAIN] + CSP_ADDITIONAL_HOSTS
|
2021-06-07 16:12:48 +00:00
|
|
|
else:
|
2024-03-29 19:44:01 +00:00
|
|
|
# Storages
|
|
|
|
STORAGES = {
|
|
|
|
"default": {
|
|
|
|
"BACKEND": "django.core.files.storage.FileSystemStorage",
|
|
|
|
},
|
|
|
|
"staticfiles": {
|
|
|
|
"BACKEND": "django.contrib.staticfiles.storage.StaticFilesStorage",
|
|
|
|
},
|
|
|
|
"exports": {
|
2024-03-29 21:22:33 +00:00
|
|
|
"BACKEND": "django.core.files.storage.FileSystemStorage",
|
|
|
|
"OPTIONS": {
|
|
|
|
"location": "exports",
|
|
|
|
},
|
2024-03-29 19:44:01 +00:00
|
|
|
},
|
|
|
|
}
|
2024-03-26 11:41:04 +00:00
|
|
|
# Static settings
|
2021-06-07 16:12:48 +00:00
|
|
|
STATIC_URL = "/static/"
|
2024-04-07 15:19:48 +00:00
|
|
|
STATIC_FULL_URL = BASE_URL + STATIC_URL
|
2024-03-26 11:41:04 +00:00
|
|
|
# Media settings
|
2021-06-07 16:12:48 +00:00
|
|
|
MEDIA_URL = "/images/"
|
2024-04-07 15:19:48 +00:00
|
|
|
MEDIA_FULL_URL = BASE_URL + MEDIA_URL
|
2024-03-26 11:41:04 +00:00
|
|
|
# Content Security Policy
|
2023-02-21 21:02:52 +00:00
|
|
|
CSP_DEFAULT_SRC = ["'self'"] + CSP_ADDITIONAL_HOSTS
|
|
|
|
CSP_SCRIPT_SRC = ["'self'"] + CSP_ADDITIONAL_HOSTS
|
2023-02-01 20:59:10 +00:00
|
|
|
|
2023-02-03 20:03:52 +00:00
|
|
|
CSP_INCLUDE_NONCE_IN = ["script-src"]
|
2022-02-05 02:34:17 +00:00
|
|
|
|
|
|
|
OTEL_EXPORTER_OTLP_ENDPOINT = env("OTEL_EXPORTER_OTLP_ENDPOINT", None)
|
|
|
|
OTEL_EXPORTER_OTLP_HEADERS = env("OTEL_EXPORTER_OTLP_HEADERS", None)
|
|
|
|
OTEL_SERVICE_NAME = env("OTEL_SERVICE_NAME", None)
|
2023-03-16 17:58:09 +00:00
|
|
|
OTEL_EXPORTER_CONSOLE = env.bool("OTEL_EXPORTER_CONSOLE", False)
|
2022-10-14 10:56:38 +00:00
|
|
|
|
2023-02-17 11:36:21 +00:00
|
|
|
TWO_FACTOR_LOGIN_MAX_SECONDS = env.int("TWO_FACTOR_LOGIN_MAX_SECONDS", 60)
|
|
|
|
TWO_FACTOR_LOGIN_VALIDITY_WINDOW = env.int("TWO_FACTOR_LOGIN_VALIDITY_WINDOW", 2)
|
2022-11-19 19:40:36 +00:00
|
|
|
|
2022-11-20 16:57:03 +00:00
|
|
|
HTTP_X_FORWARDED_PROTO = env.bool("SECURE_PROXY_SSL_HEADER", False)
|
2022-11-20 16:47:26 +00:00
|
|
|
if HTTP_X_FORWARDED_PROTO:
|
2022-11-19 16:54:44 +00:00
|
|
|
SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https")
|
2023-01-20 05:32:17 +00:00
|
|
|
|
2023-01-26 06:24:51 +00:00
|
|
|
# Instance Actor for signing GET requests to "secure mode"
|
2023-01-26 06:19:44 +00:00
|
|
|
# Mastodon servers.
|
|
|
|
# Do not change this setting unless you already have an existing
|
|
|
|
# user with the same username - in which case you should change it!
|
2023-01-22 04:59:19 +00:00
|
|
|
INSTANCE_ACTOR_USERNAME = "bookwyrm.instance.actor"
|
2024-01-16 10:32:13 +00:00
|
|
|
|
2024-01-24 19:13:32 +00:00
|
|
|
# We only allow specifying DATA_UPLOAD_MAX_MEMORY_SIZE in MiB from .env
|
|
|
|
# (note the difference in variable names).
|
|
|
|
DATA_UPLOAD_MAX_MEMORY_SIZE = env.int("DATA_UPLOAD_MAX_MEMORY_MiB", 100) << 20
|