-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathapp.json
More file actions
801 lines (801 loc) · 28.3 KB
/
app.json
File metadata and controls
801 lines (801 loc) · 28.3 KB
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
{
"addons": [
"heroku-postgresql:hobby-dev",
"newrelic:wayne",
"rediscloud:30"
],
"buildpacks": [
{
"url": "https://github.com/heroku/heroku-buildpack-apt"
},
{
"url": "https://github.com/heroku/heroku-buildpack-nodejs"
},
{
"url": "https://github.com/moneymeets/python-poetry-buildpack"
},
{
"url": "https://github.com/heroku/heroku-buildpack-python"
},
{
"url": "https://github.com/heroku/heroku-buildpack-pgbouncer"
},
{
"url": "https://github.com/heroku/heroku-buildpack-nginx"
}
],
"description": "MITx Online",
"env": {
"ALLOWED_REDIRECT_HOSTS": {
"description": "List of hosts allowed to redirect to after login",
"required": false
},
"AUTH_CHANGE_EMAIL_TTL_IN_MINUTES": {
"description": "Expiry time for a change email request, default is 1440 minutes(1 day)",
"required": false
},
"AWS_ACCESS_KEY_ID": {
"description": "AWS Access Key for S3 storage.",
"required": false
},
"AWS_QUERYSTRING_AUTH": {
"description": "Enables querystring auth for S3 urls",
"required": false
},
"AWS_S3_FILE_OVERWRITE": {
"description": "Django Storages setting. By default files with the same name will overwrite each other. Set this to False to have extra characters appended.",
"required": false
},
"AWS_SECRET_ACCESS_KEY": {
"description": "AWS Secret Key for S3 storage.",
"required": false
},
"AWS_STORAGE_BUCKET_NAME": {
"description": "S3 Bucket name.",
"required": false
},
"CELERY_BROKER_URL": {
"description": "Where celery should get tasks, default is Redis URL",
"required": false
},
"CELERY_RESULT_BACKEND": {
"description": "Where celery should put task results, default is Redis URL",
"required": false
},
"CELERY_TASK_EAGER_PROPAGATES": {
"description": "Early executed tasks propagate exceptions",
"required": false
},
"CERTIFICATE_CREATION_WINDOW_IN_DAYS": {
"description": "The number of days a course run is eligible for certificate creation after it ends.",
"required": false
},
"CLOUDFRONT_DIST": {
"description": "The Cloundfront distribution to use for static assets",
"required": false
},
"CORS_ALLOWED_ORIGINS": {
"description": "Comma separated string of trusted domains that should be allowed for CORS",
"required": false
},
"CORS_ALLOW_CREDENTIALS": {
"description": "Allow cookies to be sent in cross-site HTTP requests",
"required": false
},
"CRON_COURSERUN_SYNC_DAYS": {
"description": "day_of_week' value for scheduled task to sync course run data (by default, it will run each day of the week).",
"required": false
},
"CRON_COURSERUN_SYNC_HOURS": {
"description": "'hours' value for scheduled task to sync course run data (by default, it will run at midnight",
"required": false
},
"CRON_COURSE_CERTIFICATES_DAYS": {
"description": "'day_of_week' value for 'generate-course-certificate' scheduled task (default will run once a day).",
"required": false
},
"CRON_COURSE_CERTIFICATES_HOURS": {
"description": "'hours' value for the 'generate-course-certificate' scheduled task (defaults to midnight)",
"required": false
},
"CRON_ORPHAN_CHECK_DAYS": {
"description": "'day_of_week' value for 'check-for-program-orphans' scheduled task (default will run once a day).",
"required": false
},
"CRON_ORPHAN_CHECK_HOURS": {
"description": "'hours' value for 'check-for-program-orphans' scheduled task (default will run at 3 AM).",
"required": false
},
"CRON_PROCESS_REFUND_REQUESTS_MINUTES": {
"description": "minute value for scheduled task to process refund requests",
"required": false
},
"CSRF_COOKIE_DOMAIN": {
"description": "Domain to set the CSRF cookie to.",
"required": false
},
"CSRF_TRUSTED_ORIGINS": {
"description": "Comma separated string of trusted domains that should be CSRF exempt",
"required": false
},
"DISABLE_USER_REPAIR_TASK": {
"description": "Disable the task so it no-ops",
"required": false
},
"DJANGO_LOG_LEVEL": {
"description": "The log level for django",
"required": false
},
"ECOMMERCE_DEFAULT_PAYMENT_GATEWAY": {
"description": "The default payment gateway to use. Must match the value of the constant in the mitol.payment_gateway library.",
"required": false
},
"EDX_API_CLIENT_TIMEOUT": {
"description": "Timeout (in seconds) for requests made via the edX API client",
"required": false
},
"EXPOSE_OIDC_LOGIN": {
"description": "Expose the OIDC login functionality.",
"required": false
},
"FASTLY_AUTH_TOKEN": {
"description": "Optional token for the Fastly purge API.",
"required": false
},
"FASTLY_URL": {
"description": "The URL to the Fastly API.",
"required": false
},
"GA_TRACKING_ID": {
"description": "Google analytics tracking ID",
"required": false
},
"GOOGLE_DOMAIN_VERIFICATION_TAG_VALUE": {
"description": "The value of the meta tag used by Google to verify the owner of a domain (used for enabling push notifications)",
"required": false
},
"GTM_TRACKING_ID": {
"description": "Google Tag Manager container ID",
"required": false
},
"HEROKU_APP_NAME": {
"description": "The name of the review app",
"required": false
},
"HOST_IP": {
"description": "This server's host IP",
"required": false
},
"HUBSPOT_HOME_PAGE_FORM_GUID": {
"description": "Hubspot ID for the home page contact form",
"required": false
},
"HUBSPOT_MAX_CONCURRENT_TASKS": {
"description": "Max number of concurrent Hubspot tasks to run",
"required": false
},
"HUBSPOT_PIPELINE_ID": {
"description": "Hubspot ID for the ecommerce pipeline",
"required": false
},
"HUBSPOT_PORTAL_ID": {
"description": "Hubspot Portal ID",
"required": false
},
"HUBSPOT_TASK_DELAY": {
"description": "Number of milliseconds to wait between consecutive Hubspot calls",
"required": false
},
"KEYCLOAK_BASE_URL": {
"description": "Base URL for the Keycloak instance.",
"required": false
},
"KEYCLOAK_CLIENT_ID": {
"description": "The client name for mitxonline.",
"required": false
},
"KEYCLOAK_REALM_NAME": {
"description": "Name of the realm the app uses in Keycloak.",
"required": false
},
"LOGOUT_REDIRECT_URL": {
"description": "Url to redirect to after logout, typically Open edX's own logout url",
"required": false
},
"MAILGUN_BATCH_CHUNK_SIZE": {
"description": "Maximum number of emails to send in a batch",
"required": false
},
"MAILGUN_KEY": {
"description": "The token for authenticating against the Mailgun API",
"required": true
},
"MAILGUN_SENDER_DOMAIN": {
"description": "The domain to send mailgun email through",
"required": true
},
"MEDIA_ROOT": {
"description": "The root directory for locally stored media. Typically not used.",
"required": false
},
"MITOL_APIGATEWAY_ALLOWED_REDIRECT_HOSTS": {
"description": "The list of hosts the app is allowed to redirect to",
"required": false
},
"MITOL_APIGATEWAY_DEFAULT_POST_LOGOUT_DEST": {
"description": "The URL to redirect to after logging out",
"required": false
},
"MITOL_APIGATEWAY_DISABLE_MIDDLEWARE": {
"description": "Disable middleware",
"required": false
},
"MITOL_APIGATEWAY_USERINFO_CREATE": {
"description": "Create users that we see but aren't aware of",
"required": false
},
"MITOL_APIGATEWAY_USERINFO_UPDATE": {
"description": "Update users we've seen before",
"required": false
},
"MITOL_AUTHENTICATION_FROM_EMAIL": {
"description": "E-mail to use for the from field",
"required": false
},
"MITOL_AUTHENTICATION_REPLY_TO_ADDRESS": {
"description": "E-mail to use for reply-to address of emails",
"required": false
},
"MITOL_CELERY_APP_INSTANCE_PATH": {
"description": "Path to the celery app instance",
"required": true
},
"MITOL_GOOGLE_SHEETS_ADMIN_EMAILS": {
"description": "This list of email addresses for the google service account authentication",
"required": false
},
"MITOL_GOOGLE_SHEETS_DATE_FORMAT": {
"description": "Python strptime format for date columns (no time) in enrollment management spreadsheets",
"required": false
},
"MITOL_GOOGLE_SHEETS_DATE_TIMEZONE": {
"description": "The name of the timezone that should be assumed for date/time values in spreadsheets. Choose from a value in the TZ database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
"required": false
},
"MITOL_GOOGLE_SHEETS_DEFERRALS_COMPLETED_DATE_COL": {
"description": "The zero-based index of the enrollment change sheet column that contains the row completion date",
"required": false
},
"MITOL_GOOGLE_SHEETS_DEFERRALS_ERROR_COL": {
"description": "The zero-based index of the enrollment change sheet column that contains row processing error messages",
"required": false
},
"MITOL_GOOGLE_SHEETS_DEFERRALS_FIRST_ROW": {
"description": "The first row (as it appears in the spreadsheet) of data that our scripts should consider processing in the deferral request spreadsheet",
"required": false
},
"MITOL_GOOGLE_SHEETS_DEFERRALS_PLUGINS": {
"description": "The path to your deferral plugin, example: app.plugins.DeferralPlugin",
"required": false
},
"MITOL_GOOGLE_SHEETS_DEFERRALS_PROCESSOR_COL": {
"description": "The zero-based index of the enrollment change sheet column that contains the user that processed the row",
"required": false
},
"MITOL_GOOGLE_SHEETS_DEFERRALS_REQUEST_WORKSHEET_ID": {
"description": "ID of the worksheet within the enrollment change request spreadsheet that contains enrollment deferral requests",
"required": false
},
"MITOL_GOOGLE_SHEETS_DEFERRALS_SKIP_ROW_COL": {
"description": "The zero-based index of the enrollment change sheet column that indicates whether the row should be skipped",
"required": false
},
"MITOL_GOOGLE_SHEETS_DRIVE_API_PROJECT_ID": {
"description": "ID for the Google API project where the credentials were created",
"required": false
},
"MITOL_GOOGLE_SHEETS_DRIVE_CLIENT_ID": {
"description": "Client ID from Google API credentials",
"required": false
},
"MITOL_GOOGLE_SHEETS_DRIVE_CLIENT_SECRET": {
"description": "Client secret from Google API credentials",
"required": false
},
"MITOL_GOOGLE_SHEETS_DRIVE_SERVICE_ACCOUNT_CREDS": {
"description": "The contents of the Service Account credentials JSON to use for Google API auth",
"required": false
},
"MITOL_GOOGLE_SHEETS_DRIVE_SHARED_ID": {
"description": "ID of the Shared Drive (a.k.a. Team Drive). This is equal to the top-level folder ID.",
"required": false
},
"MITOL_GOOGLE_SHEETS_ENROLLMENT_CHANGE_SHEET_ID": {
"description": "ID of the Google Sheet that contains the enrollment change request worksheets (refunds, transfers, etc)",
"required": false
},
"MITOL_GOOGLE_SHEETS_GOOGLE_ACCOUNT_EMAIL_DOMAIN": {
"description": "Email domain of the google service account",
"required": false
},
"MITOL_GOOGLE_SHEETS_PROCESSOR_APP_NAME": {
"description": "Name of the app processing the request",
"required": false
},
"MITOL_GOOGLE_SHEETS_PROCESS_ONLY_LAST_ROWS_NUM": {
"description": "Process only the last N rows of data. If set to 0 then process all rows. ",
"required": false
},
"MITOL_GOOGLE_SHEETS_REFUNDS_COMPLETED_DATE_COL": {
"description": "The zero-based index of the enrollment change sheet column that contains the row completion date",
"required": false
},
"MITOL_GOOGLE_SHEETS_REFUNDS_ERROR_COL": {
"description": "The zero-based index of the enrollment change sheet column that contains row processing error messages",
"required": false
},
"MITOL_GOOGLE_SHEETS_REFUNDS_FIRST_ROW": {
"description": "The first row (as it appears in the spreadsheet) of data that our scripts should consider processing in the refund request spreadsheet",
"required": false
},
"MITOL_GOOGLE_SHEETS_REFUNDS_PLUGINS": {
"description": "The path to your refund plugin, example: app.plugins.RefundPlugin",
"required": false
},
"MITOL_GOOGLE_SHEETS_REFUNDS_PROCESSOR_COL": {
"description": "The zero-based index of the enrollment change sheet column that contains the user that processed the row",
"required": false
},
"MITOL_GOOGLE_SHEETS_REFUNDS_REQUEST_WORKSHEET_ID": {
"description": "ID of the worksheet within the enrollment change request spreadsheet that contains enrollment refund requests",
"required": false
},
"MITOL_GOOGLE_SHEETS_REFUNDS_SKIP_ROW_COL": {
"description": "The zero-based index of the enrollment change sheet column that indicates whether the row should be skipped",
"required": false
},
"MITOL_HUBSPOT_API_ID_PREFIX": {
"description": "The prefix to use for hubspot unique_app_id field values",
"required": false
},
"MITOL_HUBSPOT_API_PRIVATE_TOKEN": {
"description": "Hubspot private token to authenticate with API",
"required": false
},
"MITOL_HUBSPOT_API_RETRIES": {
"description": "Number of times to retry a failed hubspot API request",
"required": false
},
"MITOL_PAYMENT_GATEWAY_CYBERSOURCE_ACCESS_KEY": {
"description": "CyberSource access key",
"required": false
},
"MITOL_PAYMENT_GATEWAY_CYBERSOURCE_MERCHANT_ID": {
"description": "CyberSource merchant ID",
"required": false
},
"MITOL_PAYMENT_GATEWAY_CYBERSOURCE_MERCHANT_SECRET": {
"description": "CyberSource merchant secret key",
"required": false
},
"MITOL_PAYMENT_GATEWAY_CYBERSOURCE_MERCHANT_SECRET_KEY_ID": {
"description": "CyberSource merchant secret key ID",
"required": false
},
"MITOL_PAYMENT_GATEWAY_CYBERSOURCE_PROFILE_ID": {
"description": "CyberSource profile ID",
"required": false
},
"MITOL_PAYMENT_GATEWAY_CYBERSOURCE_REST_API_ENVIRONMENT": {
"description": "CyberSource REST API Environment",
"required": false
},
"MITOL_PAYMENT_GATEWAY_CYBERSOURCE_SECURE_ACCEPTANCE_URL": {
"description": "CyberSource secure acceptance URL",
"required": false
},
"MITOL_PAYMENT_GATEWAY_CYBERSOURCE_SECURITY_KEY": {
"description": "CyberSource security key",
"required": false
},
"MITOL_SCIM_KEYCLOAK_BASE_URL": {
"description": "The base url for the upstream Keycloak service",
"required": false
},
"MITOL_SCIM_KEYCLOAK_BATCH_SIZE": {
"description": "Number of operations to send in a single batch request",
"required": false
},
"MITOL_SCIM_KEYCLOAK_BULK_OPERATIONS_COUNT": {
"description": "Number of operations to perform per bulk request",
"required": true
},
"MITOL_SCIM_KEYCLOAK_CLIENT_ID": {
"description": "The client id for the Keycloak service",
"required": false
},
"MITOL_SCIM_KEYCLOAK_CLIENT_SECRET": {
"description": "The client secret for the Keycloak service",
"required": false
},
"MITOL_SCIM_KEYCLOAK_SEARCH_BATCH_SIZE": {
"description": "Number of operations to send in a single search request",
"required": false
},
"MITOL_SCIM_REQUESTS_TIMEOUT_SECONDS": {
"description": "Number of seconds to timeout requests to Keycloak",
"required": false
},
"MITXONLINE_DOCKER_BASE_URL": {
"description": "Base url for the application when accessed from inside docker containers in the format PROTOCOL://HOSTNAME[:PORT]",
"required": false
},
"MITXONLINE_NEW_USER_LOGIN_URL": {
"description": "URL to redirect new users to after login",
"required": false
},
"MITX_ONLINE_ADMIN_EMAIL": {
"description": "E-mail to send 500 reports to.",
"required": true
},
"MITX_ONLINE_BASE_URL": {
"description": "Base url for the application in the format PROTOCOL://HOSTNAME[:PORT]",
"required": true
},
"MITX_ONLINE_DB_CONN_MAX_AGE": {
"description": "Maximum age of connection to Postgres in seconds",
"required": false
},
"MITX_ONLINE_DB_DISABLE_SSL": {
"description": "Disables SSL to postgres if set to True",
"required": false
},
"MITX_ONLINE_DB_DISABLE_SS_CURSORS": {
"description": "Disables Postgres server side cursors",
"required": false
},
"MITX_ONLINE_EMAIL_BACKEND": {
"description": "The default email backend to use for outgoing email. This is used in some places by django itself. See `NOTIFICATION_EMAIL_BACKEND` for the backend used for most application emails.",
"required": false
},
"MITX_ONLINE_EMAIL_HOST": {
"description": "Outgoing e-mail hostname",
"required": false
},
"MITX_ONLINE_EMAIL_PASSWORD": {
"description": "Outgoing e-mail auth password",
"required": false
},
"MITX_ONLINE_EMAIL_PORT": {
"description": "Outgoing e-mail port",
"required": false
},
"MITX_ONLINE_EMAIL_TLS": {
"description": "Outgoing e-mail TLS setting",
"required": false
},
"MITX_ONLINE_EMAIL_USER": {
"description": "Outgoing e-mail auth username",
"required": false
},
"MITX_ONLINE_ENVIRONMENT": {
"description": "The execution environment that the app is in (e.g. dev, staging, prod)",
"required": true
},
"MITX_ONLINE_FROM_EMAIL": {
"description": "E-mail to use for the from field",
"required": false
},
"MITX_ONLINE_LOG_LEVEL": {
"description": "The log level default",
"required": false
},
"MITX_ONLINE_NOTIFICATION_EMAIL_BACKEND": {
"description": "The email backend to use for application emails",
"required": false
},
"MITX_ONLINE_REFINE_MITX_ONLINE_DATASOURCE": {
"description": "open exchange app id for fetching currency exchange rate",
"required": false
},
"MITX_ONLINE_REFINE_OIDC_CONFIG_AUTHORITY": {
"description": "open exchange app id for fetching currency exchange rate",
"required": false
},
"MITX_ONLINE_REFINE_OIDC_CONFIG_CLIENT_ID": {
"description": "open exchange app id for fetching currency exchange rate",
"required": false
},
"MITX_ONLINE_REFINE_OIDC_CONFIG_REDIRECT_URI": {
"description": "Url to redirect the user to",
"required": false
},
"MITX_ONLINE_REGISTRATION_ACCESS_TOKEN": {
"description": "Access token to secure Open edX registration API with",
"required": false
},
"MITX_ONLINE_REPLY_TO_ADDRESS": {
"description": "E-mail to use for reply-to address of emails",
"required": false
},
"MITX_ONLINE_SECURE_REDIRECT_EXEMPT": {
"description": "Application-level SSL redirect exemption setting.",
"required": false
},
"MITX_ONLINE_SECURE_SSL_HOST": {
"description": "Hostame to redirect non-secure requests to. Overrides value from HOST header.",
"required": false
},
"MITX_ONLINE_SECURE_SSL_REDIRECT": {
"description": "Application-level SSL redirect setting.",
"required": false
},
"MITX_ONLINE_SITE_ID": {
"description": "The default site id for django sites framework",
"required": false
},
"MITX_ONLINE_SUPPORT_EMAIL": {
"description": "Email address listed for customer support in the frontend. Not used for sending email.",
"required": false
},
"MITX_ONLINE_USE_S3": {
"description": "Use S3 for storage backend (required on Heroku)",
"required": false
},
"MIT_LEARN_DASHBOARD_URL": {
"description": "Dashboard URL for UAI enrollment emails",
"required": false
},
"MIT_LEARN_FROM_EMAIL": {
"description": "From email address for UAI enrollment emails",
"required": false
},
"MIT_LEARN_REPLY_TO_EMAIL": {
"description": "Reply-to email address for UAI enrollment emails (defaults to MIT_LEARN_FROM_EMAIL)",
"required": false
},
"NEW_RELIC_APP_NAME": {
"description": "Application identifier in New Relic."
},
"NODE_MODULES_CACHE": {
"description": "If false, disables the node_modules cache to fix yarn install",
"value": "false"
},
"OAUTH2_PROVIDER_ALLOWED_REDIRECT_URI_SCHEMES": {
"description": "List of schemes allowed for oauth2 redirect URIs",
"required": false
},
"OIDC_RSA_PRIVATE_KEY": {
"description": "RSA private key for OIDC",
"required": false
},
"OPENEDX_API_BASE_URL": {
"description": "The base URL for the Open edX API",
"required": true
},
"OPENEDX_API_CLIENT_ID": {
"description": "The OAuth2 client id to connect to Open edX with",
"required": true
},
"OPENEDX_API_CLIENT_SECRET": {
"description": "The OAuth2 client secret to connect to Open edX with",
"required": true
},
"OPENEDX_BASE_REDIRECT_URL": {
"description": "The base redirect URL for an OAuth Application for the Open edX API",
"required": false
},
"OPENEDX_COURSES_SERVICE_WORKER_CLIENT_ID": {
"description": "OAuth2 client id for retirement service worker",
"required": false
},
"OPENEDX_COURSES_SERVICE_WORKER_CLIENT_SECRET": {
"description": "OAuth2 client secret for retirement service worker",
"required": false
},
"OPENEDX_COURSE_BASE_URL": {
"description": "The base URL to use to construct URLs to a course",
"required": false
},
"OPENEDX_OAUTH_APP_NAME": {
"description": "The 'name' value for the Open edX OAuth Application",
"required": true
},
"OPENEDX_OAUTH_PROVIDER": {
"description": "Social auth provider backend name",
"required": false
},
"OPENEDX_RETIREMENT_SERVICE_WORKER_CLIENT_ID": {
"description": "OAuth2 client id for retirement service worker",
"required": false
},
"OPENEDX_RETIREMENT_SERVICE_WORKER_CLIENT_SECRET": {
"description": "OAuth2 client secret for retirement service worker",
"required": false
},
"OPENEDX_SERVICE_WORKER_API_TOKEN": {
"description": "Active access token with staff level permissions to use with OpenEdX API client for service tasks",
"required": false
},
"OPENEDX_SERVICE_WORKER_USERNAME": {
"description": "Username of the user whose token has been set in OPENEDX_SERVICE_WORKER_API_TOKEN",
"required": false
},
"OPENEDX_SOCIAL_LOGIN_PATH": {
"description": "Open edX social auth login url",
"required": false
},
"OPENEDX_STUDIO_API_BASE_URL": {
"description": "The base URL for the Open edX Studio CMS API",
"required": true
},
"OPENEDX_TOKEN_EXPIRES_HOURS": {
"description": "The number of hours until an access token for the Open edX API expires",
"required": false
},
"OPENTELEMETRY_ENABLED": {
"description": "Enable collection and shipment of opentelemetry data",
"required": false
},
"OPENTELEMETRY_ENDPOINT": {
"description": "Endpoint for opentelemetry",
"required": false
},
"OPENTELEMETRY_EXPORT_TIMEOUT_MS": {
"description": "Timeout for opentelemetry export",
"required": false
},
"OPENTELEMETRY_INSECURE": {
"description": "Use insecure connection to opentelemetry",
"required": false
},
"OPENTELEMETRY_SERVICE_NAME": {
"description": "The name of the service to report to opentelemetry",
"required": false
},
"OPENTELEMETRY_TRACES_BATCH_SIZE": {
"description": "Batch size for traces",
"required": false
},
"OPEN_EXCHANGE_RATES_APP_ID": {
"description": "open exchange app id for fetching currency exchange rate",
"required": false
},
"OPEN_EXCHANGE_RATES_URL": {
"description": "open exchange api url for fetching currency exchange rate",
"required": false
},
"PGBOUNCER_DEFAULT_POOL_SIZE": {
"value": "50"
},
"PGBOUNCER_MIN_POOL_SIZE": {
"value": "5"
},
"POSTHOG_API_HOST": {
"description": "API host for PostHog",
"required": false
},
"POSTHOG_ENABLED": {
"description": "Whether PostHog is enabled",
"required": false
},
"POSTHOG_FEATURE_FLAG_REQUEST_TIMEOUT_MS": {
"description": "Timeout(MS) for PostHog feature flag requests.",
"required": false
},
"POSTHOG_MAX_RETRIES": {
"description": "Number of times that requests to PostHog should be retried after failing.",
"required": false
},
"POSTHOG_PROJECT_API_KEY": {
"description": "API token to communicate with PostHog",
"required": false
},
"RECAPTCHA_SECRET_KEY": {
"description": "The ReCaptcha secret key",
"required": false
},
"RECAPTCHA_SITE_KEY": {
"description": "The ReCaptcha site key",
"required": false
},
"REDISCLOUD_URL": {
"description": "RedisCloud connection url",
"required": false
},
"REDIS_URL": {
"description": "Redis URL for non-production use",
"required": false
},
"REFRESH_FEATURED_HOMEPAGE_ITEMS_FREQ": {
"description": "How many seconds between checking for featured items for the homepage in the local in memory cache",
"required": false
},
"REPAIR_OPENEDX_USERS_FREQUENCY": {
"description": "How many seconds between repairing openedx records for faulty users",
"required": false
},
"RETRY_FAILED_EDX_ENROLLMENT_FREQUENCY": {
"description": "How many seconds between retrying failed edX enrollments",
"required": false
},
"ROBOTS_CACHE_TIMEOUT": {
"description": "How long the robots.txt file should be cached",
"required": false
},
"SECRET_KEY": {
"description": "Django secret key.",
"generator": "secret",
"required": true
},
"SENTRY_DSN": {
"description": "The connection settings for Sentry",
"required": false
},
"SENTRY_LOG_LEVEL": {
"description": "The log level for Sentry",
"required": false
},
"SESSION_COOKIE_DOMAIN": {
"description": "Domain to set the session cookie to.",
"required": false
},
"SESSION_COOKIE_NAME": {
"description": "Name of the session cookie.",
"required": false
},
"SITE_NAME": {
"description": "Name of the site. e.g MITx Online",
"required": false
},
"SOCIAL_AUTH_OL_OIDC_KEY": {
"description": "The client id for the OIDC provider",
"required": false
},
"SOCIAL_AUTH_OL_OIDC_OIDC_ENDPOINT": {
"description": "The configuration endpoint for the OIDC provider",
"required": false
},
"SOCIAL_AUTH_OL_OIDC_SECRET": {
"description": "The client secret for the OIDC provider",
"required": false
},
"STATUS_TOKEN": {
"description": "Token to access the status API.",
"required": false
},
"UNIFIED_ECOMMERCE_API_KEY": {
"description": "The API key for Unified Ecommerce.",
"required": false
},
"UNIFIED_ECOMMERCE_URL": {
"description": "The base URL for Unified Ecommerce.",
"required": false
},
"USE_X_FORWARDED_HOST": {
"description": "Set HOST header to original domain accessed by user",
"required": false
},
"VERIFIABLE_CREDENTIAL_BEARER_TOKEN": {
"description": "The bearer token used to authenticate with the VC Signer service.",
"required": false
},
"VERIFIABLE_CREDENTIAL_DID":{
"description": "The Decentralized Identifier (DID) used as the issuer for verifiable credentials.",
"required": false
}
},
"keywords": [
"Django",
"Python",
"MIT",
"Office of Digital Learning"
],
"name": "mitx_online",
"repository": "https://github.com/mitodl/mitx-online",
"scripts": {
"postdeploy": "./manage.py migrate --noinput"
},
"success_url": "/",
"website": "https://github.com/mitodl/mitx-online"
}