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
|
<?xml version="1.0" encoding="utf-8" ?>
<result>
<row>
<pluginName>CoreUpdater</pluginName>
<title>Update settings</title>
<settings>
<row>
<name>release_channel</name>
<title />
<value>latest_stable</value>
<defaultValue>latest_stable</defaultValue>
<type>string</type>
<uiControl>radio</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues>
<latest_stable>Latest stable release (Recommended)</latest_stable>
<latest_beta>Latest beta release</latest_beta>
<latest_2x_stable>Latest stable 2.X (Long Term Support version)</latest_2x_stable>
<latest_2x_beta>Latest beta 2.X (Long Term Support version)</latest_2x_beta>
</availableValues>
<description />
<inlineHelp>While our <a href='?module=Proxy&action=redirect&url=https://matomo.org/participate/development-process/' target='_blank'>development process</a> includes thousands of automated tests, Beta Testers play a key role in achieving the "No bug policy" in Matomo.<br/>If Matomo is a critical part of your business, we recommend you use the latest stable release. If you use the latest beta and you find a bug or have a suggestion, please <a href='?module=Proxy&action=redirect&url=https%3A%2F%2Fdeveloper.matomo.org%2Fguides%2Fcore-team-workflow%23influencing-piwik-development' target='_blank'>see here</a>.<br />LTS (Long Term Support) versions receive only security and bug fixes.</inlineHelp>
<templateFile />
<introduction>Release channel</introduction>
<condition />
</row>
<row>
<name>enable_plugin_update_communication</name>
<title />
<value>1</value>
<defaultValue>1</defaultValue>
<type>boolean</type>
<uiControl>radio</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues>
<row key="1">Yes (Default)</row>
<row key="0">No</row>
</availableValues>
<description />
<inlineHelp>An email will be sent to Super Users when there is a new version available for a plugin.</inlineHelp>
<templateFile />
<introduction>Send an email when a plugin update is available</introduction>
<condition />
</row>
</settings>
</row>
<row>
<pluginName>ExampleSettingsPlugin</pluginName>
<title>ExampleSettingsPlugin</title>
<settings>
<row>
<name>metric</name>
<title>Metric to display</title>
<value>nb_visits</value>
<defaultValue>nb_visits</defaultValue>
<type>string</type>
<uiControl>select</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues>
<nb_visits>Visits</nb_visits>
<nb_actions>Actions</nb_actions>
<visitors>Visitors</visitors>
</availableValues>
<description>Choose the metric that should be displayed in the browser tab</description>
<inlineHelp />
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>browsers</name>
<title>Supported Browsers</title>
<value>
<row>firefox</row>
<row>chromium</row>
<row>safari</row>
</value>
<defaultValue>
<row>firefox</row>
<row>chromium</row>
<row>safari</row>
</defaultValue>
<type>array</type>
<uiControl>multiselect</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues>
<firefox>Firefox</firefox>
<chromium>Chromium</chromium>
<safari>safari</safari>
</availableValues>
<description>The value will be only displayed in the following browsers</description>
<inlineHelp />
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>description</name>
<title>Description for value</title>
<value>This is the value:
Another line</value>
<defaultValue>This is the value:
Another line</defaultValue>
<type>string</type>
<uiControl>textarea</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues />
<description>This description will be displayed next to the value</description>
<inlineHelp />
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>password</name>
<title>API password</title>
<value />
<defaultValue />
<type>string</type>
<uiControl>password</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues />
<description>Password for the 3rd API where we fetch the value</description>
<inlineHelp />
<templateFile />
<introduction />
<condition />
</row>
</settings>
</row>
<row>
<pluginName>AnonymousPiwikUsageMeasurement</pluginName>
<title>AnonymousPiwikUsageMeasurement</title>
<settings>
<row>
<name>canUserOptOut</name>
<title>Let users disable anonymous tracking</title>
<value>1</value>
<defaultValue>1</defaultValue>
<type>boolean</type>
<uiControl>checkbox</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues />
<description>If enabled, logged in users can opt out in their plugin settings. Anonymous users cannot opt out.</description>
<inlineHelp />
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>trackToPiwik</name>
<title>Send usage data to Matomo.org</title>
<value>0</value>
<defaultValue>1</defaultValue>
<type>boolean</type>
<uiControl>checkbox</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues />
<description>If enabled, anonymized usage data will be sent to demo-anonymous.matomo.org and the tracked data can be viewed there (the data is public). The collected data is used to improve Matomo. Thank you for making Matomo better!</description>
<inlineHelp />
<templateFile />
<introduction>Send anonmyized usage data to the creators of Matomo</introduction>
<condition />
</row>
<row>
<name>ownPiwikSiteId</name>
<title>Site Id</title>
<value>0</value>
<defaultValue>0</defaultValue>
<type>integer</type>
<uiControl>text</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues />
<description>If specified, anonymized usage data will be sent to the specified site in this Matomo. This lets you analyze how you and your colleagues are using Matomo.</description>
<inlineHelp />
<templateFile />
<introduction>Send usage data to this Matomo</introduction>
<condition />
</row>
<row>
<name>anonymizeSelfPiwik</name>
<title>Anonymize tracking requests</title>
<value>1</value>
<defaultValue>1</defaultValue>
<type>boolean</type>
<uiControl>checkbox</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp />
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>customSiteUrl</name>
<title>Matomo Url</title>
<value />
<defaultValue />
<type>string</type>
<uiControl>text</uiControl>
<uiControlAttributes>
<placeHolder>eg. http://example.com/matomo</placeHolder>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp />
<templateFile />
<introduction>Send usage data to a custom Matomo</introduction>
<condition />
</row>
<row>
<name>customSiteId</name>
<title>Site Id</title>
<value>0</value>
<defaultValue>0</defaultValue>
<type>integer</type>
<uiControl>text</uiControl>
<uiControlAttributes>
<placeHolder>eg. "2"</placeHolder>
</uiControlAttributes>
<availableValues />
<description>If a URL and Site Id is specified, usage data will be sent to the custom Matomo instance.</description>
<inlineHelp />
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>anonymizeCustomPiwik</name>
<title>Anonymize tracking requests</title>
<value>1</value>
<defaultValue>1</defaultValue>
<type>boolean</type>
<uiControl>checkbox</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp />
<templateFile />
<introduction />
<condition />
</row>
</settings>
</row>
<row>
<pluginName>QueuedTracking</pluginName>
<title>QueuedTracking</title>
<settings>
<row>
<name>backend</name>
<title>Backend</title>
<value>redis</value>
<defaultValue>redis</defaultValue>
<type>string</type>
<uiControl>select</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues>
<redis>Redis</redis>
<mysql>MySQL</mysql>
</availableValues>
<description />
<inlineHelp>Select the backend you want to use for this feature. If you do not have any experience with Redis or it is not available on your server, we recommend to use Mysql.</inlineHelp>
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>useSentinelBackend</name>
<title>Enable Redis Sentinel</title>
<value>0</value>
<defaultValue>0</defaultValue>
<type>boolean</type>
<uiControl>checkbox</uiControl>
<uiControlAttributes>
<size>3</size>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>If enabled, the Redis Sentinel feature will be used. Make sure to update host and port if needed. Once you have enabled and saved the change, you will be able to specify multiple hosts and ports comma separated.</inlineHelp>
<templateFile />
<introduction />
<condition>backend=="redis"</condition>
</row>
<row>
<name>sentinelMasterName</name>
<title>Redis Sentinel Master name</title>
<value>mymaster</value>
<defaultValue>mymaster</defaultValue>
<type>string</type>
<uiControl>text</uiControl>
<uiControlAttributes>
<size>200</size>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>The sentinel master name only needs to be configured if Sentinel is enabled.</inlineHelp>
<templateFile />
<introduction />
<condition>backend=="redis"</condition>
</row>
<row>
<name>redisHost</name>
<title>Redis host or unix socket</title>
<value>127.0.0.1</value>
<defaultValue>127.0.0.1</defaultValue>
<type>string</type>
<uiControl>text</uiControl>
<uiControlAttributes>
<size>500</size>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>Remote host or unix socket of the Redis server. Max 500 characters are allowed.</inlineHelp>
<templateFile />
<introduction />
<condition>backend=="redis"</condition>
</row>
<row>
<name>redisPort</name>
<title>Redis port</title>
<value>6379</value>
<defaultValue>6379</defaultValue>
<type>string</type>
<uiControl>text</uiControl>
<uiControlAttributes>
<size>100</size>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>Port the Redis server is running on. Value should be between 1 and 65535. Use 0 if you are using unix socket to connect to Redis server.</inlineHelp>
<templateFile />
<introduction />
<condition>backend=="redis"</condition>
</row>
<row>
<name>redisDatabase</name>
<title>Redis database</title>
<value>15</value>
<defaultValue>0</defaultValue>
<type>integer</type>
<uiControl>text</uiControl>
<uiControlAttributes>
<size>5</size>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>In case you are using Redis for caching make sure to use a different database.</inlineHelp>
<templateFile />
<introduction />
<condition>backend=="redis"</condition>
</row>
<row>
<name>redisPassword</name>
<title>Redis password</title>
<value />
<defaultValue />
<type>string</type>
<uiControl>password</uiControl>
<uiControlAttributes>
<size>100</size>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>Password set on the Redis server, if any. Redis can be instructed to require a password before allowing clients to execute commands.</inlineHelp>
<templateFile />
<introduction />
<condition>backend=="redis"</condition>
</row>
<row>
<name>queueEnabled</name>
<title>Queue enabled</title>
<value>0</value>
<defaultValue>0</defaultValue>
<type>boolean</type>
<uiControl>checkbox</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>If enabled, all tracking requests will be written into a queue instead of the directly into the database. Requires a Redis server and phpredis PHP extension.</inlineHelp>
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>numQueueWorkers</name>
<title>Number of queue workers</title>
<value>4</value>
<defaultValue>1</defaultValue>
<type>integer</type>
<uiControl>text</uiControl>
<uiControlAttributes>
<size>5</size>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>Number of allowed maximum queue workers. Accepts a number between 1 and 16. Best practice is to set the number of CPUs you want to make available for queue processing. Be aware you need to make sure to start the workers manually. We recommend to not use 9-15 workers, rather use 8 or 16 as the queue might not be distributed evenly into different queues. DO NOT USE more than 1 worker if you make use the UserId feature when tracking see https://github.com/piwik/piwik/issues/7691</inlineHelp>
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>numRequestsToProcess</name>
<title>Number of requests that are processed in one batch</title>
<value>25</value>
<defaultValue>25</defaultValue>
<type>integer</type>
<uiControl>text</uiControl>
<uiControlAttributes>
<size>3</size>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>Defines how many requests will be picked out of the queue and processed at once. Enter a number which is >= 1.</inlineHelp>
<templateFile />
<introduction />
<condition />
</row>
<row>
<name>processDuringTrackingRequest</name>
<title>Process during tracking request</title>
<value>1</value>
<defaultValue>1</defaultValue>
<type>boolean</type>
<uiControl>checkbox</uiControl>
<uiControlAttributes>
</uiControlAttributes>
<availableValues />
<description />
<inlineHelp>If enabled, we will process all requests within a queue during a normal tracking request once there are enough requests in the queue. This will not slow down the tracking request. If disabled, you have to setup a cronjob that executes the "./console queuedtracking:process" console command eg every minute to process the queue.</inlineHelp>
<templateFile />
<introduction />
<condition />
</row>
</settings>
</row>
</result>
|