httpd-instances.conf(4) (Sun WebServer Command Reference)

Sun WebServer Command Reference

httpd-instances.conf(4)

NAME

^TM

SYNOPSIS

/etc/http/httpd-instances.conf

DESCRIPTION

The httpd-instances.conf file associates each unique httpd process (or server instance) with its configuration file, and defines whether or not a server instance is enabled. A server instance is a named httpd process which services one or more web sites. At installation, there are two default instances: sws_server and admin, the server process which handles the Sun WebServer Administration Console. The admin instance is not created unless SUNWhtadm has been installed.

Entries in httpd-instances.conf may be modified by using the htserver utility, through the Sun WebServer Administration Console, or editing the file directly. It is recommended that you use htserver or the Administration Console.

A new server instance is typically needed only when it is impractical to add web sites to an existing server, either because all existing instances already have large numbers of sites or because a new web site requires a configuration that no existing instance can support. Instances cannot share port numbers.

Syntax

The following syntax rules apply to the httpd-instances.conf file:

The exclamation mark `!' is a comment character. All characters from a ! to the end of a line are ignored
White space is ignored in directive definitions.
Separate multiple values by white space or tab character.
Each entry is written on one line with three fields. Additional fields on the same line are ignored.
There is no syntax error checking for first two fields (instance-ID and configuration_file). The third field can have any of the following values to indicate that the site is enabled: "enabled", "true", "yes", "1". Any other value in this field would disable the site.

Each entry in httpd-instances.conf has the following format

<instance-ID> <configuration_file> <state>

The syntax and definition of each directive are explained in the following Directives section.

Directives

The following keyword directives are valid in the httpd-instances.conf file:

instance-ID

Shows the unique string used to identify the server instance. The instance-ID is used in the Sun WebServer Administration Console, command line utilities, and (by default) to name the configuration file. The string may contain any alphanumeric characters, but may not contain spaces.

The instance-ID `admin' is reserved to name the Sun WebServer Administration server. You should not delete or rename this server instance unless you want to disable web-based administration.

configuration_file

Shows the full path location of the configuration file for this server instance. By default, the configuration file will be /etc/http/instance-ID.httpd.conf, but any valid configuration file may be used.

state

Shows the state of the server for the purposes of starting all instances (such as when the machine boots). Valid values in this column are:

enable: Means the server will be started by default when the machine boots or when htserver start is run with no explicit instance name.
disable: Means the server will only be started if it is explicitly named. You must use htserver start instance-ID to start the instance.

EXAMPLES

Example 1

Do not edit the /etc/http/httpd-instances.conf file. This example is shown for reference only:

Secure_Sites    /etc/http/secure.httpd.conf     disable
Small_Sites     /etc/http/small.httpd.conf      disable
Large_Sites     /etc/http/sws_server.httpd.conf enable
admin   /usr/http/admin_server/conf/admin.httpd.conf   disable

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWhttp
Interface Stability	Evolving

NOTES

Do not edit httpd-instances.conf manually. Use htserver(1m) to add, delete, or modify instances.

Sun WebServer 2.0 Last Revised 17 July 1998