settings.py 28 KB

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