vboxwebsrv-linux.dita@ 105145

Last change on this file since 105145 was 99182, checked in by vboxsync, 23 months ago

Docs: bugref:10302. Merging the following changes from the docs. team:

Add ditaval markup to images,
Add alt elements for images, for OHC accessibility requirements,
Add desc elements for tables, for OHC accessibility requirements.

Property svn:eol-style set to native
Property svn:keywords set to Id Revision

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

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

Download in other formats:

Original Format