settings.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800
  1. """
  2. Django settings for glitchtip project.
  3. Generated by 'django-admin startproject' using Django 3.0rc1.
  4. For more information on this file, see
  5. https://docs.djangoproject.com/en/dev/topics/settings/
  6. For the full list of settings and their values, see
  7. https://docs.djangoproject.com/en/dev/ref/settings/
  8. """
  9. import logging
  10. import os
  11. import re
  12. import sys
  13. import warnings
  14. from datetime import timedelta
  15. import environ
  16. import sentry_sdk
  17. from celery.schedules import crontab
  18. from corsheaders.defaults import default_headers
  19. from django.core.exceptions import ImproperlyConfigured
  20. from sentry_sdk.integrations.django import DjangoIntegration
  21. env = environ.Env(
  22. ALLOWED_HOSTS=(list, ["*"]),
  23. DEFAULT_FILE_STORAGE=(str, None),
  24. AWS_ACCESS_KEY_ID=(str, None),
  25. AWS_SECRET_ACCESS_KEY=(str, None),
  26. AWS_STORAGE_BUCKET_NAME=(str, None),
  27. AWS_S3_ENDPOINT_URL=(str, None),
  28. AWS_LOCATION=(str, ""),
  29. AZURE_ACCOUNT_NAME=(str, None),
  30. AZURE_ACCOUNT_KEY=(str, None),
  31. AZURE_CONTAINER=(str, None),
  32. AZURE_URL_EXPIRATION_SECS=(int, None),
  33. GS_BUCKET_NAME=(str, None),
  34. GS_PROJECT_ID=(str, None),
  35. DEBUG=(bool, False),
  36. DEBUG_TOOLBAR=(bool, False),
  37. STATIC_URL=(str, "/"),
  38. STATICFILES_STORAGE=(
  39. str,
  40. "whitenoise.storage.CompressedManifestStaticFilesStorage",
  41. ),
  42. ENABLE_OBSERVABILITY_API=(bool, False),
  43. )
  44. path = environ.Path()
  45. # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
  46. BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
  47. # Quick-start development settings - unsuitable for production
  48. # See https://docs.djangoproject.com/en/dev/howto/deployment/checklist/
  49. # SECURITY WARNING: keep the secret key used in production secret!
  50. SECRET_KEY = env.str("SECRET_KEY", "change_me")
  51. # SECURITY WARNING: don't run with debug turned on in production!
  52. DEBUG = env("DEBUG")
  53. # Enable only for running end to end testing. Debug must be True to use.
  54. ENABLE_TEST_API = env.bool("ENABLE_TEST_API", False)
  55. if DEBUG is False:
  56. ENABLE_TEST_API = False
  57. ALLOWED_HOSTS = env("ALLOWED_HOSTS")
  58. # Necessary for kubernetes health checks
  59. POD_IP = env.str("POD_IP", default=None)
  60. if POD_IP:
  61. ALLOWED_HOSTS.append(POD_IP)
  62. ENVIRONMENT = env.str("ENVIRONMENT", None)
  63. GLITCHTIP_VERSION = env.str("GLITCHTIP_VERSION", "0.0.0-unknown")
  64. # Used in email and DSN generation. Set to full domain such as https://glitchtip.example.com
  65. default_url = env.str(
  66. "APP_URL", env.str("GLITCHTIP_DOMAIN", "http://localhost:8000")
  67. ) # DigitalOcean App Platform uses APP_URL
  68. GLITCHTIP_URL = env.url("GLITCHTIP_URL", default_url)
  69. if GLITCHTIP_URL.scheme not in ["http", "https"]:
  70. raise ImproperlyConfigured("GLITCHTIP_DOMAIN must start with http or https")
  71. # Events and associated data older than this will be deleted from the database
  72. GLITCHTIP_MAX_EVENT_LIFE_DAYS = env.int("GLITCHTIP_MAX_EVENT_LIFE_DAYS", default=90)
  73. GLITCHTIP_MAX_TRANSACTION_EVENT_LIFE_DAYS = env.int(
  74. "GLITCHTIP_MAX_TRANSACTION_EVENT_LIFE_DAYS", default=GLITCHTIP_MAX_EVENT_LIFE_DAYS
  75. )
  76. # Defaults to twice as long as event life
  77. GLITCHTIP_MAX_FILE_LIFE_DAYS = env.int(
  78. "GLITCHTIP_MAX_EVENT_LIFE_DAYS", default=GLITCHTIP_MAX_EVENT_LIFE_DAYS * 2
  79. )
  80. # Freezes acceptance of new events, for use during db maintenance
  81. MAINTENANCE_EVENT_FREEZE = env.bool("MAINTENANCE_EVENT_FREEZE", False)
  82. # Allows saving of spans on transactions.
  83. ENABLE_PERFORMANCE_SPANS = env.bool("ENABLE_PERFORMANCE_SPANS", True)
  84. # For development purposes only, prints out inbound event store json
  85. EVENT_STORE_DEBUG = env.bool("EVENT_STORE_DEBUG", False)
  86. # Static files (CSS, JavaScript, Images)
  87. # https://docs.djangoproject.com/en/dev/howto/static-files/
  88. STATIC_URL = "/static/"
  89. # GlitchTip can track GlitchTip's own errors.
  90. # If enabling this, use a different server to avoid infinite loops.
  91. def before_send(event, hint):
  92. """Don't log django.DisallowedHost errors in Sentry."""
  93. if "log_record" in hint:
  94. if hint["log_record"].name == "django.security.DisallowedHost":
  95. return None
  96. return event
  97. SENTRY_DSN = env.str("SENTRY_DSN", None)
  98. # Optionally allow a different DSN for the frontend
  99. SENTRY_FRONTEND_DSN = env.str("SENTRY_FRONTEND_DSN", SENTRY_DSN)
  100. # Set traces_sample_rate to 1.0 to capture 100%. Recommended to keep this value low.
  101. SENTRY_TRACES_SAMPLE_RATE = env.float("SENTRY_TRACES_SAMPLE_RATE", 0.1)
  102. # Ignore whitenoise served static routes
  103. def traces_sampler(sampling_context):
  104. if (
  105. sampling_context.get("wsgi_environ", {})
  106. .get("PATH_INFO", "")
  107. .startswith(STATIC_URL)
  108. ):
  109. return 0.0
  110. return SENTRY_TRACES_SAMPLE_RATE
  111. if SENTRY_DSN:
  112. release = "glitchtip@" + GLITCHTIP_VERSION if GLITCHTIP_VERSION else None
  113. sentry_sdk.init(
  114. dsn=SENTRY_DSN,
  115. integrations=[DjangoIntegration()],
  116. before_send=before_send,
  117. release=release,
  118. environment=ENVIRONMENT,
  119. auto_session_tracking=False,
  120. traces_sample_rate=SENTRY_TRACES_SAMPLE_RATE,
  121. traces_sampler=traces_sampler,
  122. )
  123. def show_toolbar(request):
  124. return env("DEBUG_TOOLBAR")
  125. DEBUG_TOOLBAR = env("DEBUG_TOOLBAR")
  126. DEBUG_TOOLBAR_CONFIG = {"SHOW_TOOLBAR_CALLBACK": show_toolbar}
  127. DEBUG_TOOLBAR_PANELS = [
  128. "debug_toolbar.panels.versions.VersionsPanel",
  129. "debug_toolbar.panels.timer.TimerPanel",
  130. "debug_toolbar.panels.settings.SettingsPanel",
  131. "debug_toolbar.panels.headers.HeadersPanel",
  132. "debug_toolbar.panels.request.RequestPanel",
  133. "debug_toolbar.panels.sql.SQLPanel",
  134. ]
  135. # Application definition
  136. INSTALLED_APPS = [
  137. "django_rest_mfa.mfa_admin",
  138. "django.contrib.admin",
  139. "django.contrib.auth",
  140. "django.contrib.contenttypes",
  141. "django.contrib.sessions",
  142. "django.contrib.messages",
  143. "django.contrib.staticfiles",
  144. "django.contrib.sites",
  145. "django.contrib.postgres",
  146. "django_prometheus",
  147. "allauth",
  148. "allauth.account",
  149. "allauth.socialaccount",
  150. "allauth.socialaccount.providers.digitalocean",
  151. "allauth.socialaccount.providers.gitea",
  152. "allauth.socialaccount.providers.github",
  153. "allauth.socialaccount.providers.gitlab",
  154. "allauth.socialaccount.providers.google",
  155. "allauth.socialaccount.providers.microsoft",
  156. "allauth.socialaccount.providers.nextcloud",
  157. "allauth.socialaccount.providers.keycloak",
  158. "allauth.socialaccount.providers.openid_connect",
  159. "anymail",
  160. "corsheaders",
  161. "django_filters",
  162. "django_extensions",
  163. "django_rest_mfa",
  164. ]
  165. if DEBUG_TOOLBAR:
  166. INSTALLED_APPS.append("debug_toolbar")
  167. INSTALLED_APPS += [
  168. "rest_framework",
  169. "drf_yasg",
  170. "dj_rest_auth",
  171. "dj_rest_auth.registration",
  172. "import_export",
  173. "storages",
  174. "glitchtip",
  175. "alerts",
  176. "api_tokens",
  177. "environments",
  178. "files",
  179. "organizations_ext",
  180. "events",
  181. "issues",
  182. "users",
  183. "user_reports",
  184. "glitchtip.importer",
  185. "glitchtip.uptime",
  186. "performance",
  187. "projects",
  188. "teams",
  189. "releases",
  190. "difs",
  191. ]
  192. # Ensure no one uses runsslserver in production
  193. if SECRET_KEY == "change_me" and DEBUG is True:
  194. INSTALLED_APPS += ["sslserver"]
  195. ENABLE_OBSERVABILITY_API = env("ENABLE_OBSERVABILITY_API")
  196. # Workaround https://github.com/korfuri/django-prometheus/issues/34
  197. PROMETHEUS_EXPORT_MIGRATIONS = False
  198. # https://github.com/korfuri/django-prometheus/blob/master/documentation/exports.md#exporting-metrics-in-a-wsgi-application-with-multiple-processes-per-process
  199. if start_port := env.int("METRICS_START_PORT", None):
  200. PROMETHEUS_METRICS_EXPORT_PORT_RANGE = range(
  201. start_port, start_port + env.int("UWSGI_WORKERS", 1)
  202. )
  203. MIDDLEWARE = [
  204. "django.middleware.security.SecurityMiddleware",
  205. "django.contrib.sessions.middleware.SessionMiddleware",
  206. "corsheaders.middleware.CorsMiddleware",
  207. "csp.middleware.CSPMiddleware",
  208. "django.middleware.clickjacking.XFrameOptionsMiddleware",
  209. "whitenoise.middleware.WhiteNoiseMiddleware",
  210. ]
  211. if DEBUG_TOOLBAR:
  212. MIDDLEWARE.append("debug_toolbar.middleware.DebugToolbarMiddleware")
  213. MIDDLEWARE += [
  214. "django.middleware.common.CommonMiddleware",
  215. "django.middleware.csrf.CsrfViewMiddleware",
  216. "django.contrib.auth.middleware.AuthenticationMiddleware",
  217. "django.contrib.messages.middleware.MessageMiddleware",
  218. "django.middleware.clickjacking.XFrameOptionsMiddleware",
  219. "sentry.middleware.proxy.DecompressBodyMiddleware",
  220. "django.middleware.locale.LocaleMiddleware",
  221. ]
  222. if ENABLE_OBSERVABILITY_API:
  223. MIDDLEWARE.insert(0, "django_prometheus.middleware.PrometheusBeforeMiddleware")
  224. MIDDLEWARE.append("django_prometheus.middleware.PrometheusAfterMiddleware")
  225. ROOT_URLCONF = "glitchtip.urls"
  226. TEMPLATES = [
  227. {
  228. "BACKEND": "django.template.backends.django.DjangoTemplates",
  229. "DIRS": [path("dist"), path("templates")],
  230. "APP_DIRS": True,
  231. "OPTIONS": {
  232. "context_processors": [
  233. "django.template.context_processors.debug",
  234. "django.template.context_processors.request",
  235. "django.contrib.auth.context_processors.auth",
  236. "django.contrib.messages.context_processors.messages",
  237. ],
  238. },
  239. },
  240. ]
  241. WSGI_APPLICATION = "glitchtip.wsgi.application"
  242. CORS_ORIGIN_ALLOW_ALL = env.bool("CORS_ORIGIN_ALLOW_ALL", True)
  243. CORS_ORIGIN_WHITELIST = env.tuple("CORS_ORIGIN_WHITELIST", str, default=())
  244. CORS_ALLOW_HEADERS = list(default_headers) + [
  245. "x-sentry-auth",
  246. ]
  247. BILLING_ENABLED = False
  248. if env.str("STRIPE_TEST_PUBLIC_KEY", None) or env.str("STRIPE_LIVE_PUBLIC_KEY", None):
  249. BILLING_ENABLED = True
  250. # Set to chatwoot website token to enable live help widget. Assumes app.chatwoot.com.
  251. CHATWOOT_WEBSITE_TOKEN = env.str("CHATWOOT_WEBSITE_TOKEN", None)
  252. CHATWOOT_IDENTITY_TOKEN = env.str("CHATWOOT_IDENTITY_TOKEN", None)
  253. CSRF_TRUSTED_ORIGINS = env.list("CSRF_TRUSTED_ORIGINS", str, [])
  254. SECURE_BROWSER_XSS_FILTER = True
  255. CSP_DEFAULT_SRC = env.list("CSP_DEFAULT_SRC", str, ["'self'"])
  256. CSP_STYLE_SRC = env.list(
  257. "CSP_STYLE_SRC", str, ["'self'", "'unsafe-inline'", "https://fonts.googleapis.com"]
  258. )
  259. CSP_STYLE_SRC_ELEM = env.list(
  260. "CSP_STYLE_SRC_ELEM",
  261. str,
  262. ["'self'", "'unsafe-inline'", "https://fonts.googleapis.com"],
  263. )
  264. CSP_FONT_SRC = env.list(
  265. "CSP_FONT_SRC", str, ["'self'", "https://fonts.gstatic.com", "data:"]
  266. )
  267. # Redoc requires blob
  268. CSP_WORKER_SRC = env.list("CSP_WORKER_SRC", str, ["'self'", "blob:"])
  269. # Enable Chatwoot only when configured
  270. default_connect_src = ["'self'", "https://*.glitchtip.com"]
  271. if CHATWOOT_WEBSITE_TOKEN:
  272. default_connect_src.append("https://app.chatwoot.com")
  273. CSP_CONNECT_SRC = env.list("CSP_CONNECT_SRC", str, default_connect_src)
  274. # Enable stripe by default only when configured
  275. stripe_domain = "https://js.stripe.com"
  276. default_script_src = ["'self'", "https://*.glitchtip.com"]
  277. default_frame_src = ["'self'"]
  278. if BILLING_ENABLED:
  279. default_script_src.append(stripe_domain)
  280. default_frame_src.append(stripe_domain)
  281. CSP_SCRIPT_SRC = env.list("CSP_SCRIPT_SRC", str, default_script_src)
  282. CSP_IMG_SRC = env.list("CSP_IMG_SRC", str, ["'self'"])
  283. CSP_FRAME_SRC = env.list("CSP_FRAME_SRC", str, default_frame_src)
  284. # Consider tracking CSP reports with GlitchTip itself
  285. CSP_REPORT_URI = env.tuple("CSP_REPORT_URI", str, None)
  286. CSP_REPORT_ONLY = env.bool("CSP_REPORT_ONLY", False)
  287. SECURE_HSTS_SECONDS = env.int("SECURE_HSTS_SECONDS", 0)
  288. SECURE_HSTS_PRELOAD = env.bool("SECURE_HSTS_PRELOAD", False)
  289. SECURE_HSTS_INCLUDE_SUBDOMAINS = env.bool("SECURE_HSTS_INCLUDE_SUBDOMAINS", False)
  290. SESSION_COOKIE_SECURE = env.bool("SESSION_COOKIE_SECURE", False)
  291. SESSION_COOKIE_SAMESITE = env.str("SESSION_COOKIE_SAMESITE", "Lax")
  292. DEFAULT_FROM_EMAIL = env.str("DEFAULT_FROM_EMAIL", "webmaster@localhost")
  293. ANYMAIL_SETTINGS = [
  294. "MAILGUN_API_KEY",
  295. "MAILGUN_SENDER_DOMAIN",
  296. "MAILGUN_API_URL",
  297. "MAILGUN_WEBHOOK_SIGNING_KEY",
  298. "SENDGRID_API_KEY",
  299. "SENDGRID_API_URL",
  300. "POSTMARK_SERVER_TOKEN",
  301. "POSTMARK_API_URL",
  302. "MANDRILL_API_KEY",
  303. "MANDRILL_WEBHOOK_KEY",
  304. "MANDRILL_WEBHOOK_URL",
  305. "MANDRILL_API_URL",
  306. "SENDINBLUE_API_KEY",
  307. "SENDINBLUE_API_URL",
  308. "MAILJET_API_KEY",
  309. "MAILJET_SECRET_KEY",
  310. "MAILJET_API_URL",
  311. "POSTAL_API_KEY",
  312. "POSTAL_API_URL",
  313. "POSTAL_WEBHOOK_KEY",
  314. "SPARKPOST_API_KEY",
  315. "SPARKPOST_API_URL",
  316. "SPARKPOST_TRACK_INITIAL_OPEN_AS_OPENED",
  317. ]
  318. ANYMAIL = {
  319. anymail_var: env.str(anymail_var)
  320. for anymail_var in ANYMAIL_SETTINGS
  321. if anymail_var in os.environ
  322. }
  323. ACCOUNT_EMAIL_SUBJECT_PREFIX = env.str("ACCOUNT_EMAIL_SUBJECT_PREFIX", "")
  324. # Database
  325. # https://docs.djangoproject.com/en/dev/ref/settings/#databases
  326. DATABASES = {
  327. "default": env.db(default="postgres://postgres:postgres@postgres:5432/postgres")
  328. }
  329. # Support setting DATABASES in parts in order to get values from the postgresql helm chart
  330. DATABASE_HOST = env.str("DATABASE_HOST", None)
  331. DATABASE_PASSWORD = env.str("DATABASE_PASSWORD", None)
  332. if DATABASE_HOST and DATABASE_PASSWORD:
  333. DATABASES["default"] = {
  334. "ENGINE": "django.db.backends.postgresql",
  335. "NAME": env.str("DATABASE_NAME", "postgres"),
  336. "USER": env.str("DATABASE_USER", "postgres"),
  337. "PASSWORD": DATABASE_PASSWORD,
  338. "HOST": DATABASE_HOST,
  339. "PORT": env.str("DATABASE_PORT", "5432"),
  340. "CONN_MAX_AGE": env.int("DATABASE_CONN_MAX_AGE", 0),
  341. "CONN_HEALTH_CHECKS": env.bool("DATABASE_CONN_HEALTH_CHECKS", False),
  342. }
  343. DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
  344. # We need to support both url and broken out host to support helm redis chart
  345. REDIS_HOST = env.str("REDIS_HOST", None)
  346. if REDIS_HOST:
  347. REDIS_PORT = env.str("REDIS_PORT", "6379")
  348. REDIS_DATABASE = env.str("REDIS_DATABASE", "0")
  349. REDIS_PASSWORD = env.str("REDIS_PASSWORD", None)
  350. if REDIS_PASSWORD:
  351. REDIS_URL = (
  352. f"redis://:{REDIS_PASSWORD}@{REDIS_HOST}:{REDIS_PORT}/{REDIS_DATABASE}"
  353. )
  354. else:
  355. REDIS_URL = f"redis://{REDIS_HOST}:{REDIS_PORT}/{REDIS_DATABASE}"
  356. else:
  357. REDIS_URL = env.str("REDIS_URL", "redis://redis:6379/0")
  358. CELERY_BROKER_URL = env.str("CELERY_BROKER_URL", REDIS_URL)
  359. CELERY_BROKER_TRANSPORT_OPTIONS = {
  360. "fanout_prefix": True,
  361. "fanout_patterns": True,
  362. }
  363. if CELERY_BROKER_URL.startswith("sentinel"):
  364. CELERY_BROKER_TRANSPORT_OPTIONS["master_name"] = env.str(
  365. "CELERY_BROKER_MASTER_NAME", "mymaster"
  366. )
  367. if socket_timeout := env.int("CELERY_BROKER_SOCKET_TIMEOUT", None):
  368. CELERY_BROKER_TRANSPORT_OPTIONS["socket_timeout"] = socket_timeout
  369. if broker_sentinel_password := env.str("CELERY_BROKER_SENTINEL_KWARGS_PASSWORD", None):
  370. CELERY_BROKER_TRANSPORT_OPTIONS["sentinel_kwargs"] = {
  371. "password": broker_sentinel_password
  372. }
  373. # Time in seconds to debounce some frequently run tasks
  374. TASK_DEBOUNCE_DELAY = env.int("TASK_DEBOUNCE_DELAY", 30)
  375. CELERY_BEAT_SCHEDULE = {
  376. "send-alert-notifications": {
  377. "task": "alerts.tasks.process_event_alerts",
  378. "schedule": 60,
  379. },
  380. "cleanup-old-events": {
  381. "task": "issues.tasks.cleanup_old_events",
  382. "schedule": crontab(hour=6, minute=1),
  383. },
  384. "cleanup-old-transaction-events": {
  385. "task": "performance.tasks.cleanup_old_transaction_events",
  386. "schedule": crontab(hour=6, minute=10),
  387. },
  388. "cleanup-old-monitor-checks": {
  389. "task": "glitchtip.uptime.tasks.cleanup_old_monitor_checks",
  390. "schedule": crontab(hour=6, minute=20),
  391. },
  392. "cleanup-old-files": {
  393. "task": "files.tasks.cleanup_old_files",
  394. "schedule": crontab(hour=6, minute=30),
  395. },
  396. "uptime-dispatch-checks": {
  397. "task": "glitchtip.uptime.tasks.dispatch_checks",
  398. "schedule": timedelta(seconds=30),
  399. },
  400. }
  401. if os.environ.get("CACHE_URL"):
  402. CACHES = {
  403. "default": env.cache(),
  404. }
  405. else: # Default to REDIS when unset
  406. CACHES = {
  407. "default": {
  408. "BACKEND": "django_redis.cache.RedisCache",
  409. "LOCATION": REDIS_URL,
  410. "PARSER_CLASS": "redis.connection.HiredisParser",
  411. }
  412. }
  413. if cache_sentinel_url := env.str("CACHE_SENTINEL_URL", None):
  414. try:
  415. cache_sentinel_host, cache_sentinel_port = cache_sentinel_url.split(":")
  416. SENTINELS = [(cache_sentinel_host, int(cache_sentinel_port))]
  417. except ValueError as err:
  418. raise ImproperlyConfigured(
  419. "Invalid cache redis sentinel url, format is host:port"
  420. ) from err
  421. DJANGO_REDIS_CONNECTION_FACTORY = "django_redis.pool.SentinelConnectionFactory"
  422. CACHES["default"]["OPTIONS"]["SENTINELS"] = SENTINELS
  423. if cache_sentinel_password := env.str("CACHE_SENTINEL_PASSWORD", None):
  424. CACHES["default"]["OPTIONS"]["SENTINEL_KWARGS"] = {
  425. "password": cache_sentinel_password
  426. }
  427. if os.environ.get("SESSION_ENGINE"):
  428. SESSION_ENGINE = env.str("SESSION_ENGINE")
  429. if os.environ.get("SESSION_CACHE_ALIAS"):
  430. SESSION_CACHE_ALIAS = env.str("SESSION_CACHE_ALIAS")
  431. if os.environ.get("SESSION_COOKIE_AGE"):
  432. SESSION_COOKIE_AGE = env.int("SESSION_COOKIE_AGE")
  433. # Password validation
  434. # https://docs.djangoproject.com/en/dev/ref/settings/#auth-password-validators
  435. AUTH_PASSWORD_VALIDATORS = [
  436. {
  437. "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
  438. },
  439. {
  440. "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
  441. },
  442. {
  443. "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
  444. },
  445. {
  446. "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
  447. },
  448. ]
  449. # Internationalization
  450. # https://docs.djangoproject.com/en/dev/topics/i18n/
  451. LANGUAGE_CODE = "en-us"
  452. TIME_ZONE = "UTC"
  453. USE_I18N = True
  454. USE_TZ = True
  455. SITE_ID = 1
  456. if env("DEFAULT_FILE_STORAGE"):
  457. DEFAULT_FILE_STORAGE = env("DEFAULT_FILE_STORAGE")
  458. AWS_ACCESS_KEY_ID = env("AWS_ACCESS_KEY_ID")
  459. AWS_SECRET_ACCESS_KEY = env("AWS_SECRET_ACCESS_KEY")
  460. AWS_STORAGE_BUCKET_NAME = env("AWS_STORAGE_BUCKET_NAME")
  461. AWS_S3_ENDPOINT_URL = env("AWS_S3_ENDPOINT_URL")
  462. AWS_LOCATION = env("AWS_LOCATION")
  463. AZURE_ACCOUNT_NAME = env("AZURE_ACCOUNT_NAME")
  464. AZURE_ACCOUNT_KEY = env("AZURE_ACCOUNT_KEY")
  465. AZURE_CONTAINER = env("AZURE_CONTAINER")
  466. AZURE_URL_EXPIRATION_SECS = env("AZURE_URL_EXPIRATION_SECS")
  467. GS_BUCKET_NAME = env("GS_BUCKET_NAME")
  468. GS_PROJECT_ID = env("GS_PROJECT_ID")
  469. if AWS_S3_ENDPOINT_URL:
  470. MEDIA_URL = env.str(
  471. "MEDIA_URL", "https://%s/%s/" % (AWS_S3_ENDPOINT_URL, AWS_LOCATION)
  472. )
  473. DEFAULT_FILE_STORAGE = "storages.backends.s3boto3.S3Boto3Storage"
  474. else:
  475. MEDIA_URL = "media/"
  476. MEDIA_ROOT = env.str("MEDIA_ROOT", "")
  477. STATICFILES_DIRS = [
  478. "assets",
  479. "dist",
  480. ]
  481. STATIC_ROOT = path("static/")
  482. STATICFILES_STORAGE = env("STATICFILES_STORAGE")
  483. EMAIL_BACKEND = env.str(
  484. "EMAIL_BACKEND", default="django.core.mail.backends.smtp.EmailBackend"
  485. )
  486. if os.getenv("EMAIL_HOST_USER"):
  487. EMAIL_HOST_USER = env.str("EMAIL_HOST_USER")
  488. if os.getenv("EMAIL_HOST_PASSWORD"):
  489. EMAIL_HOST_PASSWORD = env.str("EMAIL_HOST_PASSWORD")
  490. if os.getenv("EMAIL_HOST"):
  491. EMAIL_HOST = env.str("EMAIL_HOST")
  492. if os.getenv("EMAIL_PORT"):
  493. EMAIL_PORT = env.str("EMAIL_PORT")
  494. if os.getenv("EMAIL_USE_TLS"):
  495. EMAIL_USE_TLS = env.str("EMAIL_USE_TLS")
  496. if os.getenv("EMAIL_USE_SSL"):
  497. EMAIL_USE_SSL = env.str("EMAIL_USE_SSL")
  498. if os.getenv("EMAIL_TIMEOUT"):
  499. EMAIL_TIMEOUT = env.str("EMAIL_TIMEOUT")
  500. if os.getenv("EMAIL_FILE_PATH"):
  501. EMAIL_FILE_PATH = env.str("EMAIL_FILE_PATH")
  502. if os.getenv(
  503. "EMAIL_URL"
  504. ): # Careful, this will override most EMAIL_*** settings. Set them all individually, or use EMAIL_URL to set them all at once, but don't do both.
  505. EMAIL_CONFIG = env.email_url("EMAIL_URL")
  506. vars().update(EMAIL_CONFIG)
  507. AUTH_USER_MODEL = "users.User"
  508. ACCOUNT_AUTHENTICATION_METHOD = "email"
  509. ACCOUNT_EMAIL_REQUIRED = True
  510. ACCOUNT_USERNAME_REQUIRED = False
  511. ACCOUNT_USER_MODEL_USERNAME_FIELD = None
  512. ACCOUNT_ADAPTER = "glitchtip.social.MFAAccountAdapter"
  513. SOCIALACCOUNT_ADAPTER = "glitchtip.social.CustomSocialAccountAdapter"
  514. INVITATION_BACKEND = "organizations_ext.invitation_backend.InvitationBackend"
  515. SOCIALACCOUNT_PROVIDERS = {}
  516. if GITLAB_URL := env.url("SOCIALACCOUNT_PROVIDERS_gitlab_GITLAB_URL", None):
  517. SOCIALACCOUNT_PROVIDERS["gitlab"] = {"GITLAB_URL": GITLAB_URL.geturl()}
  518. if GITEA_URL := env.url("SOCIALACCOUNT_PROVIDERS_gitea_GITEA_URL", None):
  519. SOCIALACCOUNT_PROVIDERS["gitea"] = {"GITEA_URL": GITEA_URL.geturl()}
  520. if NEXTCLOUD_URL := env.url("SOCIALACCOUNT_PROVIDERS_nextcloud_SERVER", None):
  521. SOCIALACCOUNT_PROVIDERS["nextcloud"] = {"SERVER": NEXTCLOUD_URL.geturl()}
  522. if KEYCLOAK_URL := env.url("SOCIALACCOUNT_PROVIDERS_keycloak_KEYCLOAK_URL", None):
  523. alt_url_env = env.url("SOCIALACCOUNT_PROVIDERS_keycloak_KEYCLOAK_URL_ALT", None)
  524. if alt_url_env:
  525. alt_url = alt_url_env.geturl()
  526. else:
  527. alt_url = None
  528. SOCIALACCOUNT_PROVIDERS["keycloak"] = {
  529. "KEYCLOAK_URL": KEYCLOAK_URL.geturl(),
  530. "KEYCLOAK_REALM": env.str(
  531. "SOCIALACCOUNT_PROVIDERS_keycloak_KEYCLOAK_REALM", None
  532. ),
  533. "KEYCLOAK_URL_ALT": alt_url,
  534. }
  535. # Parse oidc settings as nested dict in array. Example:
  536. # SOCIALACCOUNT_PROVIDERS_openid_connect_SERVERS_0_id: "g-oidc"
  537. # SOCIALACCOUNT_PROVIDERS_openid_connect_SERVERS_0_server_url: "https://accounts.google.com"
  538. oidc_prefix = "SOCIALACCOUNT_PROVIDERS_openid_connect_SERVERS_"
  539. oidc_pattern = re.compile(r"{prefix}\w+".format(prefix=oidc_prefix))
  540. oidc_servers = {}
  541. for key, value in {
  542. key.replace(oidc_prefix, ""): val
  543. for key, val in os.environ.items()
  544. if oidc_pattern.match(key)
  545. }.items():
  546. number, setting = key.split("_", 1)
  547. if number in oidc_servers:
  548. oidc_servers[number][setting] = value
  549. else:
  550. oidc_servers[number] = {setting: value}
  551. oidc_servers = [x for x in oidc_servers.values()]
  552. SOCIALACCOUNT_PROVIDERS["openid_connect"] = {"SERVERS": oidc_servers}
  553. # Remove in GlitchTip4.0
  554. if "ENABLE_OPEN_USER_REGISTRATION" in os.environ:
  555. warnings.warn(
  556. "ENABLE_OPEN_USER_REGISTRATION is deprecated. Set ENABLE_ORGANIZATION_CREATION instead.",
  557. DeprecationWarning,
  558. )
  559. ENABLE_USER_REGISTRATION = env.bool("ENABLE_USER_REGISTRATION", True)
  560. ENABLE_ORGANIZATION_CREATION = env.bool(
  561. "ENABLE_OPEN_USER_REGISTRATION", env.bool("ENABLE_ORGANIZATION_CREATION", False)
  562. )
  563. REST_AUTH = {
  564. "TOKEN_MODEL": None,
  565. "TOKEN_CREATOR": "users.utils.noop_token_creator",
  566. "REGISTER_PERMISSION_CLASSES": (
  567. "glitchtip.permissions.UserRegistrationPermission",
  568. ),
  569. "REGISTER_SERIALIZER": "users.serializers.RegisterSerializer",
  570. "USER_DETAILS_SERIALIZER": "users.serializers.UserSerializer",
  571. "TOKEN_SERIALIZER": "users.serializers.NoopTokenSerializer",
  572. "PASSWORD_RESET_SERIALIZER": "users.serializers.PasswordSetResetSerializer",
  573. "OLD_PASSWORD_FIELD_ENABLED": True,
  574. }
  575. AUTHENTICATION_BACKENDS = (
  576. # Needed to login by username in Django admin, regardless of `allauth`
  577. "django.contrib.auth.backends.ModelBackend",
  578. # `allauth` specific authentication methods, such as login by e-mail
  579. "allauth.account.auth_backends.AuthenticationBackend",
  580. )
  581. DEFAULT_RENDERER_CLASSES = ("rest_framework.renderers.JSONRenderer",)
  582. if DEBUG:
  583. DEFAULT_RENDERER_CLASSES = DEFAULT_RENDERER_CLASSES + (
  584. "rest_framework.renderers.BrowsableAPIRenderer",
  585. )
  586. REST_FRAMEWORK = {
  587. "DEFAULT_PERMISSION_CLASSES": ["rest_framework.permissions.IsAuthenticated"],
  588. "DEFAULT_PAGINATION_CLASS": "glitchtip.pagination.LinkHeaderPagination",
  589. "PAGE_SIZE": 50,
  590. "ORDERING_PARAM": "sort",
  591. "DEFAULT_FILTER_BACKENDS": ("django_filters.rest_framework.DjangoFilterBackend",),
  592. "DEFAULT_RENDERER_CLASSES": DEFAULT_RENDERER_CLASSES,
  593. "DEFAULT_AUTHENTICATION_CLASSES": [
  594. "rest_framework.authentication.SessionAuthentication",
  595. "glitchtip.authentication.BearerTokenAuthentication",
  596. ],
  597. "DEFAULT_THROTTLE_RATES": {"anon": "100/minute"},
  598. }
  599. DRF_YASG_EXCLUDE_VIEWS = [
  600. "users.views.SocialAccountDisconnectView",
  601. ]
  602. SWAGGER_SETTINGS = {
  603. "DEFAULT_AUTO_SCHEMA_CLASS": "glitchtip.yasg.SquadSwaggerAutoSchema",
  604. }
  605. LOGGING_HANDLER_CLASS = env.str("DJANGO_LOGGING_HANDLER_CLASS", "logging.StreamHandler")
  606. LOGGING = {
  607. "version": 1,
  608. "disable_existing_loggers": False,
  609. "handlers": {
  610. "null": {
  611. "class": "logging.NullHandler",
  612. },
  613. "console": {
  614. "class": LOGGING_HANDLER_CLASS,
  615. },
  616. },
  617. "loggers": {
  618. "django.security.DisallowedHost": {
  619. "handlers": ["null"],
  620. "propagate": False,
  621. },
  622. },
  623. "root": {"handlers": ["console"]},
  624. }
  625. if LOGGING_HANDLER_CLASS is not logging.StreamHandler:
  626. from celery.signals import after_setup_logger, after_setup_task_logger
  627. @after_setup_logger.connect
  628. @after_setup_task_logger.connect
  629. def setup_celery_logging(logger, **kwargs):
  630. from django.utils.module_loading import import_string
  631. handler = import_string(LOGGING_HANDLER_CLASS)
  632. for h in logger.handlers:
  633. logger.removeHandler(h)
  634. logger.addHandler(handler())
  635. def organization_request_callback(request):
  636. raise ImproperlyConfigured(
  637. "Organization request callback required by dj-stripe but not used."
  638. )
  639. # Set to track activity with Plausible
  640. PLAUSIBLE_URL = env.str("PLAUSIBLE_URL", default=None)
  641. PLAUSIBLE_DOMAIN = env.str("PLAUSIBLE_DOMAIN", default=None)
  642. # Is running unit test
  643. TESTING = len(sys.argv) > 1 and sys.argv[1] == "test"
  644. # See https://liberapay.com/GlitchTip/donate - suggested self-host donation is $5/month/user.
  645. # Support plans available. Email info@burkesoftware.com for more info.
  646. I_PAID_FOR_GLITCHTIP = env.bool("I_PAID_FOR_GLITCHTIP", False)
  647. # Max events per month for free tier
  648. BILLING_FREE_TIER_EVENTS = env.int("BILLING_FREE_TIER_EVENTS", 1000)
  649. DJSTRIPE_SUBSCRIBER_MODEL = "organizations_ext.Organization"
  650. DJSTRIPE_SUBSCRIBER_MODEL_REQUEST_CALLBACK = organization_request_callback
  651. DJSTRIPE_USE_NATIVE_JSONFIELD = True
  652. DJSTRIPE_FOREIGN_KEY_TO_FIELD = "djstripe_id"
  653. STRIPE_AUTOMATIC_TAX = env.bool("STRIPE_AUTOMATIC_TAX", False)
  654. STRIPE_LIVE_MODE = env.bool("STRIPE_LIVE_MODE", False)
  655. if BILLING_ENABLED:
  656. I_PAID_FOR_GLITCHTIP = True
  657. INSTALLED_APPS.append("djstripe")
  658. INSTALLED_APPS.append("djstripe_ext")
  659. STRIPE_TEST_PUBLIC_KEY = env.str("STRIPE_TEST_PUBLIC_KEY", None)
  660. STRIPE_TEST_SECRET_KEY = env.str("STRIPE_TEST_SECRET_KEY", None)
  661. STRIPE_LIVE_PUBLIC_KEY = env.str("STRIPE_LIVE_PUBLIC_KEY", None)
  662. STRIPE_LIVE_SECRET_KEY = env.str("STRIPE_LIVE_SECRET_KEY", None)
  663. DJSTRIPE_WEBHOOK_SECRET = env.str("DJSTRIPE_WEBHOOK_SECRET", None)
  664. CELERY_BEAT_SCHEDULE["set-organization-throttle"] = {
  665. "task": "organizations_ext.tasks.set_organization_throttle",
  666. "schedule": crontab(hour=7, minute=1),
  667. }
  668. CELERY_BEAT_SCHEDULE["warn-organization-throttle"] = {
  669. "task": "djstripe_ext.tasks.warn_organization_throttle",
  670. "schedule": crontab(minute=30),
  671. }
  672. elif TESTING:
  673. # Must run tests with djstripe enabled
  674. BILLING_ENABLED = True
  675. INSTALLED_APPS.append("djstripe")
  676. INSTALLED_APPS.append("djstripe_ext")
  677. STRIPE_TEST_PUBLIC_KEY = "fake"
  678. STRIPE_TEST_SECRET_KEY = "sk_test_fake" # nosec
  679. DJSTRIPE_WEBHOOK_SECRET = "whsec_fake" # nosec
  680. logging.disable(logging.WARNING)
  681. CELERY_TASK_ALWAYS_EAGER = env.bool("CELERY_TASK_ALWAYS_EAGER", False)
  682. if TESTING:
  683. CELERY_TASK_ALWAYS_EAGER = True
  684. STATICFILES_STORAGE = None
  685. # https://github.com/evansd/whitenoise/issues/215
  686. warnings.filterwarnings(
  687. "ignore", message="No directory at", module="whitenoise.base"
  688. )
  689. if CELERY_TASK_ALWAYS_EAGER:
  690. CACHES = {
  691. "default": {
  692. "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
  693. }
  694. }
  695. MFA_SERVER_NAME = GLITCHTIP_URL.hostname
  696. FIDO_SERVER_ID = GLITCHTIP_URL.hostname