Preface

This guide discusses the purpose and use of the configuration files for Sun Java System Web Server 6.1, including server.xml, magnus.conf, and mime.types, and provides comprehensive lists of the elements and directives in these configuration files.

This preface contains information about the following topics:

• Who Should Use This Guide

• Using the Sun Java System Web Server Documentation

• How This Guide Is Organized

• Documentation Conventions

• Product Support

Who Should Use This Guide

The intended audience for this guide is one who administers and maintains the Sun Java System Web Server.

This guide assumes you are familiar with the following topics:

• J2SE specification

• HTTP

• HTML

• XML

• Java programming

• Java APIs as defined in servlet, JSP, and JDBC specifications

• Relational database concepts

Using the Sun Java System Web Server Documentation

The Sun Java System Web Server 6.1 SP11 manuals are available as online files in PDF and HTML formats at: http://docs.sun.com/app/docs/coll/1308.8

The following table lists the tasks and concepts described in the Sun Java System Web Server manuals.

Table P–1 Sun Java System Web Server Documentation Roadmap

For Information About	See the Following
Late-breaking information about the software and documentation	Sun Java System Web Server 6.1 SP11 Release Notes
Information about Sun Java System Web Server 6.1 FastCGI plug-in, including information about server application functions (SAFs), installation, configuration, technical notes, and pointers to additional resources.	Sun Java System Web Server 6.1 SP11 FastCGI Plug-in Release Notes
Information about Sun Java System Web Server 6.1 Reverse Proxy plug-in, including information about server application functions (SAFs), installation, configuration, technical notes, and pointers to additional resources.	Sun Java System Web Server 6.1 SP11 Reverse Proxy Plug-in Release Notes
Getting started with Sun Java System Web Server, including hands-on exercises that introduce server basics and features (recommended for first-time users)	Sun Java System Web Server 6.1 SP11 Getting Started Guide
Performing installation and migration tasks:  Installing Sun Java System Web Server and its various components, supported platforms, and environments Migrating from Sun ONE Web Server 4.1 or 6.0 to Sun Java System Web Server 6.1	Sun Java System Web Server 6.1 SP11 Installation and Migration Guide Note: If you have the Sun JavaTM Enterprise System 1 installed on your system and you want to upgrade the Sun Java System Web Server 6.1 that is part of Sun Java Enterprise System 1 to Sun Java System Web Server 6.1 SP11, you must use the Java Enterprise System (JES) installer to perform the upgrade. Do not use the separate component installer included with Sun Java System Web Server 6.1 SP11.
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™ 2 Platform, Standard Edition (J2SE platform) 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	Sun Java System Web Server 6.1 SP11 Administrator’s Guide
Using programming technologies and APIs to do the following:  Extend and modify Sun Java System Web Server Dynamically generate content in response to client requests Modify the content of the server	Sun Java System Web Server 6.1 SP11 Programmer’s Guide
Creating custom Netscape Server Application Programmer’s Interface (NSAPI) plugins	Sun Java System Web Server 6.1 SP11 NSAPI Programmer’s Guide
Implementing servlets and JavaServer PagesTM (JSPTM) technology in Sun Java System Web Server	Sun Java System Web Server 6.1 SP11 Programmer’s Guide to Web Applications
Editing configuration files	Sun Java System Web Server 6.1 SP11 Administrator’s Configuration File Reference
Tuning Sun Java System Web Server to optimize performance	Sun Java System Web Server 6.1 SP11 Performance Tuning, Sizing, and Scaling Guide

How This Guide Is Organized

This guide has the following chapters:

• Chapter 1, Basics of Server Operation

  Introduces the major configuration files that control the Sun Java System Web Server and describes how to activate and edit them.

• Chapter 2, Server Configuration Elements in server.xml

  Describes the server.xml file, which controls most aspects of server operation.

• Chapter 3, Syntax and Use of magnus.conf

  Describes the directives you can set in the magnus.conf file to configure the Sun Java System Web Server during initialization.

• Chapter 4, Predefined SAFs in obj.conf

  describes the predefined SAFs used in the obj.conf file.

• Chapter 5, MIME Types

  Describes the MIME types file, which maps file extensions to file types.

• Chapter 6, Other Server Configuration Files

  Lists other important configuration files and provides a quick reference of their contents.

• Appendix A, Configuration Changes Between iPlanet Web Server 4.1 and Sun Java System Web Server 6.1

  Describes the changes in configuration files between the 4.x and 6.1 versions of Sun Java System Web Server.

• Appendix B, Configuration Changes Between iPlanet Web Server 6.0 and Sun Java System Web Server 6.1

  Describes the changes in configuration files between the 6.0 and 6.1 versions of Sun Java System Web Server.

• Appendix C, Time Formats

  Describes the format strings used for dates and times in the server log.

• Appendix D, Alphabetical List of Server Configuration Elements

  Provides an alphabetical list for easy lookup of elements in server.xml and directives in magnus.conf.

• Appendix E, Alphabetical List of Predefined SAFs

  Provides an alphabetical list for easy lookup of directives in obj.conf.

Documentation Conventions

This section describes the types of conventions used throughout this guide:

• File and directory paths are given in UNIX® format (with forward slashes separating directory names). For Windows versions, the directory paths are the same, except that backslashes are used to separate directories.

• URLs are given in the format:

  http://server.domain/path/file.html

  In these URLs, server is the server name where applications are run; domain is your Internet domain name; path is the server's directory structure; and file is an individual filename. Italic items in URLs are placeholders.

• Font conventions include:

  • The monospace font is used for sample code and code listings, API and language elements (such as function names and class names), file names, pathnames, directory names, and HTML tags.

  • Italic type is used for code variables.

  • Italic type is also used for book titles, emphasis, variables and placeholders, and words used in the literal sense.

  • Bold type is used as either a paragraph lead-in or to indicate words used in the literal sense.

  Installation root directories are indicated by install_dir in this document.

  By default, the location of install_dir on UNIX-based platforms is:

  /opt/SUNWwbsvr/

  On Windows, it is:

  C:\Sun\WebServer6.1

Product Support

If you have problems with your system, contact customer support using one of the following mechanisms:

• The online support web site at:

  http://www.sun.com/service/sunone/software

• The telephone dispatch number associated with your maintenance contract

Please have the following information available prior to contacting support. This helps to ensure that our support staff can best assist you in resolving problems:

• Description of the problem, including the situation where the problem occurs and its impact on your operation

• Machine type, operating system version, and product version, including any patches and other software that might be affecting the problem

• Detailed steps on the methods you have used to reproduce the problem

• Any error logs or core dumps

Documentation, Support, and Training

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

• Documentation

• Support

• Training

Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to http://docs.sun.com and click Feedback.

Typographic Conventions

The following table describes the typographic conventions 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	Placeholder: replace 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	Read Chapter 6 in the User's Guide. A cache is a copy that is stored locally. Do not save the file. Note: Some emphasized items appear bold online.

Shell Prompts in Command Examples

The following table shows the default UNIX® system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Table P–3 Shell Prompts

Shell	Prompt
C shell	machine_name%
C shell for superuser	machine_name#
Bourne shell and Korn shell	$
Bourne shell and Korn shell for superuser	#