newserver Prompts and Command Reference

The newserver command has a number of options and prompts, as described in the two tables that follow.

The newserver command format depends on your operating system:

The command-line options for the two flavors are exactly the same.

Table 2. Options of the newserver Command

OptionDescriptionRequired?
--server=servernameName of the new vFabric Web Server instance. The value of this option also can be the name of the directory that contains the instance configuration files, and by default is the name of the host.Yes.
--rootdir=rootdirDirectory that contains the httpd-2.2.version directory, which in turn contains the Apache HTTP binaries.

The default value is the current directory.

No.
--serverdir=serverdirDirectory in which you want the new instance directory to be created.

The default value is rootdir.

No.
--overlaySpecifies that, if serverdir exists, you want to overwrite the existing files with new ones.No.

If you do not specify this option, and serverdir exists, the newserver command returns an error and suggests you specify a unique name and directory location for the new instance.

--httpdver=httpdverVersion of the Apache HTTP binaries you want your instance to use.

The default value is 2.2, which is a symbolic link to the actual installed version of the binaries, such as 2.2.19.0-32.

No.
--httpddir=httpddirDirectory that contains the Apache HTTP binaries.

The default value is rootdir/httpd-httpdver, such as /opt/vmware/vfabric-web-server/httpd-2.2.19.0-32.

No.
--sourcedir=sourcedirName of the directory that contains the template that newserver uses to create the new vFabric Web Server instance.

The default value is httpdir/_instance.

No.
--quietSpecifies that the newserver command should use default values for all prompts.No.

If you do not specify this option, newserver interactively prompts for all answers.


Table 3. newserver Prompts

PromptDescription
Use threaded 'worker' MPM [y/n]?Specifies whether the vFabric Web Server instance implements a multi-process, multi-threaded server. By using threads to serve requests, the instance can serve many requests with fewer system resources than a process-based server.
Enable SSL and create a default key [y/n]?Enabling SSL provides secure communication between client and server by allowing mutual authentication; the use of digital signatures for integrity; and encryption for privacy. If you answer yes, you are later asked for information that will be used to create a certificate.
Server hostname (e.g. www.example.com) [myserver]?Name that the vFabric Web Server instance uses to identify itself. If your host does not have a registered DNS name, enter its IP address. The default value is the value you entered for the --server option.
Administrator email [webmaster@myserver]?Email address to which vFabric Web Server instances send problems. This address appears on some instance-generated pages, such as error documents.
Port for http:// traffic [80]?HTTP port to which the vFabric Web Server instance listens. Default value is 80 when running the newserver command as the root user on Linux, 8080 otherwise.
Port for https:// SSL traffic [443]?HTTPS port to which the vFabric Web Server instance listens. Default value is 443 when running the newserver command as the root user on Linux, 8443 otherwise.
Creating a sample conf/userfile, add initial usersPrompts for creating a sample file that contains the list of users and passwords for authentication. Use this file if you later need to authenticate users who use the vFabric Web Server instance. The prompts ask you for the username and their password; enter Return at the username prompt when you are done.
If you previously specified that you want to enable SSL...The newserver command prompts you for information required to create the private key, such as the size of the SSL RSA key in bits and the PEM pass phrase you specify when you start the instance.

You also are prompted to enter information for your certificate. The information is mostly about your Distinguished Name, or DN, that will be incorporated into your certificate request. As indicated, some fields have default values. You can also leave some fields blank by entering a '.' (period.)

When newserver completes, it generates the following SSL files in the ssl subdirectory of the instance directory:

  • instancename.key: Unencrypted private key. The file has a permission code of 0600 for additional security.

  • instancename.pem: DES 3 encrypted private key.

  • instancename.csr: Certificate-signing request. Submit this file to the Certificate Authority.

  • instancename.crt: Self-signed certificate. Replace this certificate with a signed certificate by the CA.

Important Be sure to record the passphrase to decrypt the *.pem file and back up the file. Never transmit the .key file or cause it to be readable by others.