Virtual Host Templates
Table of Contents
Virtual Host Name | Domain | Aliases | Member Virtual Host Root
Default Virtual Host Root | Instantiated VHost Config File | Document Root | Config File
Template Name⇑
Description
A unique name for the template.
Template File⇑
Description
Specifies the path to the configuration file of this template. The file must be located within $SERVER_ROOT/conf/templates/ with a ".conf" filename. If the file you designate does not exist, after trying to save the template an error will appear with the link "CLICK TO CREATE". This link will generate a new empty template file. When you delete the template, the entry will be removed from your configurations, but the actual template config file will not be deleted.
Syntax
path
Mapped Listeners⇑
Description
Specifies the names of all listeners that this template maps to. A listener-to-virtual host mapping for this template's member virtual hosts will be added to the listeners specified in this field. This mapping will map listeners to virtual hosts based on the domain names and aliases set in the member virtual hosts' individual configurations.
Syntax
comma-separated list
Virtual Host Name⇑
Description
A unique name for this virtual host. This name must be unique among all template member virtual hosts and standalone virtual hosts. Inside a directory path configuration, this name can be referenced by the variable $VH_NAME.
If a standalone virtual host with the same name is also configured, then the member virtual host configuration will be ignored.
Domain⇑
Description
Specifies the main domain name for this member virtual host. If left blank, the virtual host name will be used. This should be a fully qualified domain name, but you can use an IP address as well. It is recommended to append :
This domain name will be used in the following situations:
- To match the hostname in the Host header when processing a request.
- To populate domain name configurations for add-ons like FrontPage or AWstats.
- To configure listener-to-virtual host mappings based on the virtual host template.
Syntax
domain name
Aliases⇑
Description
Specifies alternate names for the virtual host. All possible hostnames and IP addresses should be added to this list. The wildcard characters * and ? are allowed in the name. Append :
Aliases will be used in the following situations:
- To match the hostname in the Host header when processing a request.
- To populate domain name/alias configurations for add-ons like FrontPage or AWstats.
- To configure listener-to-virtual host mappings based on the virtual host template.
Syntax
Comma-separated list of domain names.
Member Virtual Host Root⇑
Description
Specifies the root directory of this virtual host. If left blank, the default virtual host root for this template will be used.
Note: This is NOT the document root. It is recommended to place all files related to the virtual host (like virtual host configuration, log files, html files, CGI scripts, etc.) under this directory. Virtual host root can be referred to as $VH_ROOT.
Syntax
path
Default Virtual Host Root⇑
Description
Specifies the default root directory for member virtual hosts using this template. Variable $VH_NAME must appear in the path. This will allow each member template to be automatically assigned a separate root directory based on its name.
Syntax
path
Instantiated VHost Config File⇑
Description
Specifies the location of the config file generated when you instantiate a member virtual host. Variable $VH_NAME must appear in the path so each virtual host will have its own file. Must be located under $SERVER_ROOT/conf/vhosts/. This config file will be created only after you move a member vhost out of the template through instantiation.
Syntax
String with $VH_NAME variable and .conf suffix
Tips
$VH_NAME/vhconf.conf is recommended for easy management.
Document Root⇑
Description
Specifies the unique path for each member virtual host's document root. Variable $VH_NAME or $VH_ROOT must appear in the path so each member virtual host will have its own document root.
Syntax
path with $VH_NAME or $VH_ROOT variable
Example
Config File⇑
Description
Specifies the unique path for each member virtual host's configuration file. Variable $VH_NAME or $VH_ROOT must appear in the path so each member virtual host will have its own configuration file.
Syntax
path with $VH_NAME or $VH_ROOT variable