vboxwebsrv-linux.dita@ 98549

Last change on this file since 98549 was 98549, checked in by vboxsync, 2 years ago
Docs: bugref:10302. Uploading .dita user manual files we received from the doc team on 25th Jan.
Property svn:eol-style set to `native`
File size: 7.6 KB

Line
1	<?xml version='1.0' encoding='UTF-8'?>
2	<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3	<topic xml:lang="en-us" id="vboxwebsrv-linux">
4	<title>Linux: Starting the Web Service With init</title>
5
6	<body>
7	<p>
8	On Linux, the web service can be automatically started during
9	host boot by adding appropriate parameters to the file
10	<filepath>/etc/default/virtualbox</filepath>. There is one
11	mandatory parameter, <codeph>VBOXWEB_USER</codeph>, which must
12	be set to the user which will later start the VMs. The
13	parameters in the following table all start with the
14	<codeph>VBOXWEB_</codeph> prefix string. For example:
15	<codeph>VBOXWEB_HOST</codeph> and
16	<codeph>VBOXWEB_PORT</codeph>.
17	</p>
18	<table id="table-websrv-config-params">
19	<title>Web Service Configuration Parameters</title>
20	<tgroup cols="3">
21	<thead>
22	<row>
23	<entry>
24	<p>
25	<b outputclass="bold">Parameter</b>
26	</p>
27	</entry>
28	<entry>
29	<p>
30	<b outputclass="bold">Description</b>
31	</p>
32	</entry>
33	<entry>
34	<p>
35	<b outputclass="bold">Default</b>
36	</p>
37	</entry>
38	</row>
39	</thead>
40	<tbody>
41	<row>
42	<entry>
43	<p>
44	<codeph>USER</codeph>
45	</p>
46	</entry>
47	<entry>
48	<p>
49	The user which the web service runs as
50	</p>
51	</entry>
52	<entry>
53	<p/>
54	</entry>
55	</row>
56	<row>
57	<entry>
58	<p>
59	<codeph>HOST</codeph>
60	</p>
61	</entry>
62	<entry>
63	<p>
64	The host to bind the web service to
65	</p>
66	</entry>
67	<entry>
68	<p>
69	localhost
70	</p>
71	</entry>
72	</row>
73	<row>
74	<entry>
75	<p>
76	<codeph>PORT</codeph>
77	</p>
78	</entry>
79	<entry>
80	<p>
81	The port to bind the web service to
82	</p>
83	</entry>
84	<entry>
85	<p>
86	18083
87	</p>
88	</entry>
89	</row>
90	<row>
91	<entry>
92	<p>
93	<codeph>SSL_KEYFILE</codeph>
94	</p>
95	</entry>
96	<entry>
97	<p>
98	Server key and certificate file, in PEM format
99	</p>
100	</entry>
101	<entry>
102	<p/>
103	</entry>
104	</row>
105	<row>
106	<entry>
107	<p>
108	<codeph>SSL_PASSWORDFILE</codeph>
109	</p>
110	</entry>
111	<entry>
112	<p>
113	File name for password to server key
114	</p>
115	</entry>
116	<entry>
117	<p/>
118	</entry>
119	</row>
120	<row>
121	<entry>
122	<p>
123	<codeph>SSL_CACERT</codeph>
124	</p>
125	</entry>
126	<entry>
127	<p>
128	CA certificate file, in PEM format
129	</p>
130	</entry>
131	<entry>
132	<p/>
133	</entry>
134	</row>
135	<row>
136	<entry>
137	<p>
138	<codeph>SSL_CAPATH</codeph>
139	</p>
140	</entry>
141	<entry>
142	<p>
143	CA certificate path
144	</p>
145	</entry>
146	<entry>
147	<p/>
148	</entry>
149	</row>
150	<row>
151	<entry>
152	<p>
153	<codeph>SSL_DHFILE</codeph>
154	</p>
155	</entry>
156	<entry>
157	<p>
158	DH file name or DH key length in bits
159	</p>
160	</entry>
161	<entry>
162	<p/>
163	</entry>
164	</row>
165	<row>
166	<entry>
167	<p>
168	<codeph>SSL_RANDFILE</codeph>
169	</p>
170	</entry>
171	<entry>
172	<p>
173	File containing seed for random number generator
174	</p>
175	</entry>
176	<entry>
177	<p/>
178	</entry>
179	</row>
180	<row>
181	<entry>
182	<p>
183	<codeph>TIMEOUT</codeph>
184	</p>
185	</entry>
186	<entry>
187	<p>
188	Session timeout in seconds, 0 disables timeouts
189	</p>
190	</entry>
191	<entry>
192	<p>
193	300
194	</p>
195	</entry>
196	</row>
197	<row>
198	<entry>
199	<p>
200	<codeph>CHECK_INTERVAL</codeph>
201	</p>
202	</entry>
203	<entry>
204	<p>
205	Frequency of timeout checks in seconds
206	</p>
207	</entry>
208	<entry>
209	<p>
210	5
211	</p>
212	</entry>
213	</row>
214	<row>
215	<entry>
216	<p>
217	<codeph>THREADS</codeph>
218	</p>
219	</entry>
220	<entry>
221	<p>
222	Maximum number of worker threads to run in parallel
223	</p>
224	</entry>
225	<entry>
226	<p>
227	100
228	</p>
229	</entry>
230	</row>
231	<row>
232	<entry>
233	<p>
234	<codeph>KEEPALIVE</codeph>
235	</p>
236	</entry>
237	<entry>
238	<p>
239	Maximum number of requests before a socket will be
240	closed
241	</p>
242	</entry>
243	<entry>
244	<p>
245	100
246	</p>
247	</entry>
248	</row>
249	<row>
250	<entry>
251	<p>
252	<codeph>ROTATE</codeph>
253	</p>
254	</entry>
255	<entry>
256	<p>
257	Number of log files, 0 disables log rotation
258	</p>
259	</entry>
260	<entry>
261	<p>
262	10
263	</p>
264	</entry>
265	</row>
266	<row>
267	<entry>
268	<p>
269	<codeph>LOGSIZE</codeph>
270	</p>
271	</entry>
272	<entry>
273	<p>
274	Maximum log file size to trigger rotation, in bytes
275	</p>
276	</entry>
277	<entry>
278	<p>
279	1MB
280	</p>
281	</entry>
282	</row>
283	<row>
284	<entry>
285	<p>
286	<codeph>LOGINTERVAL</codeph>
287	</p>
288	</entry>
289	<entry>
290	<p>
291	Maximum time interval to trigger log rotation, in
292	seconds
293	</p>
294	</entry>
295	<entry>
296	<p>
297	1 day
298	</p>
299	</entry>
300	</row>
301	</tbody>
302	</tgroup>
303	</table>
304	<p>
305	Setting the parameter <codeph>SSL_KEYFILE</codeph> enables the
306	SSL/TLS support. Using encryption is strongly encouraged, as
307	otherwise everything, including passwords, is transferred in
308	clear text.
309	</p>
310	</body>
311
312	</topic>

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format