settings.py 26 KB

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