settings.py 28 KB

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