moviewyrm/bookwyrm/settings.py

357 lines
11 KiB
Python
Raw Normal View History

2021-03-08 16:49:10 +00:00
""" bookwyrm settings and configuration """
2020-01-25 06:32:41 +00:00
import os
from environs import Env
import requests
from django.utils.translation import gettext_lazy as _
# pylint: disable=line-too-long
env = Env()
env.read_env()
2021-03-08 16:49:10 +00:00
DOMAIN = env("DOMAIN")
VERSION = "0.3.4"
RELEASE_API = env(
"RELEASE_API",
2022-02-18 00:28:55 +00:00
"https://api.github.com/repos/bookwyrm-social/bookwyrm/releases/latest",
)
2021-03-08 16:49:10 +00:00
PAGE_LENGTH = env("PAGE_LENGTH", 15)
2021-04-29 17:40:49 +00:00
DEFAULT_LANGUAGE = env("DEFAULT_LANGUAGE", "English")
2020-11-11 18:35:34 +00:00
2022-03-13 20:19:02 +00:00
JS_CACHE = "bc93172a"
2020-12-02 23:19:29 +00:00
# email
EMAIL_BACKEND = env("EMAIL_BACKEND", "django.core.mail.backends.smtp.EmailBackend")
2021-03-08 16:49:10 +00:00
EMAIL_HOST = env("EMAIL_HOST")
EMAIL_PORT = env("EMAIL_PORT", 587)
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")
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, ...)
BASE_DIR = 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"),
]
LANGUAGE_COOKIE_NAME = env.str("LANGUAGE_COOKIE_NAME", "django_language")
2020-01-25 06:32:41 +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-05-25 21:04:28 +00:00
# Preview image
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")
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")
2020-01-25 06:32:41 +00:00
# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
2020-01-25 06:32:41 +00:00
# SECURITY WARNING: keep the secret key used in production secret!
2021-03-08 16:49:10 +00:00
SECRET_KEY = env("SECRET_KEY")
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)
USE_HTTPS = env.bool("USE_HTTPS", not DEBUG)
2020-01-25 06:32:41 +00:00
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",
"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",
"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",
"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",
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()
# 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
#
# 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,
"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-01-10 07:53:23 +00:00
"handlers": {
# 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,
"class": "logging.StreamHandler",
2022-01-10 06:43:43 +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": {
# 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
},
"django.utils.autoreload": {
"level": "INFO",
},
# 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
},
}
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-03-13 04:12:25 +00:00
SASS_PROCESSOR_ENABLED = True
# 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")
REDIS_ACTIVITY_PORT = env("REDIS_ACTIVITY_PORT", 6379)
REDIS_ACTIVITY_PASSWORD = env("REDIS_ACTIVITY_PASSWORD", None)
REDIS_ACTIVITY_DB_INDEX = env("REDIS_ACTIVITY_DB_INDEX", 0)
2020-01-25 06:32:41 +00:00
2021-04-05 04:01:52 +00:00
MAX_STREAM_LENGTH = int(env("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
SEARCH_TIMEOUT = int(env("SEARCH_TIMEOUT", 15))
# timeout for a query to an individual connector
QUERY_TIMEOUT = int(env("QUERY_TIMEOUT", 5))
2022-01-05 16:27:31 +00:00
# Redis cache backend
2022-01-06 19:40:27 +00:00
if env("USE_DUMMY_CACHE", False):
CACHES = {
2022-01-06 19:50:51 +00:00
"default": {
"BACKEND": "django.core.cache.backends.dummy.DummyCache",
2022-01-06 19:40:27 +00:00
}
}
else:
2022-01-05 18:16:49 +00:00
CACHES = {
"default": {
"BACKEND": "django_redis.cache.RedisCache",
"LOCATION": f"redis://:{REDIS_ACTIVITY_PASSWORD}@{REDIS_ACTIVITY_HOST}:{REDIS_ACTIVITY_PORT}/{REDIS_ACTIVITY_DB_INDEX}",
2022-01-05 18:16:49 +00:00
"OPTIONS": {
"CLIENT_CLASS": "django_redis.client.DefaultClient",
},
}
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
# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
2020-01-25 06:32:41 +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", ""),
2021-09-22 15:13:31 +00:00
"PORT": env("PGPORT", 5432),
},
2020-01-25 06:32:41 +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
# 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
# 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")),
2021-10-11 16:23:28 +00:00
("de-de", _("Deutsch (German)")),
2021-10-11 19:17:39 +00:00
("es-es", _("Español (Spanish)")),
2021-11-17 18:02:39 +00:00
("gl-es", _("Galego (Galician)")),
2022-01-08 15:38:14 +00:00
("it-it", _("Italiano (Italian)")),
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)")),
2022-01-08 15:38:14 +00:00
("no-no", _("Norsk (Norwegian)")),
2022-01-04 22:30:41 +00:00
("pt-br", _("Português do Brasil (Brazilian Portuguese)")),
("pt-pt", _("Português Europeu (European Portuguese)")),
2022-02-02 19:43:54 +00:00
("sv-se", _("Svenska (Swedish)")),
2021-10-11 16:23:28 +00:00
("zh-hans", _("简体中文 (Simplified Chinese)")),
("zh-hant", _("繁體中文 (Traditional Chinese)")),
2021-02-28 00:18:24 +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_L10N = True
USE_TZ = True
2021-09-18 04:39:18 +00:00
agent = requests.utils.default_user_agent()
USER_AGENT = f"{agent} (BookWyrm/{VERSION}; +https://{DOMAIN}/)"
2021-06-06 19:12:21 +00:00
# Imagekit generated thumbnails
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"
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/3.2/howto/static-files/
PROJECT_DIR = os.path.dirname(os.path.abspath(__file__))
# Storage
PROTOCOL = "http"
if USE_HTTPS:
PROTOCOL = "https"
2021-06-07 16:15:48 +00:00
USE_S3 = env.bool("USE_S3", False)
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")
AWS_S3_CUSTOM_DOMAIN = env("AWS_S3_CUSTOM_DOMAIN")
2021-08-01 09:47:39 +00:00
AWS_S3_REGION_NAME = env("AWS_S3_REGION_NAME", "")
AWS_S3_ENDPOINT_URL = env("AWS_S3_ENDPOINT_URL")
AWS_DEFAULT_ACL = "public-read"
2021-06-07 16:15:48 +00:00
AWS_S3_OBJECT_PARAMETERS = {"CacheControl": "max-age=86400"}
# S3 Static settings
2021-06-07 16:15:48 +00:00
STATIC_LOCATION = "static"
2021-10-05 15:00:13 +00:00
STATIC_URL = f"{PROTOCOL}://{AWS_S3_CUSTOM_DOMAIN}/{STATIC_LOCATION}/"
2021-06-07 16:15:48 +00:00
STATICFILES_STORAGE = "bookwyrm.storage_backends.StaticStorage"
# S3 Media settings
2021-06-07 16:15:48 +00:00
MEDIA_LOCATION = "images"
2021-10-05 15:00:13 +00:00
MEDIA_URL = f"{PROTOCOL}://{AWS_S3_CUSTOM_DOMAIN}/{MEDIA_LOCATION}/"
MEDIA_FULL_URL = MEDIA_URL
2021-10-05 15:00:13 +00:00
STATIC_FULL_URL = STATIC_URL
2021-06-07 16:15:48 +00:00
DEFAULT_FILE_STORAGE = "bookwyrm.storage_backends.ImagesStorage"
else:
STATIC_URL = "/static/"
MEDIA_URL = "/images/"
2021-09-18 04:39:18 +00:00
MEDIA_FULL_URL = f"{PROTOCOL}://{DOMAIN}{MEDIA_URL}"
2021-10-05 15:00:13 +00:00
STATIC_FULL_URL = f"{PROTOCOL}://{DOMAIN}{STATIC_URL}"
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)