8 Default: PlanetLab Test</para>
9 <para>The name of this PLC installation. It is used in
10 the name of the default system site (e.g., PlanetLab Central)
11 and in the names of various administrative entities (e.g.,
12 PlanetLab Support).</para>
16 <term>PLC_SLICE_PREFIX</term>
22 <para>The abbreviated name of this PLC
23 installation. It is used as the prefix for system slices
24 (e.g., pl_conf). Warning: Currently, this variable should
25 not be changed.</para>
29 <term>PLC_ROOT_USER</term>
34 Default: root@localhost.localdomain</para>
35 <para>The name of the initial administrative
36 account. We recommend that this account be used only to create
37 additional accounts associated with real
38 administrators, then disabled.</para>
42 <term>PLC_ROOT_PASSWORD</term>
48 <para>The password of the initial administrative
49 account. Also the password of the root account on the Boot
54 <term>PLC_ROOT_SSH_KEY_PUB</term>
59 Default: /etc/planetlab/root_ssh_key.pub</para>
60 <para>The SSH public key used to access the root
61 account on your nodes.</para>
65 <term>PLC_ROOT_SSH_KEY</term>
70 Default: /etc/planetlab/root_ssh_key.rsa</para>
71 <para>The SSH private key used to access the root
72 account on your nodes.</para>
76 <term>PLC_DEBUG_SSH_KEY_PUB</term>
81 Default: /etc/planetlab/debug_ssh_key.pub</para>
82 <para>The SSH public key used to access the root
83 account on your nodes when they are in Debug mode.</para>
87 <term>PLC_DEBUG_SSH_KEY</term>
92 Default: /etc/planetlab/debug_ssh_key.rsa</para>
93 <para>The SSH private key used to access the root
94 account on your nodes when they are in Debug mode.</para>
98 <term>PLC_ROOT_GPG_KEY_PUB</term>
103 Default: /etc/planetlab/pubring.gpg</para>
104 <para>The GPG public keyring used to sign the Boot
105 Manager and all node packages.</para>
109 <term>PLC_ROOT_GPG_KEY</term>
114 Default: /etc/planetlab/secring.gpg</para>
115 <para>The SSH private key used to access the root
116 account on your nodes.</para>
120 <term>PLC_NET_DNS1</term>
125 Default: 127.0.0.1</para>
126 <para>Primary DNS server address.</para>
130 <term>PLC_NET_DNS2</term>
136 <para>Secondary DNS server address.</para>
140 <term>PLC_DNS_ENABLED</term>
146 <para>Enable the internal DNS server. The server does
147 not provide reverse resolution and is not a production
148 quality or scalable DNS solution. Use the internal DNS
149 server only for small deployments or for
154 <term>PLC_MAIL_ENABLED</term>
159 Default: false</para>
160 <para>Set to false to suppress all e-mail notifications
165 <term>PLC_MAIL_SUPPORT_ADDRESS</term>
170 Default: root+support@localhost.localdomain</para>
171 <para>This address is used for support
172 requests. Support requests may include traffic complaints,
173 security incident reporting, web site malfunctions, and
174 general requests for information. We recommend that the
175 address be aliased to a ticketing system such as Request
180 <term>PLC_MAIL_BOOT_ADDRESS</term>
185 Default: root+install-msgs@localhost.localdomain</para>
186 <para>The API will notify this address when a problem
187 occurs during node installation or boot.</para>
191 <term>PLC_MAIL_SLICE_ADDRESS</term>
196 Default: root+SLICE@localhost.localdomain</para>
197 <para>This address template is used for sending
198 e-mail notifications to slices. SLICE will be replaced with
199 the name of the slice.</para>
203 <term>PLC_DB_ENABLED</term>
209 <para>Enable the database server on this
214 <term>PLC_DB_TYPE</term>
219 Default: postgresql</para>
220 <para>The type of database server. Currently, only
221 postgresql is supported.</para>
225 <term>PLC_DB_HOST</term>
228 Type: hostname</para>
230 Default: localhost.localdomain</para>
231 <para>The fully qualified hostname of the database
236 <term>PLC_DB_IP</term>
241 Default: 127.0.0.1</para>
242 <para>The IP address of the database server, if not
243 resolvable by the configured DNS servers.</para>
247 <term>PLC_DB_PORT</term>
253 <para>The TCP port number through which the database
254 server should be accessed.</para>
258 <term>PLC_DB_NAME</term>
263 Default: planetlab4</para>
264 <para>The name of the database to access.</para>
268 <term>PLC_DB_USER</term>
273 Default: pgsqluser</para>
274 <para>The username to use when accessing the
279 <term>PLC_DB_PASSWORD</term>
282 Type: password</para>
285 <para>The password to use when accessing the
286 database. If left blank, one will be
291 <term>PLC_API_ENABLED</term>
297 <para>Enable the API server on this
302 <term>PLC_API_DEBUG</term>
307 Default: false</para>
308 <para>Enable verbose API debugging. Do not enable on
309 a production system!</para>
313 <term>PLC_API_HOST</term>
316 Type: hostname</para>
318 Default: localhost.localdomain</para>
319 <para>The fully qualified hostname of the API
324 <term>PLC_API_IP</term>
329 Default: 127.0.0.1</para>
330 <para>The IP address of the API server, if not
331 resolvable by the configured DNS servers.</para>
335 <term>PLC_API_PORT</term>
341 <para>The TCP port number through which the API
342 should be accessed.</para>
346 <term>PLC_API_PATH</term>
351 Default: /PLCAPI/</para>
352 <para>The base path of the API URL.</para>
356 <term>PLC_API_MAINTENANCE_USER</term>
361 Default: maint@localhost.localdomain</para>
362 <para>The username of the maintenance account. This
363 account is used by local scripts that perform automated
364 tasks, and cannot be used for normal logins.</para>
368 <term>PLC_API_MAINTENANCE_PASSWORD</term>
371 Type: password</para>
374 <para>The password of the maintenance account. If
375 left blank, one will be generated. We recommend that the
376 password be changed periodically.</para>
380 <term>PLC_API_MAINTENANCE_SOURCES</term>
383 Type: hostname</para>
386 <para>A space-separated list of IP addresses allowed
387 to access the API through the maintenance account. The value
388 of this variable is set automatically to allow only the API,
389 web, and boot servers, and should not be
394 <term>PLC_API_SSL_KEY</term>
399 Default: /etc/planetlab/api_ssl.key</para>
400 <para>The SSL private key to use for encrypting HTTPS
401 traffic. If non-existent, one will be
406 <term>PLC_API_SSL_CRT</term>
411 Default: /etc/planetlab/api_ssl.crt</para>
412 <para>The corresponding SSL public certificate. By
413 default, this certificate is self-signed. You may replace
414 the certificate later with one signed by a root
419 <term>PLC_API_CA_SSL_CRT</term>
424 Default: /etc/planetlab/api_ca_ssl.crt</para>
425 <para>The certificate of the root CA, if any, that
426 signed your server certificate. If your server certificate is
427 self-signed, then this file is the same as your server
432 <term>PLC_WWW_ENABLED</term>
438 <para>Enable the web server on this
443 <term>PLC_WWW_DEBUG</term>
448 Default: false</para>
449 <para>Enable debugging output on web pages. Do not
450 enable on a production system!</para>
454 <term>PLC_WWW_HOST</term>
457 Type: hostname</para>
459 Default: localhost.localdomain</para>
460 <para>The fully qualified hostname of the web
465 <term>PLC_WWW_IP</term>
470 Default: 127.0.0.1</para>
471 <para>The IP address of the web server, if not
472 resolvable by the configured DNS servers.</para>
476 <term>PLC_WWW_PORT</term>
482 <para>The TCP port number through which the
483 unprotected portions of the web site should be
488 <term>PLC_WWW_SSL_PORT</term>
494 <para>The TCP port number through which the protected
495 portions of the web site should be accessed.</para>
499 <term>PLC_WWW_SSL_KEY</term>
504 Default: /etc/planetlab/www_ssl.key</para>
505 <para>The SSL private key to use for encrypting HTTPS
506 traffic. If non-existent, one will be
511 <term>PLC_WWW_SSL_CRT</term>
516 Default: /etc/planetlab/www_ssl.crt</para>
517 <para>The corresponding SSL public certificate for
518 the HTTP server. By default, this certificate is
519 self-signed. You may replace the certificate later with one
520 signed by a root CA.</para>
524 <term>PLC_WWW_CA_SSL_CRT</term>
529 Default: /etc/planetlab/www_ca_ssl.crt</para>
530 <para>The certificate of the root CA, if any, that
531 signed your server certificate. If your server certificate is
532 self-signed, then this file is the same as your server
537 <term>PLC_BOOT_ENABLED</term>
543 <para>Enable the boot server on this
548 <term>PLC_BOOT_HOST</term>
551 Type: hostname</para>
553 Default: localhost.localdomain</para>
554 <para>The fully qualified hostname of the boot
559 <term>PLC_BOOT_IP</term>
564 Default: 127.0.0.1</para>
565 <para>The IP address of the boot server, if not
566 resolvable by the configured DNS servers.</para>
570 <term>PLC_BOOT_PORT</term>
576 <para>The TCP port number through which the
577 unprotected portions of the boot server should be
582 <term>PLC_BOOT_SSL_PORT</term>
588 <para>The TCP port number through which the protected
589 portions of the boot server should be
594 <term>PLC_BOOT_SSL_KEY</term>
599 Default: /etc/planetlab/boot_ssl.key</para>
600 <para>The SSL private key to use for encrypting HTTPS
605 <term>PLC_BOOT_SSL_CRT</term>
610 Default: /etc/planetlab/boot_ssl.crt</para>
611 <para>The corresponding SSL public certificate for
612 the HTTP server. By default, this certificate is
613 self-signed. You may replace the certificate later with one
614 signed by a root CA.</para>
618 <term>PLC_BOOT_CA_SSL_CRT</term>
623 Default: /etc/planetlab/boot_ca_ssl.crt</para>
624 <para>The certificate of the root CA, if any, that
625 signed your server certificate. If your server certificate is
626 self-signed, then this file is the same as your server