Oracle iPlanet Web Server 7.0.9 Administrator's Configuration File Reference

Preface

This Configuration File Reference discusses the purpose and use of the configuration files for Oracle iPlanet Web Server (Web Server), including server.xml, magnus.conf, obj.conf, and mime.types. This document provides a comprehensive list of the elements and directives in these configuration files.

The following topics are addressed here:

Who Should Use This Book

The intended audience for this document is the person who administers and maintains Web Server.

This document assumes you are familiar with the following topics:

Java Platform, Enterprise Edition (Java EE)
HTTP
HTML
XML
Relational database concepts

Web Server Documentation Set

The Web Server documentation set describes how to install and administer the Web Server. The URL for Web Server documentation is http://docs.sun.com/coll/1653.9.

For an introduction to Web Server, refer to the books in the order in which they are listed in the following table.

Table P–1 Web Server Documentation


Document Title	Contents
Documentation Center	Web Server documentation topics organized by tasks and subject
Release Notes	Late-breaking information about the software and documentation Supported platforms and patch requirements for installing Web Server
Installation and Migration Guide	Performing installation and migration tasks: Installing Web Server and its various components Migrating data from Sun ONE Web Server 6.0 or Sun Java System Web Server 6.1 to Oracle iPlanet Web Server 7.0
Administrator’s Guide	Performing the following administration tasks: Using the Administration and command-line interfaces Configuring server preferences Using server instances Monitoring and logging server activity Using certificates and public key cryptography to secure the server Configuring access control to secure the server Using Java Platform, Enterprise Edition (Java EE) security features Deploying applications Managing virtual servers Defining server workload and sizing the system to meet performance needs Searching the contents and attributes of server documents, and creating a text search interface Configuring the server for content compression Configuring the server for web publishing and content authoring using WebDAV
Developer’s Guide	Using programming technologies and APIs to do the following: Extend and modify Web Server Dynamically generate content in response to client requests and modify the content of the server
NSAPI Developer’s Guide	Creating custom Netscape Server Application Programmer’s Interface (NSAPI) plug-ins
Developer’s Guide to Java Web Applications	Implementing Java Servlets and JavaServer Pages (JSP) technology in Web Server
Administrator’s Configuration File Reference	Editing configuration files
Performance Tuning, Sizing, and Scaling Guide	Tuning Web Server to optimize performance
Troubleshooting Guide	Troubleshooting Web Server
CLI Reference Manual	Administration commands that allow you to administer the Web Server through the CLI

Documentation Conventions

This section describes the following conventions used in Web Server documentation:

Typographic Conventions

The following table describes the typographic changes that are used in this book.

Table P–2 Typographic Conventions


Typeface	Meaning	Example
`AaBbCc123`	The names of commands, files, and directories, and onscreen computer output	Edit your `.login` file. Use `ls -a` to list all files. `machine_name% you have mail.`
`AaBbCc123`	What you type, contrasted with onscreen computer output	`machine_name%` `su` `Password:`
`AaBbCc123`	A placeholder to be replaced with a real name or value	The command to remove a file is `rm` `filename`.
AaBbCc123	Book titles, new terms, and terms to be emphasized (note that some emphasized items appear bold online)	Read Chapter 6 in the User's Guide. A cache is a copy that is stored locally. Do not save the file.

Symbol Conventions

The following table explains symbols that might be used in this book.

Table P–3 Symbol Conventions


Symbol	Description	Example	Meaning
`[ ]`	Contains optional arguments and command options.	`ls [-l]`	The `-l` option is not required.
`{ \| }`	Contains a set of choices for a required command option.	`-d {y\|n}`	The `-d` option requires that you use either the `y` argument or the `n` argument.
`${ }`	Indicates a variable reference.	`${com.sun.javaRoot}`	References the value of the `com.sun.javaRoot` variable.
-	Joins simultaneous multiple keystrokes.	Control-A	Press the Control key while you press the A key.
+	Joins consecutive multiple keystrokes.	Ctrl+A+N	Press the Control key, release it, and then press the subsequent keys.
->	Indicates menu item selection in a graphical user interface.	File -> New -> Templates	From the File menu, choose New. From the New submenu, choose Templates.

Shell Prompts in Command Examples

The following table shows default system prompts and superuser prompts.

Table P–4 Shell Prompts


Shell	Prompt
C shell on UNIX and Linux systems	`machine_name%`
C shell superuser on UNIX and Linux systems	`machine_name#`
Bourne shell and Korn shell on UNIX and Linux systems	`$`
Bourne shell and Korn shell superuser on UNIX and Linux systems	`#`

Default Paths and File Names

The following tables describe the default paths and file names used in Web Server documentation.

Table P–5 Default Paths and File Names


Placeholder	Description	Default Value
`install-dir`	Represents the base installation directory for Web Server.	Installation as the `root` user on the Solaris, Linux, AIX, and HP-UX platforms: `/opt/oracle/webserver7` Installation as a non-root user on the Solaris, Linux, AIX, and HP-UX platforms: `user-home-dir/oracle/webserver7` All installations on the Windows platform: `SystemDrive:\Program Files\Oracle\Webserver7`
`instance-dir`	Directory that contains the instance-specific subdirectories.	For all installations, the same as `install-dir`.

The following table shows the default paths and file names for Web Server when installed as a component of Sun Java Enterprise System (Java ES).

Table P–6 Default Paths and File Names for Java ES Installations


Placeholder	Description	Default Value
`install-dir`	Represents the base installation directory for Web Server.	On the Solaris platform: `/opt/SUNWwbsvr7` On the Linux and HP-UX platforms: `/opt/sun/webserver7` On the Windows platform: `SystemDrive:\Program Files\Sun\JavaES5\WebServer7`
`instance-dir`	Directory that contains the instance-specific subdirectories.	On the Solaris platform: `/var/opt/SUNWwbsvr7` On the Linux and HP-UX platforms: `/var/opt/sun/webserver7` On the Windows platform: `SystemDrive:\Program Files\Sun\JavaES5\WebServer7`

Documentation, Support, and Training

The Oracle web site provides information about the following additional resources:

Documentation (http://docs.sun.com/)
Support (http://www.sun.com/support/)
Training (http://education.oracle.com/)

Searching Oracle Product Documentation

Besides searching Oracle product documentation from the docs.sun.com web site, you can use a search engine by typing the following syntax in the search field:

search-term site:docs.sun.com

For example, to search for “proxy,” type the following:

proxy site:docs.sun.com

To include other Oracle web sites in your search (for example, java.sun.com, www.sun.com, and developers.sun.com), use sun.com in place of docs.sun.com in the search field.

Third-Party Web Site References

Third-party URLs are referenced in this document and provide additional, related information.

Note –

Oracle is not responsible for the availability of third-party web sites mentioned in this document. Oracle does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Oracle will not be responsible or liable for any actual or alleged damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through such sites or resources.