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