This repository has been archived by the owner on Dec 7, 2021. It is now read-only.
forked from rstudio/shiny-server
-
Notifications
You must be signed in to change notification settings - Fork 2
/
config.html
742 lines (603 loc) · 27.7 KB
/
config.html
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
<p>Listed below are all the directives that are supported in Shiny Server config files.</p>
<p><strong>Applies to</strong> indicates the kind of parent scope that this directive normally appears inside.</p>
<p><strong>Inheritable</strong> means that you can put this directive at a higher level in the hierarchy and it will be inherited by any children to which it might apply. Inherited directives can be overridden by using the directive again in a child scope.</p>
<ul class="directives">
<li>
<h3 class="code"><a name="run_as"></a>run_as</h3>
<p class="desc">The user the app should be run as. This user should have the minimal amount of privileges necessary to successfully run the application (i.e. read-only access to the Shiny application directory). Note that this directive cannot be used with <a class="code" href="#user_apps">user_apps</a>, as <code>user_apps</code> always run as the user who owns the application.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>user</td>
<td>String</td>
<td>required</td>
<td>The username that should be used to run the app</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level, <code><a href="#server">server</a></code>, <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="access_log"></a>access_log</h3>
<p class="desc">The file path of the HTTP access log.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>path</td>
<td>String</td>
<td>required</td>
<td>The file path where the access log should be written</td>
<td></td>
</tr>
<tr>
<td>format</td>
<td>String</td>
<td>optional</td>
<td>The log file format; see <a href="http://www.senchalabs.org/connect/logger.html">Connect documentation</a> under "Formats"</td>
<td>default</td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level<br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="server"></a>server</h3>
<p class="desc">Declares an HTTP server. You need one of these for each port/IP address combination this Shiny Server instance should listen on.</p>
<p class="noparams">This directive has no parameters.</p>
<p>
<label>Applies to:</label> Top-level<br/>
<label>Inheritable:</label> Yes<br/>
<label>Child directives:</label> <code><a href="#listen">listen</a></code>, <code><a href="#server_name">server_name</a></code>, <code><a href="#location">location</a></code><br/>
</p>
</li>
<li>
<h3 class="code"><a name="listen"></a>listen</h3>
<p class="desc">Directs the enclosing server scope to listen on the specified port/IP address combination.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>port</td>
<td>Integer</td>
<td>required</td>
<td>Port to listen on</td>
<td></td>
</tr>
<tr>
<td>host</td>
<td>String</td>
<td>optional</td>
<td>IPv4 address to listen on (<code>*</code> or <code>0.0.0.0</code> for all); hostnames are not currently allowed, please use raw IPv4 address only</td>
<td>*</td>
</tr>
</table>
<p>
<label>Applies to:</label> <code><a href="#server">server</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="server_name"></a>server_name</h3>
<p class="desc">Directs the enclosing server scope to only honor requests that have the given host headers (i.e. virtual hosts).</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>names</td>
<td>String</td>
<td>multiple</td>
<td>The virtual hostname(s) to bind this server to</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> <code><a href="#server">server</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="location"></a>location</h3>
<p class="desc">Creates a scope that configures the given URL as a website (<a class="code" href="#site_dir">site_dir</a>), specific application (<a class="code" href="#app_dir">app_dir</a>), autouser root (<a class="code" href="#user_apps">user_apps</a>), or redirect to a different URL (<a class="code" href="#redirect">redirect</a>).</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>path</td>
<td>String</td>
<td>required</td>
<td>The request path that this location should match</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> <code><a href="#server">server</a></code><br/>
<label>Inheritable:</label> Yes<br/>
<label>Child directives:</label> <code><a href="#run_as">run_as</a></code>, <code><a href="#site_dir">site_dir</a></code>, <code><a href="#directory_index">directory_index</a></code>, <code><a href="#user_apps">user_apps</a></code>, <code><a href="#app_dir">app_dir</a></code>, <code><a href="#redirect">redirect</a></code>, <code><a href="#log_dir">log_dir</a></code>, <code><a href="#members_of">members_of</a></code>, <code><a href="#google_analytics_id">google_analytics_id</a></code>, <code><a href="#application">application</a></code><br/>
</p>
</li>
<li>
<h3 class="code"><a name="site_dir"></a>site_dir</h3>
<p class="desc">Configures the enclosing location scope to be a website that can contain both Shiny applications and unrelated static assets in a single directory tree.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>rootPath</td>
<td>String</td>
<td>required</td>
<td>The path to the root directory of the website</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="directory_index"></a>directory_index</h3>
<p class="desc">When enabled, if a directory is requested by the client and an <code>index.html</code> file is not present, a list of the directory contents is created automatically and returned to the client. If this directive is not present in a custom config file, the default behavior is to disable directory indexes. However, it is enabled if no config file is present at all (in other words, the default config file has it enabled).</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>enabled</td>
<td>Boolean</td>
<td>required</td>
<td>Whether directory contents should automatically displayed</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level, <code><a href="#server">server</a></code>, <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="user_apps"></a>user_apps</h3>
<p class="desc">Configures the enclosing location scope to be an autouser root, meaning that applications will be served up from users' ~/ShinyApps directories.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>enabled</td>
<td>Boolean</td>
<td>optional</td>
<td>Whether this location should serve up all users' ~/ShinyApps directories</td>
<td>true</td>
</tr>
</table>
<p>
<label>Applies to:</label> <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="app_dir"></a>app_dir</h3>
<p class="desc">Configures the enclosing location scope to serve up the specified Shiny application.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>path</td>
<td>String</td>
<td>required</td>
<td>The path to the Shiny application directory</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="redirect"></a>redirect</h3>
<p class="desc">Configures the enclosing location to redirect all requests to the specified URL.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>required</td>
<td>The URL (or base URL) to redirect to</td>
<td></td>
</tr>
<tr>
<td>statusCode</td>
<td>Integer</td>
<td>optional</td>
<td>The status code to send with the response (usually 301 for permanent redirects or 302 for temporary redirects)</td>
<td>302</td>
</tr>
<tr>
<td>exact</td>
<td>Boolean</td>
<td>optional</td>
<td>Whether to match on the URL exactly; if false, any subpaths will match as well</td>
<td>true</td>
</tr>
</table>
<p>
<label>Applies to:</label> <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="log_dir"></a>log_dir</h3>
<p class="desc">Directs the application to write error logs to the specified directory. Only applies to location scopes that are configured with <a class="code" href="#app_dir">app_dir</a> or <a class="code" href="#site_dir">site_dir</a>, as <a class="code" href="#user_apps">user_apps</a> (autouser) always writes error logs to <code>~/ShinyApps/log</code>.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>path</td>
<td>String</td>
<td>required</td>
<td>The path to which application log files should be written</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level, <code><a href="#server">server</a></code>, <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="members_of"></a>members_of</h3>
<p class="desc">Restricts a <a class="code" href="#user_apps">user_apps</a> (autouser) scope to require membership in one or more groups (or, if no arguments are passed, lifts group restrictions from a <a class="code" href="#members_of">members_of</a> directive in a parent scope).</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>groups</td>
<td>String</td>
<td>multiple</td>
<td>Users must be a member of at least one of these groups in order to deploy applications; if no groups are provided, then all users are allowed</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level, <code><a href="#server">server</a></code>, <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="google_analytics_id"></a>google_analytics_id</h3>
<p class="desc">Configure Google Analytics tracking code to be inserted in Shiny application pages.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>gaid</td>
<td>String</td>
<td>required</td>
<td>The Google tracking ID, for example, UA-18988-1</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level, <code><a href="#server">server</a></code>, <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="application"></a>application</h3>
<p class="desc">Defines the parameters for an application. The values defined in the global configuration file will be used as defaults, and individual applications can override those defaults by placing a file named '.shiny_app.conf' in the base directory of an application.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>appDir</td>
<td>String</td>
<td>required</td>
<td>Specify the application by its app directory.</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> <code><a href="#location">location</a></code><br/>
<label>Inheritable:</label> Yes<br/>
<label>Child directives:</label> <code><a href="#app_init_timeout">app_init_timeout</a></code>, <code><a href="#app_idle_timeout">app_idle_timeout</a></code>, <code><a href="#simple_scheduler">simple_scheduler</a></code><br/>
</p>
</li>
<li>
<h3 class="code"><a name="app_init_timeout"></a>app_init_timeout</h3>
<p class="desc">Defines the amount of time Shiny Server will wait for an R process to start before giving up.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>timeout</td>
<td>Integer</td>
<td>required</td>
<td>The number of seconds to wait for the application to start.</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level, <code><a href="#server">server</a></code>, <code><a href="#location">location</a></code>, <code><a href="#application">application</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="app_idle_timeout"></a>app_idle_timeout</h3>
<p class="desc">Defines the amount of time an R process will persist with no connections before being terminated.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>timeout</td>
<td>Integer</td>
<td>required</td>
<td>The number of seconds to keep an empty R process alive before killing it.</td>
<td></td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level, <code><a href="#server">server</a></code>, <code><a href="#location">location</a></code>, <code><a href="#application">application</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="simple_scheduler"></a>simple_scheduler</h3>
<p class="desc">A basic scheduler which will spawn one single-threaded R worker for each application. If no scheduler is specified, this is the default scheduler.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>maxRequests</td>
<td>Integer</td>
<td>optional</td>
<td>The maximum number of requests to assign to this scheduler before it should start returning rejecting incoming traffic using a '503 - Service Unavailable' message. Once this threshold is hit, users attempting to initialize a new sessio will receive 503 errors.</td>
<td>100</td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level, <code><a href="#server">server</a></code>, <code><a href="#location">location</a></code>, <code><a href="#application">application</a></code><br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
<li>
<h3 class="code"><a name="allow_app_override"></a>allow_app_override</h3>
<p class="desc">If present, will allow users to override the global defaults for a scheduler by customizing the parameters associated with a scheduler or even the type of scheduler used.</p>
<table class="params">
<colgroup>
<col style="width: 105px"></col>
<col style="width: 90px"></col>
<col style="width: 90px"></col>
<col></col>
<col style="width: 90px"></col>
</colgroup>
<tr>
<th>Parameter</th>
<th>Data type</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td>enabled</td>
<td>Boolean</td>
<td>optional</td>
<td>Whether or not this is enabled. Default is true.</td>
<td>true</td>
</tr>
</table>
<p>
<label>Applies to:</label> Top-level<br/>
<label>Inheritable:</label> Yes<br/>
</p>
</li>
</ul>