settings.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797
  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 sentry_sdk.integrations.django import DjangoIntegration
  19. env = environ.FileAwareEnv(
  20. ALLOWED_HOSTS=(list, ["*"]),
  21. DEFAULT_FILE_STORAGE=(str, None),
  22. AWS_ACCESS_KEY_ID=(str, None),
  23. AWS_SECRET_ACCESS_KEY=(str, None),
  24. AWS_STORAGE_BUCKET_NAME=(str, None),
  25. AWS_S3_ENDPOINT_URL=(str, None),
  26. AWS_LOCATION=(str, ""),
  27. AZURE_ACCOUNT_NAME=(str, None),
  28. AZURE_ACCOUNT_KEY=(str, None),
  29. AZURE_CONTAINER=(str, None),
  30. AZURE_URL_EXPIRATION_SECS=(int, None),
  31. GS_BUCKET_NAME=(str, None),
  32. GS_PROJECT_ID=(str, None),
  33. DEBUG=(bool, False),
  34. DEBUG_TOOLBAR=(bool, False),
  35. STATIC_URL=(str, "/"),
  36. STATICFILES_STORAGE=(
  37. str,
  38. "whitenoise.storage.CompressedManifestStaticFilesStorage",
  39. ),
  40. ENABLE_OBSERVABILITY_API=(bool, False),
  41. )
  42. path = environ.Path()
  43. # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
  44. BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
  45. # Quick-start development settings - unsuitable for production
  46. # See https://docs.djangoproject.com/en/dev/howto/deployment/checklist/
  47. # SECURITY WARNING: keep the secret key used in production secret!
  48. SECRET_KEY = env.str("SECRET_KEY", "change_me")
  49. # SECURITY WARNING: don't run with debug turned on in production!
  50. DEBUG = env("DEBUG")
  51. # Enable only for running end to end testing. Debug must be True to use.
  52. ENABLE_TEST_API = env.bool("ENABLE_TEST_API", False)
  53. if DEBUG is False:
  54. ENABLE_TEST_API = False
  55. ALLOWED_HOSTS = env("ALLOWED_HOSTS")
  56. # Necessary for kubernetes health checks
  57. POD_IP = env.str("POD_IP", default=None)
  58. if POD_IP:
  59. ALLOWED_HOSTS.append(POD_IP)
  60. ENVIRONMENT = env.str("ENVIRONMENT", None)
  61. GLITCHTIP_VERSION = env.str("GLITCHTIP_VERSION", "0.0.0-unknown")
  62. # Used in email and DSN generation. Set to full domain such as https://glitchtip.example.com
  63. default_url = env.str(
  64. "APP_URL", env.str("GLITCHTIP_DOMAIN", "http://localhost:8000")
  65. ) # DigitalOcean App Platform uses APP_URL
  66. GLITCHTIP_URL = env.url("GLITCHTIP_URL", default_url)
  67. if GLITCHTIP_URL.scheme not in ["http", "https"]:
  68. raise ImproperlyConfigured("GLITCHTIP_DOMAIN must start with http or https")
  69. # Limits size (in bytes) of uncompressed event payloads. Mitigates DOS risk.
  70. GLITCHTIP_MAX_UNZIPPED_PAYLOAD_SIZE = env.int(
  71. "GLITCHTIP_MAX_UNZIPPED_PAYLOAD_SIZE", global_settings.DATA_UPLOAD_MAX_MEMORY_SIZE
  72. )
  73. # Events and associated data older than this will be deleted from the database
  74. GLITCHTIP_MAX_EVENT_LIFE_DAYS = env.int("GLITCHTIP_MAX_EVENT_LIFE_DAYS", default=90)
  75. GLITCHTIP_MAX_UPTIME_CHECK_LIFE_DAYS = env.int(
  76. "GLITCHTIP_MAX_UPTIME_CHECK_LIFE_DAYS", default=GLITCHTIP_MAX_EVENT_LIFE_DAYS
  77. )
  78. GLITCHTIP_MAX_TRANSACTION_EVENT_LIFE_DAYS = env.int(
  79. "GLITCHTIP_MAX_TRANSACTION_EVENT_LIFE_DAYS", default=GLITCHTIP_MAX_EVENT_LIFE_DAYS
  80. )
  81. # Defaults to twice as long as event life
  82. GLITCHTIP_MAX_FILE_LIFE_DAYS = env.int(
  83. "GLITCHTIP_MAX_EVENT_LIFE_DAYS", default=GLITCHTIP_MAX_EVENT_LIFE_DAYS * 2
  84. )
  85. # Freezes acceptance of new events, for use during db maintenance
  86. MAINTENANCE_EVENT_FREEZE = env.bool("MAINTENANCE_EVENT_FREEZE", False)
  87. # Allows saving of spans on transactions.
  88. ENABLE_PERFORMANCE_SPANS = env.bool("ENABLE_PERFORMANCE_SPANS", False)
  89. # For development purposes only, prints out inbound event store json
  90. EVENT_STORE_DEBUG = env.bool("EVENT_STORE_DEBUG", False)
  91. # Static files (CSS, JavaScript, Images)
  92. # https://docs.djangoproject.com/en/dev/howto/static-files/
  93. STATIC_URL = "/static/"
  94. # GlitchTip can track GlitchTip's own errors.
  95. # If enabling this, use a different server to avoid infinite loops.
  96. def before_send(event, hint):
  97. """Don't log django.DisallowedHost errors in Sentry."""
  98. if "log_record" in hint:
  99. if hint["log_record"].name == "django.security.DisallowedHost":
  100. return None
  101. return event
  102. SENTRY_DSN = env.str("SENTRY_DSN", None)
  103. # Optionally allow a different DSN for the frontend
  104. SENTRY_FRONTEND_DSN = env.str("SENTRY_FRONTEND_DSN", SENTRY_DSN)
  105. # Set traces_sample_rate to 1.0 to capture 100%. Recommended to keep this value low.
  106. SENTRY_TRACES_SAMPLE_RATE = env.float("SENTRY_TRACES_SAMPLE_RATE", 0.1)
  107. # Ignore whitenoise served static routes
  108. def traces_sampler(sampling_context):
  109. if (
  110. sampling_context.get("wsgi_environ", {})
  111. .get("PATH_INFO", "")
  112. .startswith(STATIC_URL)
  113. ):
  114. return 0.0
  115. return SENTRY_TRACES_SAMPLE_RATE
  116. if SENTRY_DSN:
  117. release = "glitchtip@" + GLITCHTIP_VERSION if GLITCHTIP_VERSION else None
  118. sentry_sdk.init(
  119. dsn=SENTRY_DSN,
  120. integrations=[DjangoIntegration()],
  121. before_send=before_send,
  122. release=release,
  123. environment=ENVIRONMENT,
  124. auto_session_tracking=False,
  125. traces_sample_rate=SENTRY_TRACES_SAMPLE_RATE,
  126. traces_sampler=traces_sampler,
  127. )
  128. def show_toolbar(request):
  129. return env("DEBUG_TOOLBAR")
  130. DEBUG_TOOLBAR = env("DEBUG_TOOLBAR")
  131. DEBUG_TOOLBAR_CONFIG = {"SHOW_TOOLBAR_CALLBACK": show_toolbar}
  132. DEBUG_TOOLBAR_PANELS = [
  133. "debug_toolbar.panels.versions.VersionsPanel",
  134. "debug_toolbar.panels.timer.TimerPanel",
  135. "debug_toolbar.panels.settings.SettingsPanel",
  136. "debug_toolbar.panels.headers.HeadersPanel",
  137. "debug_toolbar.panels.request.RequestPanel",
  138. "debug_toolbar.panels.sql.SQLPanel",
  139. ]
  140. # Application definition
  141. # Conditionally load to workaround unnecessary memory usage in celery/beat
  142. WEB_INSTALLED_APPS = [
  143. "django_rest_mfa.mfa_admin",
  144. "django.contrib.admin",
  145. "django.contrib.sessions",
  146. "django.contrib.messages",
  147. "django.contrib.staticfiles",
  148. "django_filters",
  149. "rest_framework",
  150. ]
  151. INSTALLED_APPS = [
  152. "django.contrib.auth",
  153. "django.contrib.contenttypes",
  154. "django.contrib.postgres",
  155. "django_prometheus",
  156. "allauth",
  157. "allauth.account",
  158. "allauth.socialaccount",
  159. "allauth.socialaccount.providers.digitalocean",
  160. "allauth.socialaccount.providers.gitea",
  161. "allauth.socialaccount.providers.github",
  162. "allauth.socialaccount.providers.gitlab",
  163. "allauth.socialaccount.providers.google",
  164. "allauth.socialaccount.providers.microsoft",
  165. "allauth.socialaccount.providers.nextcloud",
  166. "allauth.socialaccount.providers.openid_connect",
  167. "anymail",
  168. "corsheaders",
  169. "django_extensions",
  170. "django_rest_mfa",
  171. ]
  172. if DEBUG_TOOLBAR:
  173. INSTALLED_APPS.append("debug_toolbar")
  174. INSTALLED_APPS += [
  175. "drf_yasg",
  176. "dj_rest_auth",
  177. "dj_rest_auth.registration",
  178. "import_export",
  179. "storages",
  180. "glitchtip",
  181. "alerts",
  182. "api_tokens",
  183. "environments",
  184. "files",
  185. "organizations_ext",
  186. "events",
  187. "issues",
  188. "users",
  189. "user_reports",
  190. "glitchtip.importer",
  191. "glitchtip.uptime",
  192. "performance",
  193. "projects",
  194. "teams",
  195. "releases",
  196. "difs",
  197. ]
  198. IS_CELERY = env.bool("IS_CELERY", False)
  199. if not IS_CELERY:
  200. INSTALLED_APPS = WEB_INSTALLED_APPS + INSTALLED_APPS
  201. # Ensure no one uses runsslserver in production
  202. if SECRET_KEY == "change_me" and DEBUG is True:
  203. INSTALLED_APPS += ["sslserver"]
  204. ENABLE_OBSERVABILITY_API = env("ENABLE_OBSERVABILITY_API")
  205. # Workaround https://github.com/korfuri/django-prometheus/issues/34
  206. PROMETHEUS_EXPORT_MIGRATIONS = False
  207. # https://github.com/korfuri/django-prometheus/blob/master/documentation/exports.md#exporting-metrics-in-a-wsgi-application-with-multiple-processes-per-process
  208. if start_port := env.int("METRICS_START_PORT", None):
  209. PROMETHEUS_METRICS_EXPORT_PORT_RANGE = range(
  210. start_port, start_port + env.int("UWSGI_WORKERS", 1)
  211. )
  212. MIDDLEWARE = [
  213. "django.middleware.security.SecurityMiddleware",
  214. "django.contrib.sessions.middleware.SessionMiddleware",
  215. "corsheaders.middleware.CorsMiddleware",
  216. "csp.middleware.CSPMiddleware",
  217. "django.middleware.clickjacking.XFrameOptionsMiddleware",
  218. "whitenoise.middleware.WhiteNoiseMiddleware",
  219. ]
  220. if DEBUG_TOOLBAR:
  221. MIDDLEWARE.append("debug_toolbar.middleware.DebugToolbarMiddleware")
  222. MIDDLEWARE += [
  223. "django.middleware.common.CommonMiddleware",
  224. "django.middleware.csrf.CsrfViewMiddleware",
  225. "django.contrib.auth.middleware.AuthenticationMiddleware",
  226. "django.contrib.messages.middleware.MessageMiddleware",
  227. "django.middleware.clickjacking.XFrameOptionsMiddleware",
  228. "sentry.middleware.proxy.DecompressBodyMiddleware",
  229. "django.middleware.locale.LocaleMiddleware",
  230. "allauth.account.middleware.AccountMiddleware",
  231. ]
  232. if ENABLE_OBSERVABILITY_API:
  233. MIDDLEWARE.insert(0, "django_prometheus.middleware.PrometheusBeforeMiddleware")
  234. MIDDLEWARE.append("django_prometheus.middleware.PrometheusAfterMiddleware")
  235. ROOT_URLCONF = "glitchtip.urls"
  236. TEMPLATES = [
  237. {
  238. "BACKEND": "django.template.backends.django.DjangoTemplates",
  239. "DIRS": [path("dist"), path("templates")],
  240. "APP_DIRS": True,
  241. "OPTIONS": {
  242. "context_processors": [
  243. "django.template.context_processors.debug",
  244. "django.template.context_processors.request",
  245. "django.contrib.auth.context_processors.auth",
  246. "django.contrib.messages.context_processors.messages",
  247. ],
  248. },
  249. },
  250. ]
  251. WSGI_APPLICATION = "glitchtip.wsgi.application"
  252. CORS_ORIGIN_ALLOW_ALL = env.bool("CORS_ORIGIN_ALLOW_ALL", True)
  253. CORS_ORIGIN_WHITELIST = env.tuple("CORS_ORIGIN_WHITELIST", str, default=())
  254. CORS_ALLOW_HEADERS = list(default_headers) + [
  255. "x-sentry-auth",
  256. ]
  257. BILLING_ENABLED = False
  258. if env.str("STRIPE_TEST_PUBLIC_KEY", None) or env.str("STRIPE_LIVE_PUBLIC_KEY", None):
  259. BILLING_ENABLED = True
  260. # Set to chatwoot website token to enable live help widget. Assumes app.chatwoot.com.
  261. CHATWOOT_WEBSITE_TOKEN = env.str("CHATWOOT_WEBSITE_TOKEN", None)
  262. CHATWOOT_IDENTITY_TOKEN = env.str("CHATWOOT_IDENTITY_TOKEN", None)
  263. CSRF_TRUSTED_ORIGINS = env.list("CSRF_TRUSTED_ORIGINS", str, [])
  264. SECURE_BROWSER_XSS_FILTER = True
  265. CSP_DEFAULT_SRC = env.list("CSP_DEFAULT_SRC", str, ["'self'"])
  266. CSP_STYLE_SRC = env.list(
  267. "CSP_STYLE_SRC", str, ["'self'", "'unsafe-inline'", "https://fonts.googleapis.com"]
  268. )
  269. CSP_STYLE_SRC_ELEM = env.list(
  270. "CSP_STYLE_SRC_ELEM",
  271. str,
  272. ["'self'", "'unsafe-inline'", "https://fonts.googleapis.com"],
  273. )
  274. CSP_FONT_SRC = env.list(
  275. "CSP_FONT_SRC", str, ["'self'", "https://fonts.gstatic.com", "data:"]
  276. )
  277. # Redoc requires blob
  278. CSP_WORKER_SRC = env.list("CSP_WORKER_SRC", str, ["'self'", "blob:"])
  279. # Enable Chatwoot only when configured
  280. default_connect_src = ["'self'", "https://*.glitchtip.com"]
  281. if CHATWOOT_WEBSITE_TOKEN:
  282. default_connect_src.append("https://app.chatwoot.com")
  283. CSP_CONNECT_SRC = env.list("CSP_CONNECT_SRC", str, default_connect_src)
  284. # Enable stripe by default only when configured
  285. stripe_domain = "https://js.stripe.com"
  286. default_script_src = ["'self'", "https://*.glitchtip.com"]
  287. default_frame_src = ["'self'"]
  288. if BILLING_ENABLED:
  289. default_script_src.append(stripe_domain)
  290. default_frame_src.append(stripe_domain)
  291. CSP_SCRIPT_SRC = env.list("CSP_SCRIPT_SRC", str, default_script_src)
  292. CSP_IMG_SRC = env.list("CSP_IMG_SRC", str, ["'self'"])
  293. CSP_FRAME_SRC = env.list("CSP_FRAME_SRC", str, default_frame_src)
  294. # Consider tracking CSP reports with GlitchTip itself
  295. CSP_REPORT_URI = env.tuple("CSP_REPORT_URI", str, None)
  296. CSP_REPORT_ONLY = env.bool("CSP_REPORT_ONLY", False)
  297. SECURE_HSTS_SECONDS = env.int("SECURE_HSTS_SECONDS", 0)
  298. SECURE_HSTS_PRELOAD = env.bool("SECURE_HSTS_PRELOAD", False)
  299. SECURE_HSTS_INCLUDE_SUBDOMAINS = env.bool("SECURE_HSTS_INCLUDE_SUBDOMAINS", False)
  300. SESSION_COOKIE_SECURE = env.bool("SESSION_COOKIE_SECURE", False)
  301. SESSION_COOKIE_SAMESITE = env.str("SESSION_COOKIE_SAMESITE", "Lax")
  302. DEFAULT_FROM_EMAIL = env.str("DEFAULT_FROM_EMAIL", "webmaster@localhost")
  303. ANYMAIL_SETTINGS = [
  304. "MAILGUN_API_KEY",
  305. "MAILGUN_SENDER_DOMAIN",
  306. "MAILGUN_API_URL",
  307. "MAILGUN_WEBHOOK_SIGNING_KEY",
  308. "SENDGRID_API_KEY",
  309. "SENDGRID_API_URL",
  310. "POSTMARK_SERVER_TOKEN",
  311. "POSTMARK_API_URL",
  312. "MANDRILL_API_KEY",
  313. "MANDRILL_WEBHOOK_KEY",
  314. "MANDRILL_WEBHOOK_URL",
  315. "MANDRILL_API_URL",
  316. "SENDINBLUE_API_KEY",
  317. "SENDINBLUE_API_URL",
  318. "MAILJET_API_KEY",
  319. "MAILJET_SECRET_KEY",
  320. "MAILJET_API_URL",
  321. "POSTAL_API_KEY",
  322. "POSTAL_API_URL",
  323. "POSTAL_WEBHOOK_KEY",
  324. "SPARKPOST_API_KEY",
  325. "SPARKPOST_API_URL",
  326. "SPARKPOST_TRACK_INITIAL_OPEN_AS_OPENED",
  327. ]
  328. ANYMAIL = {
  329. anymail_var: env.str(anymail_var)
  330. for anymail_var in ANYMAIL_SETTINGS
  331. if anymail_var in os.environ
  332. }
  333. ACCOUNT_EMAIL_SUBJECT_PREFIX = env.str("ACCOUNT_EMAIL_SUBJECT_PREFIX", "")
  334. # Database
  335. # https://docs.djangoproject.com/en/dev/ref/settings/#databases
  336. DATABASES = {
  337. "default": env.db(default="postgres://postgres:postgres@postgres:5432/postgres")
  338. }
  339. # Support setting DATABASES in parts in order to get values from the postgresql helm chart
  340. DATABASE_HOST = env.str("DATABASE_HOST", None)
  341. DATABASE_PASSWORD = env.str("DATABASE_PASSWORD", None)
  342. if DATABASE_HOST and DATABASE_PASSWORD:
  343. DATABASES["default"] = {
  344. "ENGINE": "django.db.backends.postgresql",
  345. "NAME": env.str("DATABASE_NAME", "postgres"),
  346. "USER": env.str("DATABASE_USER", "postgres"),
  347. "PASSWORD": DATABASE_PASSWORD,
  348. "HOST": DATABASE_HOST,
  349. "PORT": env.str("DATABASE_PORT", "5432"),
  350. "CONN_MAX_AGE": env.int("DATABASE_CONN_MAX_AGE", 0),
  351. "CONN_HEALTH_CHECKS": env.bool("DATABASE_CONN_HEALTH_CHECKS", False),
  352. }
  353. DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
  354. # We need to support both url and broken out host to support helm redis chart
  355. REDIS_HOST = env.str("REDIS_HOST", None)
  356. if REDIS_HOST:
  357. REDIS_PORT = env.str("REDIS_PORT", "6379")
  358. REDIS_DATABASE = env.str("REDIS_DATABASE", "0")
  359. REDIS_PASSWORD = env.str("REDIS_PASSWORD", None)
  360. if REDIS_PASSWORD:
  361. REDIS_URL = (
  362. f"redis://:{REDIS_PASSWORD}@{REDIS_HOST}:{REDIS_PORT}/{REDIS_DATABASE}"
  363. )
  364. else:
  365. REDIS_URL = f"redis://{REDIS_HOST}:{REDIS_PORT}/{REDIS_DATABASE}"
  366. else:
  367. REDIS_URL = env.str("REDIS_URL", "redis://redis:6379/0")
  368. REDIS_RETRY = env.bool("REDIS_RETRY", True)
  369. REDIS_MAX_CONNECTIONS = env.int("REDIS_MAX_CONNECTIONS", 100)
  370. CELERY_BROKER_URL = env.str("CELERY_BROKER_URL", REDIS_URL)
  371. CELERY_BROKER_TRANSPORT_OPTIONS = {
  372. "fanout_prefix": True,
  373. "fanout_patterns": True,
  374. "retry_on_timeout": REDIS_RETRY,
  375. "max_connections": REDIS_MAX_CONNECTIONS,
  376. }
  377. CELERY_REDIS_RETRY_ON_TIMEOUT = REDIS_RETRY
  378. CELERY_REDIS_MAX_CONNECTIONS = REDIS_MAX_CONNECTIONS
  379. if CELERY_BROKER_URL.startswith("sentinel"):
  380. CELERY_BROKER_TRANSPORT_OPTIONS["master_name"] = env.str(
  381. "CELERY_BROKER_MASTER_NAME", "mymaster"
  382. )
  383. if socket_timeout := env.int("CELERY_BROKER_SOCKET_TIMEOUT", None):
  384. CELERY_BROKER_TRANSPORT_OPTIONS["socket_timeout"] = socket_timeout
  385. if broker_sentinel_password := env.str("CELERY_BROKER_SENTINEL_KWARGS_PASSWORD", None):
  386. CELERY_BROKER_TRANSPORT_OPTIONS["sentinel_kwargs"] = {
  387. "password": broker_sentinel_password
  388. }
  389. # Time in seconds to debounce some frequently run tasks
  390. TASK_DEBOUNCE_DELAY = env.int("TASK_DEBOUNCE_DELAY", 30)
  391. UPTIME_CHECK_INTERVAL = 10
  392. CELERY_BEAT_SCHEDULE = {
  393. "send-alert-notifications": {
  394. "task": "alerts.tasks.process_event_alerts",
  395. "schedule": 60,
  396. },
  397. "cleanup-old-events": {
  398. "task": "issues.tasks.cleanup_old_events",
  399. "schedule": crontab(hour=5, minute=0),
  400. },
  401. "reindex-issues-model": {
  402. "task": "issues.tasks.reindex_issues_model",
  403. "schedule": crontab(hour=5, minute=30),
  404. },
  405. "cleanup-old-transaction-events": {
  406. "task": "performance.tasks.cleanup_old_transaction_events",
  407. "schedule": crontab(hour=6, minute=0),
  408. },
  409. "cleanup-old-monitor-checks": {
  410. "task": "glitchtip.uptime.tasks.cleanup_old_monitor_checks",
  411. "schedule": crontab(hour=6, minute=30),
  412. },
  413. "cleanup-old-files": {
  414. "task": "files.tasks.cleanup_old_files",
  415. "schedule": crontab(hour=7, minute=0),
  416. },
  417. "uptime-dispatch-checks": {
  418. "task": "glitchtip.uptime.tasks.dispatch_checks",
  419. "schedule": UPTIME_CHECK_INTERVAL,
  420. },
  421. }
  422. # Maximum number of issues send in a single alert payload
  423. MAX_ISSUES_PER_ALERT = env.int("MAX_ISSUES_PER_ALERT", 3)
  424. if os.environ.get("CACHE_URL"):
  425. CACHES = {
  426. "default": env.cache(),
  427. }
  428. else: # Default to REDIS when unset
  429. CACHES = {
  430. "default": {
  431. "BACKEND": "django_redis.cache.RedisCache",
  432. "LOCATION": REDIS_URL,
  433. "PARSER_CLASS": "redis.connection.HiredisParser",
  434. "OPTIONS": {
  435. "CONNECTION_POOL_KWARGS": {
  436. "retry_on_timeout": REDIS_RETRY,
  437. "max_connections": REDIS_MAX_CONNECTIONS,
  438. }
  439. },
  440. }
  441. }
  442. if cache_sentinel_url := env.str("CACHE_SENTINEL_URL", None):
  443. try:
  444. cache_sentinel_host, cache_sentinel_port = cache_sentinel_url.split(":")
  445. SENTINELS = [(cache_sentinel_host, int(cache_sentinel_port))]
  446. except ValueError as err:
  447. raise ImproperlyConfigured(
  448. "Invalid cache redis sentinel url, format is host:port"
  449. ) from err
  450. DJANGO_REDIS_CONNECTION_FACTORY = "django_redis.pool.SentinelConnectionFactory"
  451. CACHES["default"]["OPTIONS"]["SENTINELS"] = SENTINELS
  452. if cache_sentinel_password := env.str("CACHE_SENTINEL_PASSWORD", None):
  453. CACHES["default"]["OPTIONS"]["SENTINEL_KWARGS"] = {
  454. "password": cache_sentinel_password
  455. }
  456. if os.environ.get("SESSION_ENGINE"):
  457. SESSION_ENGINE = env.str("SESSION_ENGINE")
  458. if os.environ.get("SESSION_CACHE_ALIAS"):
  459. SESSION_CACHE_ALIAS = env.str("SESSION_CACHE_ALIAS")
  460. if os.environ.get("SESSION_COOKIE_AGE"):
  461. SESSION_COOKIE_AGE = env.int("SESSION_COOKIE_AGE")
  462. # Password validation
  463. # https://docs.djangoproject.com/en/dev/ref/settings/#auth-password-validators
  464. AUTH_PASSWORD_VALIDATORS = [
  465. {
  466. "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
  467. },
  468. {
  469. "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
  470. },
  471. {
  472. "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
  473. },
  474. {
  475. "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
  476. },
  477. ]
  478. # Internationalization
  479. # https://docs.djangoproject.com/en/dev/topics/i18n/
  480. LANGUAGE_CODE = "en-us"
  481. TIME_ZONE = "UTC"
  482. USE_I18N = True
  483. USE_TZ = True
  484. if env("DEFAULT_FILE_STORAGE"):
  485. DEFAULT_FILE_STORAGE = env("DEFAULT_FILE_STORAGE")
  486. AWS_ACCESS_KEY_ID = env("AWS_ACCESS_KEY_ID")
  487. AWS_SECRET_ACCESS_KEY = env("AWS_SECRET_ACCESS_KEY")
  488. AWS_STORAGE_BUCKET_NAME = env("AWS_STORAGE_BUCKET_NAME")
  489. AWS_S3_ENDPOINT_URL = env("AWS_S3_ENDPOINT_URL")
  490. AWS_LOCATION = env("AWS_LOCATION")
  491. AZURE_ACCOUNT_NAME = env("AZURE_ACCOUNT_NAME")
  492. AZURE_ACCOUNT_KEY = env("AZURE_ACCOUNT_KEY")
  493. AZURE_CONTAINER = env("AZURE_CONTAINER")
  494. AZURE_URL_EXPIRATION_SECS = env("AZURE_URL_EXPIRATION_SECS")
  495. GS_BUCKET_NAME = env("GS_BUCKET_NAME")
  496. GS_PROJECT_ID = env("GS_PROJECT_ID")
  497. if AWS_S3_ENDPOINT_URL:
  498. MEDIA_URL = env.str(
  499. "MEDIA_URL", "https://%s/%s/" % (AWS_S3_ENDPOINT_URL, AWS_LOCATION)
  500. )
  501. DEFAULT_FILE_STORAGE = "storages.backends.s3boto3.S3Boto3Storage"
  502. else:
  503. MEDIA_URL = "media/"
  504. MEDIA_ROOT = env.str("MEDIA_ROOT", "")
  505. STATICFILES_DIRS = [
  506. "assets",
  507. "dist",
  508. ]
  509. STATIC_ROOT = path("static/")
  510. STATICFILES_STORAGE = env("STATICFILES_STORAGE")
  511. EMAIL_BACKEND = env.str(
  512. "EMAIL_BACKEND", default="django.core.mail.backends.smtp.EmailBackend"
  513. )
  514. if os.getenv("EMAIL_HOST_USER"):
  515. EMAIL_HOST_USER = env.str("EMAIL_HOST_USER")
  516. if os.getenv("EMAIL_HOST_PASSWORD"):
  517. EMAIL_HOST_PASSWORD = env.str("EMAIL_HOST_PASSWORD")
  518. if os.getenv("EMAIL_HOST"):
  519. EMAIL_HOST = env.str("EMAIL_HOST")
  520. if os.getenv("EMAIL_PORT"):
  521. EMAIL_PORT = env.str("EMAIL_PORT")
  522. if os.getenv("EMAIL_USE_TLS"):
  523. EMAIL_USE_TLS = env.str("EMAIL_USE_TLS")
  524. if os.getenv("EMAIL_USE_SSL"):
  525. EMAIL_USE_SSL = env.str("EMAIL_USE_SSL")
  526. if os.getenv("EMAIL_TIMEOUT"):
  527. EMAIL_TIMEOUT = env.str("EMAIL_TIMEOUT")
  528. if os.getenv("EMAIL_FILE_PATH"):
  529. EMAIL_FILE_PATH = env.str("EMAIL_FILE_PATH")
  530. if os.getenv(
  531. "EMAIL_URL"
  532. ): # 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.
  533. EMAIL_CONFIG = env.email_url("EMAIL_URL")
  534. vars().update(EMAIL_CONFIG)
  535. AUTH_USER_MODEL = "users.User"
  536. ACCOUNT_AUTHENTICATION_METHOD = "email"
  537. ACCOUNT_EMAIL_REQUIRED = True
  538. ACCOUNT_USERNAME_REQUIRED = False
  539. ACCOUNT_USER_MODEL_USERNAME_FIELD = None
  540. ACCOUNT_ADAPTER = "glitchtip.social.MFAAccountAdapter"
  541. SOCIALACCOUNT_ADAPTER = "glitchtip.social.CustomSocialAccountAdapter"
  542. INVITATION_BACKEND = "organizations_ext.invitation_backend.InvitationBackend"
  543. SOCIALACCOUNT_PROVIDERS = {}
  544. if GITLAB_URL := env.url("SOCIALACCOUNT_PROVIDERS_gitlab_GITLAB_URL", None):
  545. SOCIALACCOUNT_PROVIDERS["gitlab"] = {"GITLAB_URL": GITLAB_URL.geturl()}
  546. if GITEA_URL := env.url("SOCIALACCOUNT_PROVIDERS_gitea_GITEA_URL", None):
  547. SOCIALACCOUNT_PROVIDERS["gitea"] = {"GITEA_URL": GITEA_URL.geturl()}
  548. if NEXTCLOUD_URL := env.url("SOCIALACCOUNT_PROVIDERS_nextcloud_SERVER", None):
  549. SOCIALACCOUNT_PROVIDERS["nextcloud"] = {"SERVER": NEXTCLOUD_URL.geturl()}
  550. # Removed keycloak, use oidc https://django-allauth.readthedocs.io/en/latest/socialaccount/providers/keycloak.html
  551. if MICROSOFT_TENANT := env.str("SOCIALACCOUNT_PROVIDERS_microsoft_TENANT", None):
  552. SOCIALACCOUNT_PROVIDERS["microsoft"] = {"TENANT": MICROSOFT_TENANT}
  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 = global_settings.STATICFILES_STORAGE
  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