-
Notifications
You must be signed in to change notification settings - Fork 363
/
common.py
1267 lines (1084 loc) · 47 KB
/
common.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Django settings for app project.
Generated by 'django-admin startproject' using Django 1.9.
For more information on this file, see
https://docs.djangoproject.com/en/1.9/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/1.9/ref/settings/
"""
import importlib
import json
import os
import sys
import warnings
from datetime import datetime, timedelta
from importlib import reload
import dj_database_url
import pytz
import requests
from corsheaders.defaults import default_headers
from django.core.exceptions import ImproperlyConfigured
from django.core.management.utils import get_random_secret_key
from environs import Env
from task_processor.task_run_method import TaskRunMethod
from app.routers import ReplicaReadStrategy
env = Env()
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
ENV = env("ENVIRONMENT", default="local")
if ENV not in ("local", "dev", "staging", "production"):
warnings.warn(
"ENVIRONMENT env variable must be one of local, dev, staging, production"
)
DEBUG = env.bool("DEBUG", default=False)
ADMINS = []
MANAGERS = []
# Enables the sending of telemetry data to the central Flagsmith API for usage tracking
ENABLE_TELEMETRY = env.bool("ENABLE_TELEMETRY", default=True)
# Enables gzip compression
ENABLE_GZIP_COMPRESSION = env.bool("ENABLE_GZIP_COMPRESSION", default=False)
SECRET_KEY = env("DJANGO_SECRET_KEY", default=get_random_secret_key())
HOSTED_SEATS_LIMIT = env.int("HOSTED_SEATS_LIMIT", default=0)
MAX_PROJECTS_IN_FREE_PLAN = 1
ALLOWED_HOSTS = env.list("DJANGO_ALLOWED_HOSTS", default=[])
USE_X_FORWARDED_HOST = env.bool("USE_X_FORWARDED_HOST", default=False)
CSRF_TRUSTED_ORIGINS = env.list("DJANGO_CSRF_TRUSTED_ORIGINS", default=[])
INTERNAL_IPS = ["127.0.0.1"]
# In order to run a load balanced solution, we need to whitelist the internal ip
try:
internal_ip = requests.get("http://instance-data/latest/meta-data/local-ipv4").text
except requests.exceptions.ConnectionError:
pass
else:
ALLOWED_HOSTS.append(internal_ip)
del requests
if sys.version[0] == "2":
reload(sys)
sys.setdefaultencoding("utf-8")
# Application definition
INSTALLED_APPS = [
"core.custom_admin.apps.CustomAdminConfig",
"django.contrib.auth",
"django.contrib.contenttypes",
"django.contrib.sessions",
"django.contrib.messages",
"django.contrib.staticfiles",
"django.contrib.humanize",
"rest_framework",
"rest_framework.authtoken",
# Used for managing api keys
"rest_framework_api_key",
"rest_framework_simplejwt.token_blacklist",
"djoser",
"django.contrib.sites",
"custom_auth",
"admin_sso",
"api",
"core",
"corsheaders",
"users",
"organisations",
"organisations.invites",
"organisations.permissions",
"projects",
"sales_dashboard",
"edge_api",
"environments",
"environments.permissions",
"environments.identities",
"environments.identities.traits",
"features",
"features.import_export",
"features.multivariate",
"features.versioning",
"features.workflows.core",
"segments",
"app",
"e2etests",
"simple_history",
"drf_yasg",
"audit",
"permissions",
"projects.tags",
"api_keys",
"features.feature_external_resources",
# 2FA
"custom_auth.mfa.trench",
# health check plugins
"health_check",
"health_check.db",
"health_check.contrib.migrations",
# Used for ordering models (e.g. FeatureSegment)
"ordered_model",
# Third party integrations
"integrations.datadog",
"integrations.amplitude",
"integrations.sentry",
"integrations.new_relic",
"integrations.segment",
"integrations.heap",
"integrations.mixpanel",
"integrations.rudderstack",
"integrations.slack",
"integrations.webhook",
"integrations.dynatrace",
"integrations.flagsmith",
"integrations.launch_darkly",
"integrations.github",
"integrations.grafana",
# Rate limiting admin endpoints
"axes",
"telemetry",
# for filtering querysets on viewsets
"django_filters",
"import_export",
"task_processor",
"softdelete",
"metadata",
"app_analytics",
]
SILENCED_SYSTEM_CHECKS = ["axes.W002"]
SITE_ID = 1
db_conn_max_age = env.int("DJANGO_DB_CONN_MAX_AGE", 60)
DJANGO_DB_CONN_MAX_AGE = None if db_conn_max_age == -1 else db_conn_max_age
DATABASE_ROUTERS = ["app.routers.PrimaryReplicaRouter"]
NUM_DB_REPLICAS = 0
NUM_CROSS_REGION_DB_REPLICAS = 0
# Allows collectstatic to run without a database, mainly for Docker builds to collectstatic at build time
if "DATABASE_URL" in os.environ:
DATABASES = {
"default": dj_database_url.parse(
env("DATABASE_URL"), conn_max_age=DJANGO_DB_CONN_MAX_AGE
),
}
REPLICA_DATABASE_URLS_DELIMITER = env("REPLICA_DATABASE_URLS_DELIMITER", ",")
REPLICA_DATABASE_URLS = env.list(
"REPLICA_DATABASE_URLS", default=[], delimiter=REPLICA_DATABASE_URLS_DELIMITER
)
NUM_DB_REPLICAS = len(REPLICA_DATABASE_URLS)
# Cross region replica databases are used as fallbacks if the
# primary replica set becomes unavailable.
CROSS_REGION_REPLICA_DATABASE_URLS_DELIMITER = env(
"CROSS_REGION_REPLICA_DATABASE_URLS_DELIMITER", ","
)
CROSS_REGION_REPLICA_DATABASE_URLS = env.list(
"CROSS_REGION_REPLICA_DATABASE_URLS",
default=[],
delimiter=CROSS_REGION_REPLICA_DATABASE_URLS_DELIMITER,
)
NUM_CROSS_REGION_DB_REPLICAS = len(CROSS_REGION_REPLICA_DATABASE_URLS)
# DISTRIBUTED spreads the load out across replicas while
# SEQUENTIAL only falls back once the first replica connection is faulty
REPLICA_READ_STRATEGY = env.enum(
"REPLICA_READ_STRATEGY",
type=ReplicaReadStrategy,
default=ReplicaReadStrategy.DISTRIBUTED.value,
)
for i, db_url in enumerate(REPLICA_DATABASE_URLS, start=1):
DATABASES[f"replica_{i}"] = dj_database_url.parse(
db_url, conn_max_age=DJANGO_DB_CONN_MAX_AGE
)
for i, db_url in enumerate(CROSS_REGION_REPLICA_DATABASE_URLS, start=1):
DATABASES[f"cross_region_replica_{i}"] = dj_database_url.parse(
db_url, conn_max_age=DJANGO_DB_CONN_MAX_AGE
)
if "ANALYTICS_DATABASE_URL" in os.environ:
DATABASES["analytics"] = dj_database_url.parse(
env("ANALYTICS_DATABASE_URL"), conn_max_age=DJANGO_DB_CONN_MAX_AGE
)
DATABASE_ROUTERS.insert(0, "app.routers.AnalyticsRouter")
elif "DJANGO_DB_NAME" in os.environ:
# If there is no DATABASE_URL configured, check for old style DB config parameters
DATABASES = {
"default": {
"ENGINE": "django.db.backends.postgresql",
"NAME": os.environ["DJANGO_DB_NAME"],
"USER": os.environ["DJANGO_DB_USER"],
"PASSWORD": os.environ["DJANGO_DB_PASSWORD"],
"HOST": os.environ["DJANGO_DB_HOST"],
"PORT": os.environ["DJANGO_DB_PORT"],
"CONN_MAX_AGE": DJANGO_DB_CONN_MAX_AGE,
},
}
if "DJANGO_DB_NAME_ANALYTICS" in os.environ:
DATABASES["analytics"] = {
"ENGINE": "django.db.backends.postgresql",
"NAME": os.environ["DJANGO_DB_NAME_ANALYTICS"],
"USER": os.environ["DJANGO_DB_USER_ANALYTICS"],
"PASSWORD": os.environ["DJANGO_DB_PASSWORD_ANALYTICS"],
"HOST": os.environ["DJANGO_DB_HOST_ANALYTICS"],
"PORT": os.environ["DJANGO_DB_PORT_ANALYTICS"],
"CONN_MAX_AGE": DJANGO_DB_CONN_MAX_AGE,
}
DATABASE_ROUTERS.insert(0, "app.routers.AnalyticsRouter")
LOGIN_THROTTLE_RATE = env("LOGIN_THROTTLE_RATE", "20/min")
SIGNUP_THROTTLE_RATE = env("SIGNUP_THROTTLE_RATE", "10000/min")
USER_THROTTLE_RATE = env("USER_THROTTLE_RATE", "500/min")
DEFAULT_THROTTLE_CLASSES = env.list("DEFAULT_THROTTLE_CLASSES", default=[])
REST_FRAMEWORK = {
"DEFAULT_PERMISSION_CLASSES": ["rest_framework.permissions.IsAuthenticated"],
"DEFAULT_AUTHENTICATION_CLASSES": (
"custom_auth.jwt_cookie.authentication.JWTCookieAuthentication",
"rest_framework.authentication.TokenAuthentication",
"api_keys.authentication.MasterAPIKeyAuthentication",
),
"PAGE_SIZE": 10,
"UNICODE_JSON": False,
"DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
"DEFAULT_THROTTLE_CLASSES": DEFAULT_THROTTLE_CLASSES,
"DEFAULT_THROTTLE_RATES": {
"login": LOGIN_THROTTLE_RATE,
"signup": SIGNUP_THROTTLE_RATE,
"mfa_code": "5/min",
"invite": "10/min",
"user": USER_THROTTLE_RATE,
},
"DEFAULT_FILTER_BACKENDS": ["django_filters.rest_framework.DjangoFilterBackend"],
"DEFAULT_RENDERER_CLASSES": [
"util.renderers.PydanticJSONRenderer",
"rest_framework.renderers.BrowsableAPIRenderer",
],
}
MIDDLEWARE = [
"django.middleware.security.SecurityMiddleware",
"whitenoise.middleware.WhiteNoiseMiddleware",
"django.contrib.sessions.middleware.SessionMiddleware",
"corsheaders.middleware.CorsMiddleware",
"django.middleware.common.CommonMiddleware",
"django.middleware.csrf.CsrfViewMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware",
"django.contrib.messages.middleware.MessageMiddleware",
"django.middleware.clickjacking.XFrameOptionsMiddleware",
"simple_history.middleware.HistoryRequestMiddleware",
]
ADD_NEVER_CACHE_HEADERS = env.bool("ADD_NEVER_CACHE_HEADERS", True)
if ADD_NEVER_CACHE_HEADERS:
MIDDLEWARE.append("core.middleware.cache_control.NeverCacheMiddleware")
APPLICATION_INSIGHTS_CONNECTION_STRING = env.str(
"APPLICATION_INSIGHTS_CONNECTION_STRING", default=None
)
OPENCENSUS_SAMPLING_RATE = env.float("OPENCENSUS_SAMPLING_RATE", 1.0)
if APPLICATION_INSIGHTS_CONNECTION_STRING:
MIDDLEWARE.insert(
0, "integrations.opencensus.middleware.OpenCensusDbTraceMiddleware"
)
MIDDLEWARE.insert(0, "opencensus.ext.django.middleware.OpencensusMiddleware")
OPENCENSUS = {
"TRACE": {
"SAMPLER": f"opencensus.trace.samplers.ProbabilitySampler(rate={OPENCENSUS_SAMPLING_RATE})",
"EXPORTER": f"""opencensus.ext.azure.trace_exporter.AzureExporter(
connection_string='{APPLICATION_INSIGHTS_CONNECTION_STRING}',
)""",
}
}
if ENABLE_GZIP_COMPRESSION:
# ref: https://docs.djangoproject.com/en/2.2/ref/middleware/#middleware-ordering
MIDDLEWARE.insert(1, "django.middleware.gzip.GZipMiddleware")
# Google Analytics Configuration
GOOGLE_ANALYTICS_KEY = env("GOOGLE_ANALYTICS_KEY", default="")
GOOGLE_SERVICE_ACCOUNT = env("GOOGLE_SERVICE_ACCOUNT", default=None)
GA_TABLE_ID = env("GA_TABLE_ID", default=None)
if GOOGLE_ANALYTICS_KEY:
MIDDLEWARE.append("app_analytics.middleware.GoogleAnalyticsMiddleware")
# Influx configuration
INFLUXDB_TOKEN = env.str("INFLUXDB_TOKEN", default="")
INFLUXDB_BUCKET = env.str("INFLUXDB_BUCKET", default="")
INFLUXDB_URL = env.str("INFLUXDB_URL", default="")
INFLUXDB_ORG = env.str("INFLUXDB_ORG", default="")
USE_POSTGRES_FOR_ANALYTICS = env.bool("USE_POSTGRES_FOR_ANALYTICS", default=False)
USE_CACHE_FOR_USAGE_DATA = env.bool("USE_CACHE_FOR_USAGE_DATA", default=False)
PG_API_USAGE_CACHE_SECONDS = env.int("PG_API_USAGE_CACHE_SECONDS", default=60)
FEATURE_EVALUATION_CACHE_SECONDS = env.int(
"FEATURE_EVALUATION_CACHE_SECONDS", default=60
)
ENABLE_API_USAGE_TRACKING = env.bool("ENABLE_API_USAGE_TRACKING", default=True)
if ENABLE_API_USAGE_TRACKING:
# NOTE: Because we use Postgres for analytics data in staging and Influx for tracking SSE data,
# we need to support setting the influx configuration alongside using postgres for analytics.
if USE_POSTGRES_FOR_ANALYTICS:
MIDDLEWARE.append("app_analytics.middleware.APIUsageMiddleware")
elif INFLUXDB_TOKEN:
MIDDLEWARE.append("app_analytics.middleware.InfluxDBMiddleware")
ALLOWED_ADMIN_IP_ADDRESSES = env.list("ALLOWED_ADMIN_IP_ADDRESSES", default=list())
if len(ALLOWED_ADMIN_IP_ADDRESSES) > 0:
warnings.warn(
"Restricting access to the admin site for ip addresses %s"
% ", ".join(ALLOWED_ADMIN_IP_ADDRESSES)
)
MIDDLEWARE.append("core.middleware.admin.AdminWhitelistMiddleware")
ROOT_URLCONF = "app.urls"
TEMPLATES = [
{
"BACKEND": "django.template.backends.django.DjangoTemplates",
"DIRS": ["templates"],
"APP_DIRS": True,
"OPTIONS": {
"context_processors": [
"django.template.context_processors.debug",
"django.template.context_processors.request",
"django.contrib.auth.context_processors.auth",
"django.contrib.messages.context_processors.messages",
],
},
},
]
WSGI_APPLICATION = "app.wsgi.application"
# Password validation
# https://docs.djangoproject.com/en/1.9/ref/settings/#auth-password-validators
AUTH_PASSWORD_VALIDATORS = [
{
"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
},
{"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
{"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
{"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
]
AUTHENTICATION_BACKENDS = [
"admin_sso.auth.DjangoSSOAuthBackend",
"django.contrib.auth.backends.ModelBackend",
]
DJANGO_ADMIN_SSO_OAUTH_CLIENT_ID = env.str("OAUTH_CLIENT_ID", default="")
DJANGO_ADMIN_SSO_OAUTH_CLIENT_SECRET = env.str("OAUTH_CLIENT_SECRET", default="")
# Internationalization
# https://docs.djangoproject.com/en/1.9/topics/i18n/
LANGUAGE_CODE = "en-us"
TIME_ZONE = "UTC"
USE_I18N = True
USE_L10N = True
USE_TZ = True
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/1.9/howto/static-files/
STATIC_URL = "/static/"
STATIC_ROOT = os.path.join(PROJECT_ROOT, "../../static/")
MEDIA_URL = "/media/" # unused but needs to be different from STATIC_URL in django 3
DEFAULT_FROM_EMAIL = env("SENDER_EMAIL", default="noreply@flagsmith.com")
EMAIL_CONFIGURATION = {
# Invitations with name is anticipated to take two arguments. The persons name and the
# organisation name they are invited to.
"INVITE_SUBJECT_WITH_NAME": "%s has invited you to join the organisation '%s' on Flagsmith",
# Invitations without a name is anticipated to take one arguments. The organisation name they
# are invited to.
"INVITE_SUBJECT_WITHOUT_NAME": "You have been invited to join the organisation '%s' on "
"Flagsmith",
# The email address invitations will be sent from.
"INVITE_FROM_EMAIL": DEFAULT_FROM_EMAIL,
}
AWS_SES_REGION_NAME = env("AWS_SES_REGION_NAME", default=None)
AWS_SES_REGION_ENDPOINT = env("AWS_SES_REGION_ENDPOINT", default=None)
# Initialisation settings
# If `ALLOW_ADMIN_INITIATION_VIA_CLI` setting is set to True, Flagsmith will attempt to create
# 1. A superuser
# 2. An organisation
# 3. A project
# with initial values on startup.
# Initialisation is skipped if it's been performed before or if `ALLOW_ADMIN_INITIATION_VIA_CLI` is set to False.
# Tweak (or set via environment) the settings below for custom names, etc.
ALLOW_ADMIN_INITIATION_VIA_URL = env.bool(
"ALLOW_ADMIN_INITIATION_VIA_URL", default=True
)
ALLOW_ADMIN_INITIATION_VIA_CLI = env.bool(
"ALLOW_ADMIN_INITIATION_VIA_CLI", default=False
)
ADMIN_EMAIL = env("ADMIN_EMAIL", default="admin@example.com")
ORGANISATION_NAME = env("ORGANISATION_NAME", default="Default Organisation")
PROJECT_NAME = env("PROJECT_NAME", default="Default Project")
AUTH_USER_MODEL = "users.FFAdminUser"
ACCOUNT_USERNAME_REQUIRED = False
ACCOUNT_EMAIL_REQUIRED = True
ACCOUNT_AUTHENTICATION_METHOD = "email"
ACCOUNT_EMAIL_VERIFICATION = "none" # TODO: configure email verification
# Set up Email
SENDGRID_API_KEY = env("SENDGRID_API_KEY", default=None)
# NOTE: Use `sgbackend.SendGridBackend` as default
# if `SENDGRID_API_KEY` is set in order to maintain backwards compatibility
DEFAULT_EMAIL_BACKEND = (
"sgbackend.SendGridBackend"
if SENDGRID_API_KEY
else "django.core.mail.backends.smtp.EmailBackend"
)
EMAIL_BACKEND = env("EMAIL_BACKEND", default=DEFAULT_EMAIL_BACKEND)
if EMAIL_BACKEND == "django.core.mail.backends.smtp.EmailBackend":
EMAIL_HOST = env("EMAIL_HOST", default="localhost")
EMAIL_HOST_USER = env("EMAIL_HOST_USER", default=None)
EMAIL_HOST_PASSWORD = env("EMAIL_HOST_PASSWORD", default=None)
EMAIL_PORT = env("EMAIL_PORT", default=587)
EMAIL_USE_TLS = env.bool("EMAIL_USE_TLS", default=True)
SWAGGER_SETTINGS = {
"DEEP_LINKING": True,
"DEFAULT_AUTO_SCHEMA_CLASS": "api.openapi.PydanticResponseCapableSwaggerAutoSchema",
"SHOW_REQUEST_HEADERS": True,
"SECURITY_DEFINITIONS": {
"Private": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "For Private Endpoints. <a href='https://docs.flagsmith.com/clients/rest#private-api-endpoints'>Find out more</a>.", # noqa
},
"Public": {
"type": "apiKey",
"in": "header",
"name": "X-Environment-Key",
"description": "For Public Endpoints. <a href='https://docs.flagsmith.com/clients/rest#public-api-endpoints'>Find out more</a>.", # noqa
},
},
}
LOGIN_URL = "/admin/login/"
LOGOUT_URL = "/admin/logout/"
# Enable E2E tests
E2E_TEST_AUTH_TOKEN = env.str("E2E_TEST_AUTH_TOKEN", default=None)
if E2E_TEST_AUTH_TOKEN is not None:
MIDDLEWARE.append("e2etests.middleware.E2ETestMiddleware")
ENABLE_FE_E2E = env.bool("ENABLE_FE_E2E", default=False)
# Email associated with user that is used by front end for end to end testing purposes
E2E_TEST_EMAIL_DOMAIN = "flagsmithe2etestdomain.io"
# User email address used for E2E Signup test
E2E_SIGNUP_USER = f"e2e_signup_user@{E2E_TEST_EMAIL_DOMAIN}"
# User email address used for Change email E2E test which is part of invite tests
E2E_CHANGE_EMAIL_USER = f"e2e_change_email@{E2E_TEST_EMAIL_DOMAIN}"
# User email address used for the rest of the E2E tests
E2E_USER = f"e2e_user@{E2E_TEST_EMAIL_DOMAIN}"
E2E_NON_ADMIN_USER_WITH_ORG_PERMISSIONS = (
f"e2e_non_admin_user_with_org_permissions@{E2E_TEST_EMAIL_DOMAIN}"
)
E2E_NON_ADMIN_USER_WITH_PROJECT_PERMISSIONS = (
f"e2e_non_admin_user_with_project_permissions@{E2E_TEST_EMAIL_DOMAIN}"
)
E2E_NON_ADMIN_USER_WITH_ENV_PERMISSIONS = (
f"e2e_non_admin_user_with_env_permissions@{E2E_TEST_EMAIL_DOMAIN}"
)
E2E_NON_ADMIN_USER_WITH_A_ROLE = (
f"e2e_non_admin_user_with_a_role@{E2E_TEST_EMAIL_DOMAIN}"
)
# Identity for E2E segment tests
E2E_IDENTITY = "test-identity"
# SSL handling in Django
SECURE_PROXY_SSL_HEADER_NAME = env.str(
"SECURE_PROXY_SSL_HEADER_NAME", "HTTP_X_FORWARDED_PROTO"
)
SECURE_PROXY_SSL_HEADER_VALUE = env.str("SECURE_PROXY_SSL_HEADER_VALUE", "https")
SECURE_PROXY_SSL_HEADER = (SECURE_PROXY_SSL_HEADER_NAME, SECURE_PROXY_SSL_HEADER_VALUE)
SECURE_REDIRECT_EXEMPT = env.list("DJANGO_SECURE_REDIRECT_EXEMPT", default=[])
SECURE_REFERRER_POLICY = env.str("DJANGO_SECURE_REFERRER_POLICY", default="same-origin")
SECURE_SSL_HOST = env.str("DJANGO_SECURE_SSL_HOST", default=None)
SECURE_SSL_REDIRECT = env.bool("DJANGO_SECURE_SSL_REDIRECT", default=False)
# Chargebee
ENABLE_CHARGEBEE = env.bool("ENABLE_CHARGEBEE", default=False)
CHARGEBEE_API_KEY = env("CHARGEBEE_API_KEY", default=None)
CHARGEBEE_SITE = env("CHARGEBEE_SITE", default=None)
# Logging configuration
LOGGING_CONFIGURATION_FILE = env.str("LOGGING_CONFIGURATION_FILE", default=None)
if LOGGING_CONFIGURATION_FILE:
with open(LOGGING_CONFIGURATION_FILE, "r") as f:
LOGGING = json.loads(f.read())
else:
LOG_FORMAT = env.str("LOG_FORMAT", default="generic")
LOG_LEVEL = env.str("LOG_LEVEL", default="WARNING")
LOGGING = {
"version": 1,
"disable_existing_loggers": False,
"formatters": {
"generic": {"format": "%(name)-12s %(levelname)-8s %(message)s"},
"json": {
"()": "util.logging.JsonFormatter",
"datefmt": "%Y-%m-%d %H:%M:%S",
},
},
"handlers": {
"console": {
"level": LOG_LEVEL,
"class": "logging.StreamHandler",
"formatter": LOG_FORMAT,
}
},
"loggers": {
"": {"level": LOG_LEVEL, "handlers": ["console"]},
# Not sure why the following loggers are necessary, but it doesn't seem to
# write log messages for e.g. features.workflows.core.models without adding
# them explicitly.
# TODO: move all apps to a parent 'apps' directory and configure the logger
# for that dir
"features": {
"level": LOG_LEVEL,
"handlers": ["console"],
"propagate": False,
},
"task_processor": {
"level": LOG_LEVEL,
"handlers": ["console"],
"propagate": False,
},
"app_analytics": {
"level": LOG_LEVEL,
"handlers": ["console"],
"propagate": False,
},
"webhooks": {
"level": LOG_LEVEL,
"handlers": ["console"],
"propagate": False,
},
},
}
if APPLICATION_INSIGHTS_CONNECTION_STRING:
LOGGING["handlers"]["azure"] = {
"level": "DEBUG",
"class": "opencensus.ext.azure.log_exporter.AzureLogHandler",
"connection_string": APPLICATION_INSIGHTS_CONNECTION_STRING,
}
LOGGING["loggers"][""]["handlers"].append("azure")
ENABLE_DB_LOGGING = env.bool("DJANGO_ENABLE_DB_LOGGING", default=False)
if ENABLE_DB_LOGGING:
LOGGING["loggers"]["django.db.backends"] = {
"level": "DEBUG",
"handlers": ["console"],
}
CACHE_FLAGS_SECONDS = env.int("CACHE_FLAGS_SECONDS", default=0)
FLAGS_CACHE_LOCATION = "environment-flags"
CHARGEBEE_CACHE_LOCATION = "chargebee-objects"
ENVIRONMENT_CACHE_SECONDS = env.int("ENVIRONMENT_CACHE_SECONDS", default=60)
ENVIRONMENT_CACHE_BACKEND = env.str(
"ENVIRONMENT_CACHE_BACKEND",
default="django.core.cache.backends.locmem.LocMemCache",
)
ENVIRONMENT_CACHE_NAME = "environment-objects"
ENVIRONMENT_CACHE_LOCATION = env.str(
"ENVIRONMENT_CACHE_LOCATION", default=ENVIRONMENT_CACHE_NAME
)
GET_FLAGS_ENDPOINT_CACHE_SECONDS = env.int(
"GET_FLAGS_ENDPOINT_CACHE_SECONDS", default=0
)
GET_FLAGS_ENDPOINT_CACHE_NAME = "get_flags_endpoint_cache"
GET_FLAGS_ENDPOINT_CACHE_BACKEND = env.str(
"GET_FLAGS_ENDPOINT_CACHE_BACKEND",
default="django.core.cache.backends.dummy.DummyCache",
)
GET_FLAGS_ENDPOINT_CACHE_LOCATION = env.str(
"GET_FLAGS_ENDPOINT_CACHE_LOCATION",
default=GET_FLAGS_ENDPOINT_CACHE_NAME,
)
GET_IDENTITIES_ENDPOINT_CACHE_SECONDS = env.int(
"GET_IDENTITIES_ENDPOINT_CACHE_SECONDS", default=0
)
GET_IDENTITIES_ENDPOINT_CACHE_NAME = "get_identities_endpoint_cache"
GET_IDENTITIES_ENDPOINT_CACHE_BACKEND = env.str(
"GET_IDENTITIES_ENDPOINT_CACHE_BACKEND",
default="django.core.cache.backends.dummy.DummyCache",
)
GET_IDENTITIES_ENDPOINT_CACHE_LOCATION = env.str(
"GET_IDENTITIES_ENDPOINT_CACHE_LOCATION",
default=GET_IDENTITIES_ENDPOINT_CACHE_NAME,
)
BAD_ENVIRONMENTS_CACHE_LOCATION = "bad-environments"
CACHE_BAD_ENVIRONMENTS_SECONDS = env.int("CACHE_BAD_ENVIRONMENTS_SECONDS", 0)
CACHE_BAD_ENVIRONMENTS_AFTER_FAILURES = env.int(
"CACHE_BAD_ENVIRONMENTS_AFTER_FAILURES", 1
)
CACHE_PROJECT_SEGMENTS_SECONDS = env.int("CACHE_PROJECT_SEGMENTS_SECONDS", 0)
PROJECT_SEGMENTS_CACHE_LOCATION = "project-segments"
ENVIRONMENT_SEGMENTS_CACHE_NAME = "environment-segments"
ENVIRONMENT_SEGMENTS_CACHE_SECONDS = env.int("CACHE_ENVIRONMENT_SEGMENTS_SECONDS", 0)
ENVIRONMENT_SEGMENTS_CACHE_LOCATION = env(
"ENVIRONMENT_SEGMENTS_CACHE_LOCATION", "environment-segments"
)
ENVIRONMENT_SEGMENTS_CACHE_BACKEND = env(
"CACHE_ENVIRONMENT_SEGMENTS_BACKEND",
"django.core.cache.backends.locmem.LocMemCache",
)
CACHE_ENVIRONMENT_DOCUMENT_SECONDS = env.int("CACHE_ENVIRONMENT_DOCUMENT_SECONDS", 0)
ENVIRONMENT_DOCUMENT_CACHE_LOCATION = "environment-documents"
USER_THROTTLE_CACHE_NAME = "user-throttle"
USER_THROTTLE_CACHE_BACKEND = env.str(
"USER_THROTTLE_CACHE_BACKEND", "django.core.cache.backends.locmem.LocMemCache"
)
USER_THROTTLE_CACHE_LOCATION = env.str("USER_THROTTLE_CACHE_LOCATION", "admin-throttle")
USER_THROTTLE_CACHE_OPTIONS = env.dict("USER_THROTTLE_CACHE_OPTIONS", default={})
# Using Redis for cache
# To use Redis for caching, set the cache backend to `django_redis.cache.RedisCache`.
# and set the cache location to the redis url
# ref: https://github.com/jazzband/django-redis/tree/5.4.0#configure-as-cache-backend
# Avoid raising exceptions if redis is down
# ref: https://github.com/jazzband/django-redis/tree/5.4.0#memcached-exceptions-behavior
DJANGO_REDIS_IGNORE_EXCEPTIONS = env.bool(
"DJANGO_REDIS_IGNORE_EXCEPTIONS", default=True
)
# Log exceptions generated by django-redis
# ref:https://github.com/jazzband/django-redis/tree/5.4.0#log-ignored-exceptions
DJANGO_REDIS_LOG_IGNORED_EXCEPTIONS = env.bool(
"DJANGO_REDIS_LOG_IGNORED_EXCEPTIONS", True
)
CACHES = {
"default": {
"BACKEND": "django.core.cache.backends.locmem.LocMemCache",
"LOCATION": "unique-snowflake",
},
ENVIRONMENT_CACHE_NAME: {
"BACKEND": ENVIRONMENT_CACHE_BACKEND,
"LOCATION": ENVIRONMENT_CACHE_LOCATION,
"TIMEOUT": ENVIRONMENT_CACHE_SECONDS,
},
FLAGS_CACHE_LOCATION: {
"BACKEND": "django.core.cache.backends.locmem.LocMemCache",
"LOCATION": FLAGS_CACHE_LOCATION,
},
PROJECT_SEGMENTS_CACHE_LOCATION: {
"BACKEND": "django.core.cache.backends.locmem.LocMemCache",
"LOCATION": PROJECT_SEGMENTS_CACHE_LOCATION,
},
BAD_ENVIRONMENTS_CACHE_LOCATION: {
"BACKEND": "django.core.cache.backends.locmem.LocMemCache",
"LOCATION": BAD_ENVIRONMENTS_CACHE_LOCATION,
"OPTIONS": {"MAX_ENTRIES": 50},
},
CHARGEBEE_CACHE_LOCATION: {
"BACKEND": "django.core.cache.backends.db.DatabaseCache",
"LOCATION": CHARGEBEE_CACHE_LOCATION,
"TIMEOUT": 12 * 60 * 60, # 12 hours
},
ENVIRONMENT_DOCUMENT_CACHE_LOCATION: {
"BACKEND": "django.core.cache.backends.db.DatabaseCache",
"LOCATION": ENVIRONMENT_DOCUMENT_CACHE_LOCATION,
"timeout": CACHE_ENVIRONMENT_DOCUMENT_SECONDS,
},
GET_FLAGS_ENDPOINT_CACHE_NAME: {
"BACKEND": GET_FLAGS_ENDPOINT_CACHE_BACKEND,
"LOCATION": GET_FLAGS_ENDPOINT_CACHE_LOCATION,
},
GET_IDENTITIES_ENDPOINT_CACHE_NAME: {
"BACKEND": GET_IDENTITIES_ENDPOINT_CACHE_BACKEND,
"LOCATION": GET_IDENTITIES_ENDPOINT_CACHE_LOCATION,
},
ENVIRONMENT_SEGMENTS_CACHE_NAME: {
"BACKEND": ENVIRONMENT_SEGMENTS_CACHE_BACKEND,
"LOCATION": ENVIRONMENT_SEGMENTS_CACHE_LOCATION,
"TIMEOUT": ENVIRONMENT_SEGMENTS_CACHE_SECONDS,
},
USER_THROTTLE_CACHE_NAME: {
"BACKEND": USER_THROTTLE_CACHE_BACKEND,
"LOCATION": USER_THROTTLE_CACHE_LOCATION,
"OPTIONS": USER_THROTTLE_CACHE_OPTIONS,
},
}
TRENCH_AUTH = {
"BACKUP_CODES_QUANTITY": 5,
"BACKUP_CODES_LENGTH": 10, # keep (quantity * length) under 200
"BACKUP_CODES_CHARACTERS": (
"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
),
"DEFAULT_VALIDITY_PERIOD": 30,
"CONFIRM_BACKUP_CODES_REGENERATION_WITH_CODE": True,
"APPLICATION_ISSUER_NAME": "app.bullet-train.io",
"ENCRYPT_BACKUP_CODES": True,
"MFA_METHODS": {
"app": {
"VERBOSE_NAME": "TOTP App",
"VALIDITY_PERIOD": 60 * 10,
"USES_THIRD_PARTY_CLIENT": True,
"HANDLER": "custom_auth.mfa.backends.application.CustomApplicationBackend",
},
},
"SECRET_KEY_LENGTH": 32,
}
USER_CREATE_PERMISSIONS = env.list(
"USER_CREATE_PERMISSIONS", default=["custom_auth.permissions.IsSignupAllowed"]
)
DJOSER = {
"PASSWORD_RESET_CONFIRM_URL": "password-reset/confirm/{uid}/{token}",
# if True user required to click activation link in email to activate account
"SEND_ACTIVATION_EMAIL": env.bool("ENABLE_EMAIL_ACTIVATION", default=False),
# FE uri to redirect user to from activation email
"ACTIVATION_URL": "activate/{uid}/{token}",
# register or activation endpoint will send confirmation email to user
"SEND_CONFIRMATION_EMAIL": False,
"SERIALIZERS": {
"token": "custom_auth.serializers.CustomTokenSerializer",
"token_create": "custom_auth.serializers.CustomTokenCreateSerializer",
"user_create": "custom_auth.serializers.CustomUserCreateSerializer",
"user_delete": "custom_auth.serializers.CustomUserDelete",
"current_user": "users.serializers.CustomCurrentUserSerializer",
},
"EMAIL": {
"activation": "users.emails.ActivationEmail",
"confirmation": "users.emails.ConfirmationEmail",
},
"SET_PASSWORD_RETYPE": True,
"PASSWORD_RESET_CONFIRM_RETYPE": True,
"HIDE_USERS": True,
"PERMISSIONS": {
"user": ["custom_auth.permissions.CurrentUser"],
"user_list": ["custom_auth.permissions.CurrentUser"],
"user_create": USER_CREATE_PERMISSIONS,
},
}
SIMPLE_JWT = {
"AUTH_TOKEN_CLASSES": ["rest_framework_simplejwt.tokens.SlidingToken"],
"SLIDING_TOKEN_LIFETIME": timedelta(
minutes=env.int(
"COOKIE_AUTH_JWT_ACCESS_TOKEN_LIFETIME_MINUTES",
default=10 * 60,
)
),
"SIGNING_KEY": env.str("COOKIE_AUTH_JWT_SIGNING_KEY", default=SECRET_KEY),
}
# Github OAuth credentials
GITHUB_CLIENT_ID = env.str("GITHUB_CLIENT_ID", default="")
GITHUB_CLIENT_SECRET = env.str("GITHUB_CLIENT_SECRET", default="")
# Allow the configuration of registration via OAuth
ALLOW_REGISTRATION_WITHOUT_INVITE = env.bool(
"ALLOW_REGISTRATION_WITHOUT_INVITE", default=True
)
# Django Axes settings
ENABLE_AXES = env.bool("ENABLE_AXES", default=True)
if ENABLE_AXES:
# must be the first item in the auth backends
AUTHENTICATION_BACKENDS.insert(0, "axes.backends.AxesBackend")
# must be the last item in the middleware stack
MIDDLEWARE.append("core.middleware.axes.AxesMiddleware")
AXES_COOLOFF_TIME = timedelta(minutes=env.int("AXES_COOLOFF_TIME", 15))
AXES_BLACKLISTED_URLS = [
"/admin/login/?next=/admin",
"/admin/",
]
AXES_ONLY_USER_FAILURES = env.bool("AXES_ONLY_USER_FAILURES", True)
AXES_FAILURE_LIMIT = env.int("AXES_FAILURE_LIMIT", 10)
# Sentry tracking
SENTRY_SDK_DSN = env("SENTRY_SDK_DSN", default=None)
DEFAULT_SENTRY_TRACE_SAMPLE_RATE = env.float("SENTRY_TRACE_SAMPLE_RATE", default=1.0)
DASHBOARD_ENDPOINTS_SENTRY_TRACE_SAMPLE_RATE = env.float(
"DASHBOARD_ENDPOINTS_SENTRY_TRACE_SAMPLE_RATE", default=1.0
)
FORCE_SENTRY_TRACE_KEY = env("FORCE_SENTRY_TRACE_KEY", default=None)
if FORCE_SENTRY_TRACE_KEY:
MIDDLEWARE.append("integrations.sentry.middleware.ForceSentryTraceMiddleware")
# allow users to access the admin console
ENABLE_ADMIN_ACCESS_USER_PASS = env.bool("ENABLE_ADMIN_ACCESS_USER_PASS", default=None)
# Set this flag to prevent traits being stored for all Organisations within the application
# Useful for data sensitive installations that dont want persistent traits.
DEFAULT_ORG_STORE_TRAITS_VALUE = env.bool("DEFAULT_ORG_STORE_TRAITS_VALUE", True)
# DynamoDB table name for storing environment
ENVIRONMENTS_TABLE_NAME_DYNAMO = env.str("ENVIRONMENTS_TABLE_NAME_DYNAMO", None)
# V2 was created to improve storage over overrides data.
ENVIRONMENTS_V2_TABLE_NAME_DYNAMO = env.str("ENVIRONMENTS_V2_TABLE_NAME_DYNAMO", None)
# DynamoDB table name for storing identities
IDENTITIES_TABLE_NAME_DYNAMO = env.str("IDENTITIES_TABLE_NAME_DYNAMO", None)
# DynamoDB table name for storing environment api keys
ENVIRONMENTS_API_KEY_TABLE_NAME_DYNAMO = env.str(
"ENVIRONMENTS_API_KEY_TABLE_NAME_DYNAMO", None
)
# DynamoDB table name for storing project metadata(currently only used for identity migration)
PROJECT_METADATA_TABLE_NAME_DYNAMO = env.str("PROJECT_METADATA_TABLE_NAME_DYNAMO", None)
# Front end environment variables
API_URL = env("API_URL", default="/api/v1/")
ASSET_URL = env("ASSET_URL", default="/")
MAINTENANCE_MODE = env.bool("MAINTENANCE_MODE", default=False)
PREVENT_EMAIL_PASSWORD = env.bool("PREVENT_EMAIL_PASSWORD", default=False)
DISABLE_ANALYTICS_FEATURES = env.bool(
"DISABLE_INFLUXDB_FEATURES", default=False
) or env.bool("DISABLE_ANALYTICS_FEATURES", default=False)
FLAGSMITH_ANALYTICS = env.bool("FLAGSMITH_ANALYTICS", default=False)
FLAGSMITH_ON_FLAGSMITH_API_URL = env("FLAGSMITH_ON_FLAGSMITH_API_URL", default=None)
FLAGSMITH_ON_FLAGSMITH_API_KEY = env("FLAGSMITH_ON_FLAGSMITH_API_KEY", default=None)
LINKEDIN_PARTNER_TRACKING = env("LINKEDIN_PARTNER_TRACKING", default=False)
GOOGLE_ANALYTICS_API_KEY = env("GOOGLE_ANALYTICS_API_KEY", default=None)
HEADWAY_API_KEY = env("HEADWAY_API_KEY", default=None)
CRISP_CHAT_API_KEY = env("CRISP_CHAT_API_KEY", default=None)
MIXPANEL_API_KEY = env("MIXPANEL_API_KEY", default=None)
SENTRY_API_KEY = env("SENTRY_API_KEY", default=None)
AMPLITUDE_API_KEY = env("AMPLITUDE_API_KEY", default=None)
ENABLE_FLAGSMITH_REALTIME = env.bool("ENABLE_FLAGSMITH_REALTIME", default=False)
# Set this to enable create organisation for only superusers
RESTRICT_ORG_CREATE_TO_SUPERUSERS = env.bool("RESTRICT_ORG_CREATE_TO_SUPERUSERS", False)
# Slack Integration
SLACK_CLIENT_ID = env.str("SLACK_CLIENT_ID", default="")
SLACK_CLIENT_SECRET = env.str("SLACK_CLIENT_SECRET", default="")
# GitHub integrations
GITHUB_PEM = env.str("GITHUB_PEM", default="")
GITHUB_APP_ID: int = env.int("GITHUB_APP_ID", default=0)
GITHUB_WEBHOOK_SECRET = env.str("GITHUB_WEBHOOK_SECRET", default="")
# MailerLite
MAILERLITE_BASE_URL = env.str(
"MAILERLITE_BASE_URL", default="https://api.mailerlite.com/api/v2/"
)
MAILERLITE_API_KEY = env.str("MAILERLITE_API_KEY", None)
MAILERLITE_NEW_USER_GROUP_ID = env.int("MAILERLITE_NEW_USER_GROUP_ID", None)
# Additional functionality for using SAML in Flagsmith SaaS
SAML_INSTALLED = importlib.util.find_spec("saml") is not None
if SAML_INSTALLED:
SAML_REQUESTS_CACHE_LOCATION = "saml_requests_cache"
CACHES[SAML_REQUESTS_CACHE_LOCATION] = {
"BACKEND": "django.core.cache.backends.db.DatabaseCache",
"LOCATION": SAML_REQUESTS_CACHE_LOCATION,
}
INSTALLED_APPS.append("saml")
SAML_ACCEPTED_TIME_DIFF = env.int("SAML_ACCEPTED_TIME_DIFF", default=60)
DJOSER["SERIALIZERS"]["current_user"] = "saml.serializers.SamlCurrentUserSerializer"
EXTRA_ALLOWED_CANONICALIZATIONS = env.list(
"EXTRA_ALLOWED_CANONICALIZATIONS", default=[]
)
WORKFLOWS_LOGIC_INSTALLED = importlib.util.find_spec("workflows_logic") is not None
if WORKFLOWS_LOGIC_INSTALLED:
INSTALLED_APPS.append("workflows_logic")
if importlib.util.find_spec("workflows_logic.stale_flags") is not None:
INSTALLED_APPS.append("workflows_logic.stale_flags")
# Additional functionality for restricting authentication to a set of authentication methods in Flagsmith SaaS
AUTH_CONTROLLER_INSTALLED = importlib.util.find_spec("auth_controller") is not None
if AUTH_CONTROLLER_INSTALLED:
INSTALLED_APPS.append("auth_controller")
AUTHENTICATION_BACKENDS.insert(0, "auth_controller.backends.AuthControllerBackend")
IS_RBAC_INSTALLED = importlib.util.find_spec("rbac") is not None
if IS_RBAC_INSTALLED:
INSTALLED_APPS.append("rbac")
DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
# Used to keep edge identities in sync by forwarding the http requests
EDGE_API_URL = env.str("EDGE_API_URL", None)
# Used for signing forwarded request to edge
EDGE_REQUEST_SIGNING_KEY = env.str("EDGE_REQUEST_SIGNING_KEY", None)
# Aws Event bus used for sending identity migration events
IDENTITY_MIGRATION_EVENT_BUS_NAME = env.str("IDENTITY_MIGRATION_EVENT_BUS_NAME", None)
# Should be a string representing a timezone aware datetime, e.g. 2022-03-31T12:35:00Z
EDGE_RELEASE_DATETIME = env.datetime("EDGE_RELEASE_DATETIME", None)
# Note: using django.utils.timezone.now doesn't work reliably in settings so we use
# datetime.now
EDGE_ENABLED = (
ENVIRONMENTS_TABLE_NAME_DYNAMO is not None
and EDGE_RELEASE_DATETIME is not None
and EDGE_RELEASE_DATETIME < datetime.now(tz=pytz.UTC)
)
DISABLE_FLAGSMITH_UI = env.bool("DISABLE_FLAGSMITH_UI", default=False)
SERVE_FE_ASSETS = not DISABLE_FLAGSMITH_UI and os.path.exists(
BASE_DIR + "/app/templates/webpack/index.html"
)
# Used to configure the number of application proxies that the API runs behind
NUM_PROXIES = env.int("NUM_PROXIES", 1)
SAML_USE_NAME_ID_AS_EMAIL = env.bool("SAML_USE_NAME_ID_AS_EMAIL", False)
# Used to control the size(number of identities) of the project that can be self migrated to edge
MAX_SELF_MIGRATABLE_IDENTITIES = env.int("MAX_SELF_MIGRATABLE_IDENTITIES", 100000)
# Setting to allow asynchronous tasks to be run synchronously for testing purposes
# or in a separate thread for self-hosted users
TASK_RUN_METHOD = env.enum(
"TASK_RUN_METHOD",
type=TaskRunMethod,
default=(