Skip Headers

Oracle® HTTP Server Administering a Standalone Deployment Based on Apache 2.0 10g Release 3 (10.1.3) B25777-01 |
| Home | Solution Area | Contents | Index

Previous | Next |

# 3 Specifying Server and File Locations

This chapter explains how to set Oracle HTTP Server and server administrator options, and specifies file locations.

Topics discussed are:

- Setting Server and Administrator Functions

- Specifying File Locations

Documentation from the Apache Software Foundation is referenced when applicable.

Note: Readers using this guide in PDF or hard copy formats will be unable to access third-party documentation, which Oracle provides in HTML format only. To access the third-party documentation referenced in this guide, use the HTML version of this guide and click the hyperlinks.

## 3.1 Setting Server and Administrator Functions

The following directives set basic Oracle HTTP Server and administrator functions. They are located in the "Main Server Configuration" portion of the `httpd.conf` file.

See Also: "httpd.conf File Structure"

- ServerName

- UseCanonicalName

- ServerAdmin

- ServerSignature

- ServerTokens

- ServerAlias

### 3.1.1 ServerName

Enables the server to set a hostname that can be used to create redirection URLs, through which you can access directories without having to use a "/" at the end.

For example, `ServerName www.company.com` would be used if the main name of the actual machine were `main.company.com`.

See Also: "`ServerName` directive" in the Apache Server documentation.

### 3.1.2 UseCanonicalName

Determines which hostname and port to use when redirecting the URL to the same server.

- `On`: Server uses the hostname and port values set in ServerName. This is the default setting.

- `Off`: Server uses the hostname and port that you specify in the request.

  For example: `UseCanonicalName On`.

  See Also: "`UseCanonicalName` directive" in the Apache Server documentation.

### 3.1.3 ServerAdmin

Creates an email address that is included with every default error message that clients encounter. It is useful to create a separate email address for this.

For example: `ServerAdmin you@your.emailaddress`.

See Also: "`ServerAdmin` directive" in the Apache Server documentation.

### 3.1.4 ServerSignature

Enables the server to recognize which server, among the various proxies, created the returned response, such as an error message.

- `on`: Server creates a footer to the returned document that includes information such as ServerName and server version number. This is the default setting.

- `email:` Server creates an additional "mailto:" reference to the ServerAdmin of the document.

- `off`: Footer and "mailto:" reference are not created.

For example: `ServerSignature On`

See Also: "`ServerSignature` directive" in the Apache Server documentation.

### 3.1.5 ServerTokens

Controls server information which is returned to clients, such as in error messages. This information includes a description of the generic operating system-type of the server, and compiled-in modules.

- `min(imal)`: provides information such as server name and version.

- `OS`: provides information such as server name, version and operating system.

- `full`: provides information such as server name, version, operating system, and complied modules.

For example: `Server: Apache/2.0.0 (UNIX) PHP/3.0 MyMod/1.2`

See Also: "`ServerTokens` directive" in the Apache Server documentation.

### 3.1.6 ServerAlias

Sets alternate names for the current virtual host.

For example:

    <VirtualHost *>
    ServerName server.domain.com
    ServerAlias server server2.domain.com server2
    ...
    </VirtualHost>

See Also: "`ServerAlias` directive" in the Apache Server documentation.

## 3.2 Specifying File Locations

The following directives control the location of various server files. They are located in the "Global Environment" of the `httpd.conf` file.

See Also: "httpd.conf File Structure"

- CoreDumpDirectory

- DocumentRoot

- ErrorLog

- LockFile

- PidFile

- ScoreBoardFile

- ServerRoot

### 3.2.1 CoreDumpDirectory

Specifies the directory in which the server dumps core. The default is the ServerRoot directory. This directive is applicable to UNIX only.

For example: `CoreDumpDirectory /tmp`

See Also: "`CoreDumpDirectory` directive" in the Apache Server documentation.

### 3.2.2 DocumentRoot

Sets the directory from which httpd serves files. Unless matched by a directive like `Alias`, the server appends the path from the requested URL to the document root to make the path to the document for static content.

For example: `DocumentRoot "/oracle/Apache/Apache/htdocs"`

See Also: "`DocumentRoot` directive" in the Apache Server documentation.

### 3.2.3 ErrorLog

Sets the name of the file to which the server notes any errors it encounters. If the name of the file does not begin with a slash (/), then it is assumed to be relative to the ServerRoot. If the name of the file begins with a pipe (|), then it is assumed to be a command to spawn to handle the error log.

For example: `ErrorLog "|/private1/oracle/Apache/Apache/bin/rotatelogs /private1/oracle/Apache/Apache/logs/error_log 43200"`

See Also: "`ErrorLog` directive" in the Apache Server documentation.

### 3.2.4 LockFile

Sets the path to the lockfile used whenOracle HTTP Server is compiled with either `USE_FCNTL_SERIALIZED_ACCEPT` or `USE_FLOCK_SERIALIZED_ACCEPT`. It is recommended that default value be used. The main reason for changing it is if the logs directory is NFS mounted, since the lockfile must be stored on a local disk.

For example: `LockFile /oracle/Apache/Apache/logs/httpd.lock`

See Also: "`LockFile` directive" in the Apache Server documentation.

### 3.2.5 PidFile

Enables you to set and change the location of the `PID` file to which the server records the process identification number. If the filename does not begin with a slash (/), then it is assumed to be relative to the ServerRoot.

For example: `PidFile /oracle/Apache/Apache/logs/httpd.lock`

See Also: "`PidFile` directive" in the Apache Server documentation.

### 3.2.6 ScoreBoardFile

Required in some architectures to set a file that the server uses to communicate between the parent and children processes. To verify if your architecture requires a scoreboard file, run Oracle HTTP Server and see if it creates the file named by the directive. If your architecture requires it then you must ensure that this file is not used at the same time by more than one invocation of the server.

For example: `/oracle/Apache/Apache/logs/httpd.scoreboard`

See Also: "`ScoreBoardFile` directive" in the Apache Server documentation.

### 3.2.7 ServerRoot

Specifies the directory that contains the `conf` and `logs` subdirectories. If the server is started with the `-f` option, then you will have to specify ServerRoot.

For example: `"/oracle/Apache/Apache"`

See Also: "`ServerRoot` directive" in the Apache Server documentation.