doc/manual/en_US/dita/topics/vboxwebsrv-linux.dita


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

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
<topic xml:lang="en-us" id="vboxwebsrv-linux">
  <title>Linux: Starting the Web Service With init</title>
  
  <body>
    <p>
        On Linux, the web service can be automatically started during
        host boot by adding appropriate parameters to the file
        <filepath>/etc/default/virtualbox</filepath>. There is one
        mandatory parameter, <codeph>VBOXWEB_USER</codeph>, which must
        be set to the user which will later start the VMs. The
        parameters in the following table all start with the
        <codeph>VBOXWEB_</codeph> prefix string. For example:
        <codeph>VBOXWEB_HOST</codeph> and
        <codeph>VBOXWEB_PORT</codeph>.
      </p>
    <table id="table-websrv-config-params">
      <title>Web Service Configuration Parameters</title>
      <desc>Web Service Configuration Parameters</desc>
      <tgroup cols="3">       
        <thead>
          <row>
            <entry>
              <p>
                <b outputclass="bold">Parameter</b>
              </p>
            </entry>
            <entry>
              <p>
                <b outputclass="bold">Description</b>
              </p>
            </entry>
            <entry>
              <p>
                <b outputclass="bold">Default</b>
              </p>
            </entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry>
              <p>
                <codeph>USER</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  The user which the web service runs as
                </p>
            </entry>
            <entry>
              <p/>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>HOST</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  The host to bind the web service to
                </p>
            </entry>
            <entry>
              <p>
                  localhost
                </p>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>PORT</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  The port to bind the web service to
                </p>
            </entry>
            <entry>
              <p>
                  18083
                </p>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>SSL_KEYFILE</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  Server key and certificate file, in PEM format
                </p>
            </entry>
            <entry>
              <p/>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>SSL_PASSWORDFILE</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  File name for password to server key
                </p>
            </entry>
            <entry>
              <p/>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>SSL_CACERT</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  CA certificate file, in PEM format
                </p>
            </entry>
            <entry>
              <p/>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>SSL_CAPATH</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  CA certificate path
                </p>
            </entry>
            <entry>
              <p/>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>SSL_DHFILE</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  DH file name or DH key length in bits
                </p>
            </entry>
            <entry>
              <p/>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>SSL_RANDFILE</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  File containing seed for random number generator
                </p>
            </entry>
            <entry>
              <p/>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>TIMEOUT</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  Session timeout in seconds, 0 disables timeouts
                </p>
            </entry>
            <entry>
              <p>
                  300
                </p>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>CHECK_INTERVAL</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  Frequency of timeout checks in seconds
                </p>
            </entry>
            <entry>
              <p>
                  5
                </p>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>THREADS</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  Maximum number of worker threads to run in parallel
                </p>
            </entry>
            <entry>
              <p>
                  100
                </p>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>KEEPALIVE</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  Maximum number of requests before a socket will be
                  closed
                </p>
            </entry>
            <entry>
              <p>
                  100
                </p>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>ROTATE</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  Number of log files, 0 disables log rotation
                </p>
            </entry>
            <entry>
              <p>
                  10
                </p>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>LOGSIZE</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  Maximum log file size to trigger rotation, in bytes
                </p>
            </entry>
            <entry>
              <p>
                  1MB
                </p>
            </entry>
          </row>
          <row>
            <entry>
              <p>
                <codeph>LOGINTERVAL</codeph>
              </p>
            </entry>
            <entry>
              <p>
                  Maximum time interval to trigger log rotation, in
                  seconds
                </p>
            </entry>
            <entry>
              <p>
                  1 day
                </p>
            </entry>
          </row>
        </tbody>
      </tgroup>
    </table>
    <p>
        Setting the parameter <codeph>SSL_KEYFILE</codeph> enables the
        SSL/TLS support. Using encryption is strongly encouraged, as
        otherwise everything, including passwords, is transferred in
        clear text.
      </p>
  </body>
  
</topic>