-
Notifications
You must be signed in to change notification settings - Fork 82
/
Copy path.magento.env.yaml
544 lines (544 loc) · 63.8 KB
/
.magento.env.yaml
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
#######################################################################################################################
# SCD_THREADS - the number of threads for static content deployment. #
# Default value: 1 — Starter environments and Pro Integration environments #
# 3 — Pro Staging and Production environments #
# Magento Version: 2.1.4 and later #
# Stages: global, build and deploy #
# Example: #
# stage: #
# global: #
# SCD_THREADS: 2 #
#######################################################################################################################
# SCD_MATRIX - allows you to configure multiple locales per theme as long as the theme is not excluded using #
# the SCD_EXCLUDE_THEMES variable during deployment. This is ideal if you want to speed up the #
# deployment process by reducing the amount of unnecessary theme files. For example, you can deploy #
# the magento/backend theme in English and a custom theme in other languages. #
# Magento Version: 2.1.4 and later #
# Default value: not set #
# Stages: global, build and deploy #
# Examples: the following example deploys the magento/backend theme with three locales #
# stage: #
# deploy: #
# SCD_MATRIX: #
# "magento/backend": #
# language: #
# - en_US #
# - fr_FR #
# - af_ZA #
# Examples: also, you can choose to not deploy a theme #
# stage: #
# deploy: #
# SCD_MATRIX: #
# "magento/backend": [] #
#######################################################################################################################
# SCD_EXCLUDE_THEMES - Deprecated use SCD_MATRIX instead. #
# This option does not generate static content for the specified theme location(s). #
# This is helpful when static content deployment occurs during the build/deploy phase. #
# Use commas to separate multiple theme locations. #
# Magento Version: 2.1.4 and later #
# Default value: empty line #
# Stages: global, build and deploy #
# Example: #
# stage: #
# build: #
# SCD_EXCLUDE_THEMES: "magento/luma, magento/my-theme" #
#######################################################################################################################
# SCD_STRATEGY - allows you to customize the deployment strategy for static content. #
# Magento Version: 2.2.0 and later (Magento 2.1.* supports the standard strategy only) #
# Default value: quick #
# Possible values: #
# standard — deploys all static view files for all packages. #
# quick — minimizes deployment time. This is the default command option if not specified. #
# compact — conserves disk space on the server. #
# If you use compact, it overrides the value for SCD_THREADS with a value of 1. #
# This strategy does not work with multi-threads. #
# Stages: global, build and deploy #
# Example: #
# stage: #
# deploy: #
# SCD_STRATEGY: "compact" #
#######################################################################################################################
# SKIP_SCD - skips static content deployment during the build/deploy phase. #
# Magento Version: 2.1.4 and later #
# Default value: not set #
# Possible values: true or false #
# Stages: global, build and deploy #
# Example: #
# stage: #
# build: #
# SKIP_SCD: true #
#######################################################################################################################
# VERBOSE_COMMANDS - enables or disables the Symfony debug verbosity level for your logs. Be aware, #
# if you enable this verbosity, the logs will be deeply detailed. #
# Magento Version: 2.1.4 and later #
# Default value: not set #
# Possible values: #
# "-v" #
# "-vv" #
# "-vvv" #
# Stages: global, build and deploy #
# Example: #
# stage: #
# deploy: #
# VERBOSE_COMMANDS: "-vv" #
#######################################################################################################################
# SKIP_HTML_MINIFICATION - skip copying the static view files in the var/view_preprocessed directory #
# to reduce downtime when deploying to the Staging and Production environments #
# and generates minified HTML when requested. #
# Magento Version: 2.1.4 and later #
# Default value: true (prior to 2002.0.13 the default value was false) #
# Possible values: #
# false — copies the view_preprocessed directory to the <magento_root>/init/ directory at the end #
# of the build stage, and restores the directory in the <magento_root>/var directory #
# at the beginning of the deployment stage. #
# true — enables on-demand static content minification; #
# does not copy the <magento_root>var/view_preprocessed to the <magento_root>/init/ directory #
# at the end of the build stage. #
# Stages: global #
# Example: #
# stage: #
# global: #
# SKIP_HTML_MINIFICATION: true #
#######################################################################################################################
# SCD_ON_DEMAND - enable generation of static content when requested by a user. #
# Pre-loading the cache using the post_deploy hook reduces site downtime. #
# Magento Version: 2.1.4 and later #
# Default value: false #
# Possible values: true or false #
# Stages: global #
# Example: #
# stage: #
# global: #
# SCD_ON_DEMAND: true #
#######################################################################################################################
# SCD_COMPRESSION_LEVEL - specifies which gzip compression level (0 to 9) to use when compressing static content; #
# 0 disables compression. #
# Magento Version: 2.1.4 and later #
# Default value: 6 (build stage) or 4 (deploy stage) #
# Possible values: from 0 to 9 #
# Stages: global, build and deploy #
# Example: #
# stage: #
# deploy: #
# SCD_COMPRESSION_LEVEL: 5 #
#######################################################################################################################
# SCD_COMPRESSION_TIMEOUT - determine in seconds maximum time for running static compression command #
# by default this value is equal to 600 seconds. #
# Magento Version: 2.1.4 and later #
# Default value: 600 #
# Possible values: > 0 #
# Stages: global, build and deploy #
# Example: #
# stage: #
# deploy: #
# SCD_COMPRESSION_TIMEOUT: 800 #
#######################################################################################################################
# CLEAN_STATIC_FILES - cleans generated static files. By specifying the value of this configuration to 'false', #
# you can leave the static files which were generated during the previous deployment. #
# Magento Version: 2.1.4 and later #
# Default value: true #
# Possible values: true or false #
# Stage: deploy #
# Example: #
# stage: #
# deploy: #
# CLEAN_STATIC_FILES: false #
#######################################################################################################################
# STATIC_CONTENT_SYMLINK - generates symlinks for static content, unless you disable it #
# using this environment variable. This setting is vital in the Pro Production environment #
# for the three node cluster. When this variable is not set (disabled), it must copy every #
# file during the deployment, which increases deployment time. Setting SCD_ON_DEMAND to true #
# disables this variable. #
# Magento Version: 2.1.4 and later #
# Default value: true #
# Possible values: true or false #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# STATIC_CONTENT_SYMLINK: false #
#######################################################################################################################
# UPDATE_URLS - on deployment, replace Magento base URLs in the database with project URLs. #
# This is useful for local development, where base URLs are set up for your local environment. #
# When you deploy to a Cloud environment, we change the URLs so you can access your storefront #
# and Magento Admin using project URLs. #
# Magento Version: 2.1.4 and later #
# Default value: true #
# Possible values: true or false #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# UPDATE_URLS: false #
#######################################################################################################################
# GENERATED_CODE_SYMLINK - generates symlinks for the var/generation and var/di generated folders. #
# Magento Version: only 2.1.* #
# Default value: true #
# Possible values: true or false #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# GENERATED_CODE_SYMLINK: false #
#######################################################################################################################
# ENABLE_GOOGLE_ANALYTICS - Prevents the disabling of Google Analytics. By default, Google Analytics is enabled only #
# on Production environments. Set this value to true to enable Google Analytics on other environments as well. #
# Google Analytics is always enabled in Production. #
# Magento Version: 2.1.4 and later #
# Default value: false #
# Possible values: true or false #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# ENABLE_GOOGLE_ANALYTICS: false #
#######################################################################################################################
# MYSQL_USE_SLAVE_CONNECTION - set to true to automatically use a read-only connection to the database #
# to receive read-only traffic on a non-master node. This improves performance #
# through load balancing, because only one node needs to handle read-write traffic. #
# Magento Version: 2.1.4 and later #
# Default value: false #
# Possible values: true or false #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# MYSQL_USE_SLAVE_CONNECTION: true #
#######################################################################################################################
# REDIS_USE_SLAVE_CONNECTION - set to true to automatically use a read-only connection to a Redis instance #
# to receive read-only traffic on a non-master node. This improves performance #
# through load balancing because only one node needs to handle read-write traffic. #
# Magento Version: 2.1.4 and later #
# Default value: false #
# Possible values: true or false #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# REDIS_USE_SLAVE_CONNECTION: true #
#######################################################################################################################
# QUEUE_CONFIGURATION - use this environment variable to retain customized AMQP service settings between deployments. #
# Magento Version: 2.1.4 and later #
# Default value: not set #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# QUEUE_CONFIGURATION: #
# amqp: #
# host: test.host #
# port: 1234 #
# amqp2: #
# host: test.host2 #
# port: 12345 #
# mq: #
# host: mq.host #
# port: 1234 #
#######################################################################################################################
# SEARCH_CONFIGURATION - use this variable to retain customized search service settings between deployments. #
# Magento Version: 2.1.4 and later #
# Default value: not set #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# SEARCH_CONFIGURATION: #
# engine: elasticsearch #
# elasticsearch_server_hostname: hostname #
# elasticsearch_server_port: '123456' #
# elasticsearch_index_prefix: magento #
# elasticsearch_server_timeout: '15' #
#######################################################################################################################
# CRON_CONSUMERS_RUNNER - use this variable to make sure message queues are running after a deployment. #
# By default, the deployment process overwrites all settings in the env.php file #
# cron_run — a boolean value that enables or disables the consumers_runner cron job. #
# max_messages — a number specifying the maximum number of messages each consumer must #
# process before terminating. Although we do not recommend it, you can use 0 #
# to prevent the consumer from terminating. #
# consumers — an array of strings specifying which consumer(s) to run. #
# An empty array runs all consumers. #
# Magento Version: 2.2.0 and later #
# Default value: #
# cron_run = false #
# max_messages = 1000 #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# CRON_CONSUMERS_RUNNER: #
# cron_run: true #
# max_messages: 1000 #
# consumers: #
# - consumer1 #
# - consumer2 #
#######################################################################################################################
# CACHE_CONFIGURATION - use to configure Redis page and default caching. By default, the deployment process #
# overwrites all settings in the env.php file. When setting the cm_cache_backend_redis #
# parameter, you must specify the server, port, and database options. #
# Magento Version: Magento 2.1.4 and later #
# Default value: not set #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# CACHE_CONFIGURATION: #
# frontend: #
# default: #
# backend: file #
# page_cache: #
# backend: file #
#######################################################################################################################
# SESSION_CONFIGURATION - use to configure Redis session storage. You must specify the save, redis, host, port, #
# and database options for the session storage variable. #
# By default, the deployment process overwrites all settings in the env.php file. #
# Magento Version: Magento 2.1.4 and later #
# Default value: not set #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# SESSION_CONFIGURATION: #
# redis: #
# bot_first_lifetime: 100 #
# bot_lifetime: 10001 #
# database: 0 #
# disable_locking: 1 #
# host: redis.internal #
# max_concurrency: 10 #
# max_lifetime: 10001 #
# min_lifetime: 100 #
# port: 6379 #
# save: redis #
#######################################################################################################################
# DATABASE_CONFIGURATION - use to configure database connections. You must specify at least the default connection. #
# By default, the deployment process overwrites all settings in the env.php file. #
# In case when added option "_merge: true" setting are merging with default configuration. #
# #
# Magento Version: Magento 2.1.4 and later #
# Default value: not set #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# DATABASE_CONFIGURATION: #
# _merge: false # if true configuration merging with default #
# connection: #
# default: #
# username: user #
# host: host #
# dbname: magento #
# password: password #
# model: mysql4 #
# engine: innodb #
# initStatements: 'SET NAMES utf8;' #
# active: 1 #
# indexer: #
# username: user_indexer #
# host: host #
# dbname: magento #
# password: password #
# slave_connection: #
# default: #
# host: slave.host #
# username: slave.user #
# dbname: slave.name #
# password: slave.pswd #
# model: mysql4 #
# engine: innodb #
# initStatements: SET NAMES utf8 #
# active: 1 #
#######################################################################################################################
# RESOURCE_CONFIGURATION - use to map a resource name to a database connection. #
# By default, the deployment process overwrites all settings in the env.php file; #
# however, you can choose to merge one or more values for a service configuration without #
# overwriting all of the values. #
# #
# Set the _merge option to one of the following: #
# true - Merge the configured service values with the environment variable values. #
# false - Overwrite the configured service values with the environment variable values. #
# #
# Magento Version: Magento 2.1.4 and later #
# Default value: not set #
# Stages: deploy #
# Example: #
# stage: #
# deploy: #
# RESOURCE_CONFIGURATION: #
# _merge: false #
# default_setup: #
# connection: default #
#######################################################################################################################
# WARM_UP_PAGES - customize the list of pages used to preload the cache in the post_deploy stage. #
# Magento Version: Magento 2.1.4 and later #
# Default value: - "" (an array with one empty string item) #
# Stages: post-deploy #
# Example: #
# stage: #
# post-deploy: #
# WARM_UP_PAGES: #
# - "index.php" #
# - "index.php/customer/account/create" #
#######################################################################################################################
# X_FRAME_CONFIGURATION - customize X-Frame-Options header. #
# Magento Version: Magento 2.1.4 and later #
# Default value: - "" (empty) #
# Stages: global #
# Example: #
# stage: #
# global: #
# X_FRAME_CONFIGURATION: SAMEORIGIN #
#######################################################################################################################
# MIN_LOGGING_LEVEL - use to override the minimum logging level for all output streams without making changes #
# to the code. This helps to improve troubleshooting problems with deployment. For example, if #
# your deployment fails, you can use this variable to increase the logging granularity globally. #
# See Set up notifications—Log levels. #
# The min_level value in Logging handlers overwrites this setting. #
# Magento Version: Magento 2.1.4 and later #
# Default value: not set #
# Stages: global #
# Example: #
# stage: #
# global: #
# MIN_LOGGING_LEVEL: debug #
#######################################################################################################################
# Set up notifications. #
# Optionally, you can send logs to a messaging system, such as Slack and email, to receive real-time notifications. #
# #
# Slack configuration: #
# #
# log: #
# slack: #
# token: "<your-slack-token>" #
# channel: "<your-slack-channel>" #
# username: "SlackHandler" #
# min_level: "info" #
# #
# token — your Slack user token. Your user token authorizes Magento Commerce (Cloud) to send messages. #
# channel — name of the Slack channel Magento Commerce (Cloud) sends notifications. #
# username — username Magento Commerce (Cloud) uses to send notification messages in Slack. #
# min_level — minimum log level for notification messages. We recommend using info. #
# #
# Email configuration: #
# #
# log: #
# email: #
# to: <your-email> #
# from: <your-email> #
# subject: "Log notification from Magento Cloud" #
# min_level: "notice" #
# #
# to — email address Magento Commerce (Cloud) sends notification messages. #
# from — email address for sending notification messages to recipients. #
# subject — description of the email. #
# min_level — minimum log level for notification messages. We recommend using notice or warning. #
# #
# Logging handlers #
# You can configure logging handlers to send messages to a remote logging server. Logging handler pushes build #
# and deploy logs to other systems, similarly to the way you can push logs to Slack and email. Simply enable a syslog #
# handler, which is ideal for logging messages related to hardware, or a Graylog Extended Log Format (GELF) handler, #
# which is ideal for logging messages from software applications. #
# #
# Log levels: #
# debug — detailed debug information. #
# info — interesting events. For example, a user logs in, SQL logs, etc. #
# notice — normal but significant events. #
# warning — exceptional occurrences that are not errors. For example, use of deprecated APIs, poor use of an API, #
# undesirable things that are not necessarily wrong. #
# error — runtime errors that don’t require immediate action but should be logged and monitored. #
# critical — critical conditions. For example, an unavailable application component, unexpected exceptions. #
# alert — action must be taken immediately. For example, your website is down, the database is unavailable, etc. #
# This should trigger SMS alerts and wake you up. #
# emergency — the system is unusable. #
# #
# To configure logging handlers to send messages to a remote logging server. Logging handler pushes build and deploy #
# logs to other systems, similarly to the way you can push logs to Slack and email. Simply enable a syslog #
# handler, which is ideal for logging messages related to hardware, or a Graylog Extended Log Format (GELF) handler, #
# which is ideal for logging messages from software applications. #
# #
#log: #
# syslog: #
# ident: "<syslog-ident>" #
# facility: 8 # http://php.net/manual/en/network.constants.php #
# min_level: "info" #
# logopts: <syslog-logopts> #
# syslog_udp: #
# host: "<syslog-host>" #
# port: <syslog-port> #
# facility: 8 # http://php.net/manual/en/network.constants.php #
# ident: "<syslog-ident>" #
# min_level: "info" #
# gelf: #
# min_level: "info" #
# use_default_formatter: true #
# additional: # Some additional information for each log message #
# project: "<some-project-id>" #
# app_id: "<some-app-id>" #
# transport: #
# http: #
# host: "<http-host>" #
# port: <http-port> #
# path: "<http-path>" #
# connection_timeout: 60 #
# tcp: #
# host: "<tcp-host>" #
# port: <tcp-port> #
# connection_timeout: 60 #
# udp: #
# host: "<udp-host>" #
# port: <udp-port> #
# chunk_size: 1024 #
#######################################################################################################################
# ENV_RELATIONSHIPS - Environment variable used to get services relationships. #
# Magento Version: Magento 2.1.4 and later #
# Default value: - "MAGENTO_CLOUD_RELATIONSHIPS" #
# Section: variables #
# Example: #
# system: #
# variables: #
# ENV_RELATIONSHIPS: "MAGENTO_CLOUD_RELATIONSHIPS" #
#######################################################################################################################
# ENV_ROUTES - Environment variable used to get routes. #
# Magento Version: Magento 2.1.4 and later #
# Default value: - "MAGENTO_CLOUD_ROUTES" #
# Section: variables #
# Example: #
# system: #
# variables: #
# ENV_ROUTES: "MAGENTO_CLOUD_ROUTES" #
#######################################################################################################################
# ENV_VARIABLES - Environment variable used to get variables. #
# Magento Version: Magento 2.1.4 and later #
# Default value: - "MAGENTO_CLOUD_VARIABLES" #
# Section: variables #
# Example: #
# system: #
# variables: #
# ENV_VARIABLES: "MAGENTO_CLOUD_VARIABLES" #
#######################################################################################################################
# ENV_APPLICATION - Environment variable used to get application configuration #
# Magento Version: Magento 2.1.4 and later #
# Default value: - "MAGENTO_CLOUD_APPLICATION" #
# Section: variables #
# Example: #
# system: #
# variables: #
# ENV_APPLICATION: "MAGENTO_CLOUD_APPLICATION" #
#######################################################################################################################
# ENV_MODE - Environment variable used to get application mode. #
# Magento Version: Magento 2.1.4 and later #
# Default value: - "MAGENTO_CLOUD_MODE" #
# Section: variables #
# Example: #
# system: #
# variables: #
# ENV_MODE: "MAGENTO_CLOUD_MODE" #
#######################################################################################################################
# ENV_ENVIRONMENT - Environment variable used to get application environment. #
# Magento Version: Magento 2.1.4 and later #
# Default value: - "MAGENTO_CLOUD_ENVIRONMENT" #
# Section: variables #
# Example: #
# system: #
# variables: #
# ENV_ENVIRONMENT: "MAGENTO_CLOUD_ENVIRONMENT" #
#######################################################################################################################