configs.yml
configs.yml includes configuration variables of your openedx instance
​
​
1
# Koa configuration
2
# Run this command in deployer node
3
# $ ansible-playbook configuration/playbooks/koa.yml [email protected]/configs.yml
4
# tags: install:configuration install:app-requirements install edxapp_cfg
5
​
6
---
7
host: "OPENEDX-INSTANCE-NAME" # Should be same as what you have in infra/hosts # SET-ME
8
date: "{{ lookup('pipe', 'date +%Y%m%d-%H%M') }}"
9
## Repos
10
edxapp_server: OPENEDX-INSTANCE-NAME # Should be same as what you have in infra/hosts # SET-ME
11
DOMAIN_NAME: "YOUR-DOMAIN-NAME" # SET-ME
12
EDXAPP_IMPORT_EXPORT_BUCKET: "{{ EDXAPP_AWS_STORAGE_BUCKET_NAME }}"
13
EDXAPP_LMS_MAX_REQ: 1000
14
​
15
RABBIT_USERS:
16
- name: 'admin'
17
password: "{{ RABBIT_ADMIN_PASSWORD }}"
18
- name: 'edx'
19
password: "{{ XQUEUE_RABBITMQ_PASS }}"
20
- name: 'celery'
21
password: "{{ EDXAPP_CELERY_PASSWORD }}"
22
​
23
EDX_ANSIBLE_DUMP_VARS: true
24
## Versions
25
edx_platform_repo: "open-release/koa.master"
26
EDX_PLATFORM_VERSION: "open-release/koa.master"
27
forum_version: "open-release/koa.master"
28
XQUEUE_VERSION: "open-release/koa.master"
29
certs_version: "open-release/koa.master"
30
OPENEDX_RELEASE: "open-release/koa.master"
31
configuration_version: "open-release/koa.master"
32
demo_version: "open-release/koa.master"
33
NOTIFIER_VERSION: "open-release/koa.master"
34
INSIGHTS_VERSION: "open-release/koa.master"
35
ANALYTICS_API_VERSION: "open-release/koa.master"
36
ECOMMERCE_WORKER_VERSION: "open-release/koa.master"
37
PROGRAMS_VERSION: "open-release/koa.master"
38
NOTIFIER_GIT_IDENTITY: ""
39
OAUTH_OIDC_ISSUER: "http://{{ EDXAPP_LMS_BASE }}/oauth2"
40
migrate_db: "yes"
41
INSTALL_DEMO_DATA: false
42
demo_test_and_staff_users: ['']
43
EDXAPP_FEATURES:
44
AUTH_USE_OPENID_PROVIDER: true
45
ENABLE_OAUTH2_PROVIDER: true
46
ALLOW_ALL_ADVANCED_COMPONENTS: true
47
ENABLE_DISCUSSION_HOME_PANEL: true
48
ENABLE_LTI_PROVIDER: true
49
ENABLE_SYSADMIN_DASHBOARD: false
50
CERTIFICATES_ENABLED: true
51
ENABLE_DISCUSSION_SERVICE: true
52
ENABLE_INSTRUCTOR_ANALYTICS: true
53
PREVIEW_LMS_BASE: "{{ EDXAPP_PREVIEW_LMS_BASE }}"
54
ENABLE_S3_GRADE_DOWNLOADS: true
55
USE_CUSTOM_THEME: true
56
ENABLE_MKTG_SITE: "{{ EDXAPP_ENABLE_MKTG_SITE }}"
57
AUTOMATIC_AUTH_FOR_TESTING: false
58
ENABLE_THIRD_PARTY_AUTH: true
59
#search features in CMS
60
ENABLE_COURSEWARE_INDEX: true
61
ENABLE_LIBRARY_INDEX: true
62
#search features in LMS
63
ENABLE_COURSEWARE_SEARCH: true
64
ENABLE_COURSEWARE_SEARCH_FOR_COURSE_STAFF: true
65
ENABLE_DASHBOARD_SEARCH: true
66
ENABLE_COURSE_DISCOVERY: true
67
ENABLE_COMBINED_LOGIN_REGISTRATION: true
68
ALLOW_HIDING_DISCUSSION_TAB: true
69
#for prereqs
70
MILESTONES_APP: true
71
ENABLE_PREREQUISITE_COURSES: true
72
#for bulk email
73
ENABLE_INSTRUCTOR_EMAIL: true
74
REQUIRE_COURSE_EMAIL_AUTH: true
75
# to avoid non staff user creating courses in studio
76
DISABLE_COURSE_CREATION: true
77
ENTRANCE_EXAMS: true
78
CERTIFICATES_HTML_VIEW: true
79
ENABLE_MOBILE_REST_API: true
80
THIRD_PARTY_AUTH_HINT: ""
81
LTI_1P3_ENABLED: true
82
ALLOW_PUBLIC_ACCOUNT_CREATION: true
83
ENABLE_COOKIE_CONSENT: true
84
SHOW_HEADER_LANGUAGE_SELECTOR: true
85
ENABLE_FORUM_DAILY_DIGEST: true
86
ENABLE_VERIFIED_CERTIFICATES: true
87
ENABLE_MAX_FAILED_LOGIN_ATTEMPTS: false
88
PREVENT_CONCURRENT_LOGINS: false
89
ENABLE_PREREQUISITE_COURSES: false
90
LICENSING: false
91
ENABLE_VIDEO_BUMPER: true
92
ENABLE_SPECIAL_EXAMS: true
93
ALLOW_EMAIL_ADDRESS_CHANGE: false
94
ENABLE_PASSWORD_RESET_FAILURE_EMAIL: true
95
STUDIO_REQUEST_EMAIL: "YOUR-EMAIL" # SET-ME
96
SKIP_EMAIL_VALIDATION: true
97
​
98
EDXAPP_CERTIFICATE_TEMPLATE_LANGUAGES:
99
'en': 'English'
100
'es': 'EspaΓ±ol'
101
​
102
EDXAPP_SOCIAL_SHARING_SETTINGS:
103
CUSTOM_COURSE_URLS: true
104
DASHBOARD_FACEBOOK: true
105
CERTIFICATE_FACEBOOK: true
106
CERTIFICATE_TWITTER: true
107
DASHBOARD_TWITTER: true
108
109
EDXAPP_LEARNING_MICROFRONTEND_URL: "http://learning-mfe"
110
EDXAPP_DEFAULT_MOBILE_AVAILABLE: true
111
EDXAPP_ANALYTICS_DASHBOARD_URL: ""
112
EDXAPP_PLATFORM_NAME: "" # SET-ME
113
EDXAPP_PLATFORM_DESCRIPTION: "" # SET-ME
114
EDXAPP_PLATFORM_TWITTER_ACCOUNT: "" # SET-ME
115
EDXAPP_PLATFORM_FACEBOOK_ACCOUNT: "" # SET-ME
116
EDXAPP_EXTRA_REQUIREMENTS: [] # If you need to install XBlock here is where you can do it
117
EDXAPP_LANGUAGE_CODE : 'en'
118
EDXAPP_ENV_EXTRA:
119
COURSE_MODE_DEFAULTS:
120
name: 'Honor'
121
slug: 'honor'
122
currency: 'usd'
123
min_price: 0
124
suggested_prices: ''
125
bulk_sku: !!null
126
sku: !!null
127
description: !!null
128
expiration_datetime: !!null
129
​
130
EDXAPP_AUTH_PASSWORD_VALIDATORS:
131
- NAME: 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator'
132
- NAME: 'util.password_policy_validators.MinimumLengthValidator'
133
OPTIONS:
134
min_length: 8
135
- NAME: 'util.password_policy_validators.MaximumLengthValidator'
136
OPTIONS:
137
max_length: 75
138
- NAME: 'util.password_policy_validators.AlphabeticValidator'
139
OPTIONS:
140
min_alphabetic: 2
141
- NAME: 'util.password_policy_validators.NumericValidator'
142
OPTIONS:
143
min_numeric: 1
144
- NAME: 'util.password_policy_validators.UppercaseValidator'
145
OPTIONS:
146
min_upper: 1
147
​
148
EDXAPP_PASSWORD_POLICY_COMPLIANCE_ROLLOUT_CONFIG:
149
ENFORCE_COMPLIANCE_ON_LOGIN: true
150
​
151
EDXAPP_MKTG_URL_LINK_MAP: ""
152
CMS_HOSTNAME: "{{ EDXAPP_CMS_BASE }}" #for redirect within nginx
153
COMMON_ENABLE_BASIC_AUTH: false
154
EDXAPP_SESSION_COOKIE_SECURE: true
155
EDXAPP_CSRF_COOKIE_SECURE: true
156
DISCOVERY_URL_ROOT: 'http://localhost:{{ DISCOVERY_NGINX_PORT }}'
157
# ## Base
158
EDXAPP_LMS_BASE: "LMS-URL" # SET-ME
159
EDXAPP_CMS_BASE: "STUDIO-URL" # SET-ME
160
EDXAPP_PREVIEW_LMS_BASE: "PREVIEW-URL" # SET-ME
161
## Site names
162
EDXAPP_SITE_NAME: ""
163
EDXAPP_LMS_SITE_NAME: "{{ EDXAPP_LMS_BASE }}"
164
EDXAPP_CMS_SITE_NAME: "{{ EDXAPP_CMS_BASE }}"
165
​
166
# ## Social media
167
EDXAPP_YOUTUBE_API_KEY: ""
168
COMMON_DEPLOYMENT: "prod-koa"
169
COMMON_ENVIRONMENT: "openedx"
170
## Email addresses
171
EDXAPP_CONTACT_EMAIL: "YOUR-EMAIL" # SET-ME
172
EDXAPP_DEFAULT_FEEDBACK_EMAIL: "{{EDXAPP_CONTACT_EMAIL}}"
173
EDXAPP_DEFAULT_FROM_EMAIL: "{{EDXAPP_CONTACT_EMAIL}}"
174
EDXAPP_BUGS_EMAIL: "{{EDXAPP_CONTACT_EMAIL}}"
175
EDXAPP_BULK_EMAIL_DEFAULT_FROM_EMAIL: "{{EDXAPP_CONTACT_EMAIL}}"
176
EDXAPP_PAYMENT_SUPPORT_EMAIL: "{{EDXAPP_CONTACT_EMAIL}}"
177
EDXAPP_PRESS_EMAIL: "{{EDXAPP_CONTACT_EMAIL}}"
178
EDXAPP_TECH_SUPPORT_EMAIL: "{{EDXAPP_CONTACT_EMAIL}}"
179
EDXAPP_FEEDBACK_SUBMISSION_EMAIL: "{{EDXAPP_CONTACT_EMAIL}}"
180
EDXAPP_UNIVERSITY_EMAIL: "{{EDXAPP_CONTACT_EMAIL}}"
181
EDXAPP_CONTACT_MAILING_ADDRESS: "{{EDXAPP_CONTACT_EMAIL}}"
182
​
183
## Email backend
184
EDXAPP_EMAIL_BACKEND: "django.core.mail.backends.smtp.EmailBackend"
185
EDXAPP_EMAIL_HOST: "" # SET-ME
186
EDXAPP_EMAIL_PORT: 587 # SET-ME
187
EDXAPP_EMAIL_HOST_USER: "" # SET-ME
188
EDXAPP_EMAIL_HOST_PASSWORD: "" # SET-ME
189
EDXAPP_EMAIL_HOST: "" # SET-ME
190
EDXAPP_EMAIL_PORT: 2525 # SET-ME
191
EDXAPP_EMAIL_HOST_USER: "" # SET-ME
192
EDXAPP_EMAIL_HOST_PASSWORD: "" # SET-ME
193
EDXAPP_EMAIL_USE_TLS: true
194
EDXAPP_ACE_CHANNEL_DEFAULT_EMAIL: "django_email"
195
EDXAPP_ACE_CHANNEL_SAILTHRU_DEBUG: false
196
EDXAPP_ACE_CHANNEL_SAILTHRU_TEMPLATE_NAME: "template"
197
EDXAPP_ACE_CHANNEL_TRANSACTIONAL_EMAIL: "django_email"
198
EDXAPP_ACE_ENABLED_CHANNELS: ["django_email"]
199
EDXAPP_ACE_ENABLED_POLICIES: ["bulk_email_optout"]
200
​
201
# AWS S3 configuration
202
EDXAPP_AWS_ACCESS_KEY_ID: "" # SET-ME
203
EDXAPP_AWS_SECRET_ACCESS_KEY: "" # SET-ME
204
EDXAPP_AWS_STORAGE_BUCKET_NAME: "{{ COMMON_ENVIRONMENT }}-{{ COMMON_DEPLOYMENT }}-bucket"
205
EDXAPP_AWS_S3_CUSTOM_DOMAIN: "s3-us-west-1.amazonaws.com/{{ EDXAPP_AWS_STORAGE_BUCKET_NAME }}" # change to {s3-[bucket-region].amazon...} if you specify anything other than "global" (the default setting) as an S3 location
206
EDXAPP_DEFAULT_FILE_STORAGE: "storages.backends.s3boto.S3BotoStorage"
207
​
208
#grade downloads
209
EDXAPP_GRADE_BUCKET: "{{ EDXAPP_AWS_STORAGE_BUCKET_NAME }}"
210
EDXAPP_GRADE_STORAGE_TYPE: "S3"
211
EDXAPP_GRADE_ROOT_PATH: "grades"
212
​
213
# ora2 bucket
214
EDXAPP_FILE_UPLOAD_STORAGE_BUCKET_NAME: "{{ EDXAPP_AWS_STORAGE_BUCKET_NAME }}"
215
​
216
# profile images upload in s3
217
EDXAPP_PROFILE_IMAGE_BACKEND:
218
class: openedx.core.storage.OverwriteStorage
219
options:
220
location: "{{ edxapp_media_dir }}/profile-images/"
221
base_url: "{{ EDXAPP_MEDIA_URL }}/profile-images/"
222
​
223
EDXAPP_REGISTRATION_EXTRA_FIELDS:
224
level_of_education: "hidden"
225
gender: "required"
226
year_of_birth: "hidden"
227
mailing_address: "hidden"
228
goals: "hidden"
229
honor_code: "hidden"
230
terms_of_service: "hidden"
231
city: "hidden"
232
country: "required"
233
state: "hidden"
234
department: "required"
235
institution: "required"
236
unit: "required"
237
position: "required"
238
​
239
EDXAPP_WORKERS:
240
lms: 4
241
cms: 2
242
​
243
# time zone
244
TIME_ZONE: 'America/Vancouver' # SET-ME
245
ANALYTICS_API_TIME_ZONE: "{{ TIME_ZONE }}"
246
COURSE_DISCOVERY_TIME_ZONE: "{{ TIME_ZONE }}"
247
CREDENTIALS_TIME_ZONE: "{{ TIME_ZONE }}"
248
DISCOVERY_TIME_ZONE: "{{ TIME_ZONE }}"
249
ECOMMERCE_TIME_ZONE: "{{ TIME_ZONE }}"
250
EDXAPP_TIME_ZONE: "{{ TIME_ZONE }}"
251
INSIGHTS_TIME_ZONE: "{{ TIME_ZONE }}"
252
PROGRAMS_TIME_ZONE: "{{ TIME_ZONE }}"
253
​
254
# oauth/https settings
255
EDXAPP_OAUTH_ENFORCE_SECURE: true
256
FORUM_SINATRA_ENV: "production"
257
FORUM_RACK_ENV: "production"
258
NOTIFIER_DIGEST_EMAIL_SENDER: "{{EDXAPP_DEFAULT_FROM_EMAIL}}"
259
NOTIFIER_DIGEST_EMAIL_SUBJECT: "Daily Discussion Digest"
260
NOTIFIER_DIGEST_EMAIL_TITLE: "Discussion Digest"
261
NOTIFIER_DIGEST_EMAIL_DESCRIPTION: "A digest of unread content from course discussions you are following."
262
NOTIFIER_ENV: "Production"
263
NOTIFIER_EMAIL_BACKEND: "smtp"
264
NOTIFIER_EMAIL_HOST: "{{ EDXAPP_EMAIL_HOST }}"
265
NOTIFIER_EMAIL_PORT: "{{ EDXAPP_EMAIL_PORT }}"
266
NOTIFIER_EMAIL_USER: "{{ EDXAPP_EMAIL_HOST_USER }}"
267
NOTIFIER_EMAIL_PASS: "{{ EDXAPP_EMAIL_HOST_PASSWORD }}"
268
NOTIFIER_EMAIL_USE_TLS: "{{ EDXAPP_EMAIL_USE_TLS }}"
269
NOTIFIER_LMS_URL_BASE: "http://{{ EDXAPP_LMS_BASE }}"
270
NOTIFIER_LMS_SECRET_KEY: "{{ EDXAPP_EDX_API_KEY }}"
271
NOTIFIER_COMMENT_SERVICE_BASE: "http://localhost:{{ FORUM_NGINX_PORT }}"
272
NOTIFIER_USER_SERVICE_BASE: "http://localhost:8000"
273
NOTIFIER_USER_SERVICE_API_KEY: "{{ EDXAPP_EDX_API_KEY }}"
274
NOTIFIER_USER_SERVICE_HTTP_AUTH_USER: "edx" # you must create a new user in the edx-platform for this
275
NOTIFIER_USER_SERVICE_HTTP_AUTH_PASS: "edx"
276
NOTIFIER_CELERY_BROKER_URL: "django://"
277
NOTIFIER_LOGO_IMAGE_URL: "{{ NOTIFIER_LMS_URL_BASE }}/static/images/header-logo.png" # this will vary depending on the theme
278
NOTIFIER_SUPERVISOR_LOG_DEST: "{{ COMMON_DATA_DIR }}/log/supervisor"
279
EDXAPP_MONGO_USER: 'edxapp'
280
EDXAPP_MONGO_DB_NAME: 'edxapp'
281
FORUM_MONGO_USER: "cs_comments_service"
282
FORUM_MONGO_DATABASE: "cs_comments_service"
283
MONGO_ADMIN_USER: 'admin'
284
MONGO_USERS:
285
- user: "{{ FORUM_MONGO_USER }}"
286
password: "{{FORUM_MONGO_PASSWORD}}"
287
database: "{{ FORUM_MONGO_DATABASE }}"
288
roles: readWrite
289
- user: "{{ EDXAPP_MONGO_USER }}"
290
password: "{{EDXAPP_MONGO_PASSWORD}}"
291
database: "{{ EDXAPP_MONGO_DB_NAME }}"
292
roles: readWrite
293
​
294
EDXAPP_LOGIN_REDIRECT_WHITELIST: ["{{EDXAPP_CMS_BASE}}"]
295
EDXAPP_SESSION_COOKIE_DOMAIN: "" # SET-ME Something like .DOMAIN-NAME don't forget "." before the domain name
296
COMMON_HTPASSWD_USER: "user"
297
EDXAPP_MYSQL_CSMH_USER: "edxapp_cmsh001"
298
​
299
​
300
# Secrets
301
MYSQL_ROOT_PASSWORD: "{{ SECRET_MYSQL_ROOT_PASSWORD }}"
302
COMMON_HTPASSWD_PASS: "{{SECRET_COMMON_HTPASSWD_PASS}}"
303
COMMON_MONGO_READ_ONLY_PASS: "{{SECRET_COMMON_MONGO_READ_ONLY_PASS}}"
304
COMMON_MYSQL_ADMIN_PASS: "{{SECRET_COMMON_MYSQL_ADMIN_PASS}}"
305
COMMON_MYSQL_MIGRATE_PASS: "{{SECRET_COMMON_MYSQL_MIGRATE_PASS}}"
306
COMMON_MYSQL_READ_ONLY_PASS: "{{SECRET_COMMON_MYSQL_READ_ONLY_PASS}}"
307
EDXAPP_CELERY_PASSWORD: "{{SECRET_EDXAPP_CELERY_PASSWORD}}"
308
EDXAPP_COMMENTS_SERVICE_KEY: "{{ SECRET_EDXAPP_COMMENTS_SERVICE_KEY }}"
309
EDXAPP_MYSQL_CSMH_PASSWORD: "{{SECRET_EDXAPP_MYSQL_CSMH_PASSWORD}}"
310
EDXAPP_MYSQL_PASSWORD: "{{SECRET_EDXAPP_MYSQL_PASSWORD}}"
311
EDXAPP_MYSQL_PASSWORD_ADMIN: "{{SECRET_EDXAPP_MYSQL_PASSWORD_ADMIN}}"
312
EDXAPP_MYSQL_PASSWORD_READ_ONLY: "{{SECRET_EDXAPP_MYSQL_PASSWORD_READ_ONLY}}"
313
FORUM_API_KEY: "{{SECRET_FORUM_API_KEY}}"
314
MARIADB_CLUSTER_PASSWORD_ADMIN: "{{SECRET_MARIADB_CLUSTER_PASSWORD_ADMIN}}"
315
MONGO_ADMIN_PASSWORD: "{{SECRET_MONGO_ADMIN_PASSWORD}}"
316
mongo_admin_password: "{{ MONGO_ADMIN_PASSWORD }}"
317
NOTIFIER_COMMENT_SERVICE_API_KEY: "{{ FORUM_API_KEY }}"
318
XQUEUE_BASIC_AUTH_PASSWORD: "{{SECRET_XQUEUE_BASIC_AUTH_PASSWORD}}"
319
XQUEUE_BASIC_AUTH_USER: "{{SECRET_XQUEUE_BASIC_AUTH_USER}}"
320
XQUEUE_MYSQL_PASSWORD: "{{SECRET_XQUEUE_MYSQL_PASSWORD}}"
321
XQUEUE_RABBITMQ_PASS: "{{SECRET_XQUEUE_RABBITMQ_PASS}}"
322
RABBIT_ADMIN_PASSWORD: "{{SECRET_RABBIT_ADMIN_PASSWORD}}"
323
EDXAPP_EDXAPP_SECRET_KEY: "{{SECRET_EDXAPP_EDXAPP_SECRET_KEY}}"
324
EDXAPP_MONGO_PASSWORD: "{{SECRET_EDXAPP_MONGO_PASSWORD}}"
325
FORUM_MONGO_PASSWORD: "{{SECRET_FORUM_MONGO_PASSWORD}}"
326
EDXAPP_AWS_SECRET_ACCESS_KEY: "{{ SECRET_EDXAPP_AWS_SECRET_ACCESS_KEY }}"
Copied!
Last modified 4mo ago
Copy link