Oracle B12255-01 User Manual

Oracle® HTTP Server

Administrator’s Guide

10g Release 1 (10.1)

Part No. B12255-01

December 2003

Oracle HTTP Server Administrator’s Guide, 10g Release 1 (10.1)

Part No. B12255-01

Copyright © 2003 Oracle Corporation. All rights reserved.

Primary Author: Priya Darshane

Contributor: Julia Pond, Warren Briese, Kevin Clark, Priscila Darakjian, Sander Goudswaard, Pushkar
Kapasi, Chuck Murray, Mark Nelson, Bert Rich, Shankar Raman, Baogang Song, Kevin Wang

The Programs (which include both the software and documentation) contain proprietary information of
Oracle Corporation; they are provided under a license agreement containing restrictions on use and
disclosure and are also protected by copyright, patent and other intellectual and industrial property
laws. Reverse engineering, disassembly or decompilation of the Programs, except to the extent required
to obtain interoperability with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems
in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this
document is error-free. Except as may be expressly permitted in your license agreement for these
Programs, no part of these Programs may be reproduced or transmitted in any form or by any means,
electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation.

If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on
behalf of the U.S. Government, the following notice is applicable:

Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are “commercial
computer software” and use, duplication, and disclosure of the Programs, including documentation,
shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement.
Otherwise, Programs delivered subject to the Federal Acquisition Regulations are “restricted computer
software” and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR

52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500
Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy, and other measures to ensure the safe use of such applications if the Programs are used for
such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the
Programs.

Oracle is a registered trademark, and Oracle Store, Oracle8i, Oracle9i, SQL*Plus, and PL/SQL are
trademarks or registered trademarks of Oracle Corporation. Other names may be trademarks of their
respective owners.

Contents

Send Us Your Comments ................................................................................................................... xi

Preface.......................................................................................................................................................... xiii

Intended Audience .............................................................................................................................. xiv

Documentation Accessibility ............................................................................................................. xiv

Organization.......................................................................................................................................... xv

Related Documentation ...................................................................................................................... xvi

Conventions......................................................................................................................................... xvii

1 Oracle HTTP Server Overview

Oracle HTTP Server Features ........................................................................................................... 1-2

Oracle HTTP Server Components ................................................................................................... 1-3

Oracle HTTP Server Modules..................................................................................................... 1-3

Oracle HTTP Server Support............................................................................................................ 1-5

Oracle HTTP Server Management .................................................................................................. 1-6

Starting, Stopping, and Restarting Oracle HTTP Server ............................................................ 1-6

Starting Oracle HTTP Server....................................................................................................... 1-6

Stopping Oracle HTTP Server .................................................................................................... 1-7

Restarting Oracle HTTP Server .................................................................................................. 1-7

2 Oracle HTTP Server Concepts

Understanding Oracle HTTP Server Directory Structure........................................................... 2-2

Accessing Configuration Files.......................................................................................................... 2-2

Configuration Files Syntax................................................................................................................ 2-2

iii

Understanding Modules.................................................................................................................... 2-3

Classes of Directives........................................................................................................................... 2-3

Scope of Directives ............................................................................................................................. 2-4

Container Directives..................................................................................................................... 2-4

<Directory> ............................................................................................................................ 2-4

<DirectoryMatch> ................................................................................................................. 2-5

<Files> ..................................................................................................................................... 2-5

<FilesMatch>.......................................................................................................................... 2-5

<Location>.............................................................................................................................. 2-5

<LocationMatch>................................................................................................................... 2-6

<Limit>.................................................................................................................................... 2-6

<LimitExcept>........................................................................................................................ 2-6

<VirtualHost> ........................................................................................................................ 2-7

Block Directives............................................................................................................................. 2-7

About .htaccess Files .......................................................................................................................... 2-7

3 Specifying Server and File Locations

Setting Server and Administrator Functions................................................................................. 3-2

ServerName ................................................................................................................................... 3-2

UseCanonicalName ...................................................................................................................... 3-2

ServerAdmin ................................................................................................................................. 3-3

ServerSignature............................................................................................................................. 3-3

ServerTokens ................................................................................................................................. 3-3

ServerAlias..................................................................................................................................... 3-3

Specifying File Locations .................................................................................................................. 3-4

CoreDumpDirectory..................................................................................................................... 3-4

DocumentRoot .............................................................................................................................. 3-4

ErrorLog ......................................................................................................................................... 3-5

LockFile .......................................................................................................................................... 3-5

PidFile............................................................................................................................................. 3-5

ScoreBoardFile............................................................................................................................... 3-5

ServerRoot...................................................................................................................................... 3-6

4 Managing Server Processes

Oracle HTTP Server Processing Model .......................................................................................... 4-2

iv

Running Oracle HTTP Server as Root ....................................................................................... 4-2

Additional Security Considerations .......................................................................................... 4-3

Handling Server Processes................................................................................................................ 4-4

ServerType..................................................................................................................................... 4-4

Group ............................................................................................................................................. 4-4

User................................................................................................................................................. 4-4

Limiting the Number of Processes and Connections .................................................................. 4-5

StartServers.................................................................................................................................... 4-5

ThreadsPerChild........................................................................................................................... 4-5

MaxClients..................................................................................................................................... 4-5

MaxRequestsPerChild.................................................................................................................. 4-6

MaxSpareServers .......................................................................................................................... 4-6

MinSpareServers........................................................................................................................... 4-6

Getting Information about Processes ............................................................................................. 4-7

5 Managing the Network Connection

Specifying Listener Ports and Addresses....................................................................................... 5-2

BindAddress.................................................................................................................................. 5-3

Port.................................................................................................................................................. 5-3

Listen .............................................................................................................................................. 5-3

Managing Interaction Between Server and Network.................................................................. 5-4

ListenBackLog............................................................................................................................... 5-4

SendBufferSize .............................................................................................................................. 5-4

TimeOut ......................................................................................................................................... 5-4

Managing Connection Persistence .................................................................................................. 5-5

KeepAlive ...................................................................................................................................... 5-5

KeepAliveTimeout ....................................................................................................................... 5-5

MaxKeepAliveRequests............................................................................................................... 5-5

Configuring Reverse Proxies and Load Balancers........................................................................ 5-6

6 Configuring and Using Server Logs

Using Oracle Diagnostic Logging.................................................................................................... 6-2

Overview........................................................................................................................................ 6-2

Configuring Oracle HTTP Server............................................................................................... 6-2

Specifying Log Formats..................................................................................................................... 6-5

v

Specifying Log Level.......................................................................................................................... 6-6

Specifying Log Files ........................................................................................................................... 6-7

Access Log ..................................................................................................................................... 6-7

CustomLog .................................................................................................................................... 6-7

Error Log ........................................................................................................................................ 6-8

PID File........................................................................................................................................... 6-8

Piped Log ....................................................................................................................................... 6-8

Rewrite Log.................................................................................................................................... 6-9

Script Log ....................................................................................................................................... 6-9

SSL Log........................................................................................................................................... 6-9

Transfer Log................................................................................................................................... 6-9

7 Oracle HTTP Server Modules

List of Modules.................................................................................................................................... 7-2

mod_access ........................................................................................................................................... 7-3

mod_actions ......................................................................................................................................... 7-3

mod_alias.............................................................................................................................................. 7-3

mod_asis ............................................................................................................................................... 7-3

mod_auth .............................................................................................................................................. 7-3

mod_auth_anon................................................................................................................................... 7-4

mod_auth_db ....................................................................................................................................... 7-4

mod_auth_dbm.................................................................................................................................... 7-4

mod_auth_digest................................................................................................................................. 7-4

mod_autoindex .................................................................................................................................... 7-4

mod_cern_meta.................................................................................................................................... 7-4

mod_certheaders ................................................................................................................................. 7-5

mod_cgi................................................................................................................................................. 7-8

mod_define........................................................................................................................................... 7-8

mod_digest ........................................................................................................................................... 7-8

mod_dir................................................................................................................................................. 7-9

mod_dms............................................................................................................................................... 7-9

mod_env................................................................................................................................................ 7-9

mod_example....................................................................................................................................... 7-9

mod_expires ....................................................................................................................................... 7-10

mod_fastcgi ........................................................................................................................................ 7-10

vi

mod_headers...................................................................................................................................... 7-10

mod_imap........................................................................................................................................... 7-10

mod_include ...................................................................................................................................... 7-10

mod_info............................................................................................................................................. 7-11

mod_isapi ........................................................................................................................................... 7-11

mod_log_agent .................................................................................................................................. 7-11

mod_log_config ................................................................................................................................. 7-11

mod_log_referer ................................................................................................................................ 7-11

mod_mime.......................................................................................................................................... 7-12

mod_mime_magic............................................................................................................................. 7-12

mod_mmap_static............................................................................................................................. 7-12

mod_negotiation ............................................................................................................................... 7-12

mod_onsint......................................................................................................................................... 7-13

Benefits of mod_onsint .............................................................................................................. 7-13

Implementation Differences for mod_onsint ......................................................................... 7-14

mod_ossl............................................................................................................................................. 7-15

mod_perl............................................................................................................................................. 7-15

Database Usage Notes................................................................................................................ 7-16

Using Perl to Access the Database .................................................................................... 7-16

Testing Database Connection ............................................................................................ 7-17

Using SQL NCHAR Datatypes ......................................................................................... 7-17

mod_plsql........................................................................................................................................... 7-19

Creating a DAD .......................................................................................................................... 7-20

Configuration Files..................................................................................................................... 7-21

plsql.conf............................................................................................................................... 7-21

dads.conf............................................................................................................................... 7-22

cache.conf ............................................................................................................................. 7-22

Configuration Parameters ......................................................................................................... 7-22

plsql.conf............................................................................................................................... 7-24

dads.conf............................................................................................................................... 7-26

cache.conf ............................................................................................................................. 7-49

mod_proxy.......................................................................................................................................... 7-53

mod_rewrite....................................................................................................................................... 7-53

mod_rewrite Rules Processing ................................................................................................. 7-53

mod_rewrite Directives ............................................................................................................. 7-55

vii

Rewrite Rules Hints.................................................................................................................... 7-57

Redirection Examples................................................................................................................. 7-58

mod_setenvif...................................................................................................................................... 7-59

mod_so ................................................................................................................................................ 7-59

mod_speling....................................................................................................................................... 7-59

mod_status.......................................................................................................................................... 7-59

mod_unique_id ................................................................................................................................. 7-60

mod_userdir ....................................................................................................................................... 7-60

mod_usertrack ................................................................................................................................... 7-60

mod_vhost_alias................................................................................................................................ 7-60

8 Managing Security

About Oracle HTTP Server Security............................................................................................... 8-2

Classes of Users and Their Privileges............................................................................................. 8-3

Resources Protected............................................................................................................................ 8-3

Authentication and Authorization Enforcement.......................................................................... 8-4

Host-based Access Control.......................................................................................................... 8-4

Access Control for Virtual Hosts......................................................................................... 8-5

Using mod_access and mod_setenvif for Host-based Access Control.......................... 8-6

User Authentication and Authorization.................................................................................... 8-9

Using mod_auth to Authenticate Users ............................................................................. 8-9

Using mod_ossl to Authenticate Users ............................................................................ 8-10

Enabling SSL......................................................................................................................... 8-10

Security Services Implemented Within Oracle HTTP Server.................................................. 8-12

Using mod_ossl........................................................................................................................... 8-12

Using mod_ossl Directives................................................................................................. 8-13

Using mod_proxy Directives ............................................................................................. 8-30

Using mod_ossl Directives to Configure Client Authentication.................................. 8-32

Using the iasobf Utility....................................................................................................... 8-33

9 Frequently Asked Questions

Creating Application-specific Error Pages................................................................................ 9-2

Offering HTTPS to ISP (Virtual Host) Customers ................................................................... 9-2

Using Oracle HTTP Server as Cache.......................................................................................... 9-2

Using Different Language and Character Set Versions of Document .................................. 9-3

viii

Sending Proxy Sensitive Requests to Oracle HTTP Server Behind a Firewall .................... 9-3

Oracle HTTP Server Version Number....................................................................................... 9-3

Apache v2.0 Support with Oracle Database, 10g Release 1 (10.1) ......................................... 9-3

Applying Apache Security patches to Oracle HTTP Server................................................... 9-3

Supporting PHP............................................................................................................................ 9-4

Creating Application Name Space that Works Across Firewalls and Clusters .................. 9-4

Protecting Web Site From Hackers ............................................................................................ 9-5

A Oracle HTTP Server Configuration Files

httpd.conf ............................................................................................................................................. A-2

httpd.conf File Structure.............................................................................................................. A-2

Global Environment.............................................................................................................. A-2

Main Server Configuration .................................................................................................. A-3

Virtual Hosts .......................................................................................................................... A-3

mime.types .................................................................................................................................... A-4

dms.conf......................................................................................................................................... A-4

oracle_apache.conf ....................................................................................................................... A-5

aqxml.conf .............................................................................................................................. A-5

ojsp.conf .................................................................................................................................. A-5

plsql.conf................................................................................................................................. A-5

xml.conf................................................................................................................................... A-6

ssl.conf............................................................................................................................................ A-6

opmn.xml.............................................................................................................................................. A-7

B Third Party Licenses

Apache HTTP Server.......................................................................................................................... B-2

The Apache Software License..................................................................................................... B-2

Apache SOAP ...................................................................................................................................... B-3

Apache SOAP License.................................................................................................................. B-3

DBI Module ......................................................................................................................................... B-5

Perl Artistic License...................................................................................................................... B-5

Preamble ................................................................................................................................. B-5

Definitions .............................................................................................................................. B-5

Perl......................................................................................................................................................... B-9

Perl Kit Readme ............................................................................................................................ B-9

ix

mod_perl 1.26 License............................................................................................................... B-10

Perl Artistic License................................................................................................................... B-11

Preamble .............................................................................................................................. B-11

Definitions ........................................................................................................................... B-12

mod_dav............................................................................................................................................. B-15

FastCGI .............................................................................................................................................. B-17

FastCGI Developer’s Kit License............................................................................................. B-17

Module mod_fastcgi License.................................................................................................... B-18

Jaxen.................................................................................................................................................... B-20

The Jaxen Software License...................................................................................................... B-20

Expat ................................................................................................................................................... B-22

Expat License.............................................................................................................................. B-22

SAXPath ............................................................................................................................................. B-23

The SAXPath License ................................................................................................................ B-23

Glossary

Index

x

Send Us Your Comments

Oracle HTTP Server Administrator’s Guide, 10g Release 1 (10.1)

Part No. B12255-01

Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this
document. Your input is an important part of the information used for revision.

■ Did you find any errors?

■ Is the information clearly presented?

■ Do you need more information? If so, where?

■ Are the examples correct? Do you need more examples?

■ What features did you like most?

If you find any errors or have any other suggestions for improvement, please indicate the document
title and part number, and the chapter, section, and page number (if available). You can send com­ments to us in the following ways:

■ Electronic mail: [e-mail]

■ FAX: [phone] Attn: Server Technologies Documentation Manager

■ Postal service:

Oracle Corporation
Server Technologies Documentation
500 Oracle Parkway, Mailstop 4op11
Redwood Shores, CA 94065
USA

If you would like a reply, please give your name, address, telephone number, and (optionally) elec­tronic mail address.

If you have problems with the software, please contact your local Oracle Support Services.

xi

xii

This guide describes how to administer the Oracle HTTP Server.

This preface contains these topics:

■ Intended Audience

■ Documentation Accessibility

■ Organization

■ Related Documentation

■ Conventions

Preface

xiii

Intended Audience

The Oracle HTTP Server Administrator’s Guide is intended for database

administrators and security managers.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation

accessible, with good usability, to the disabled community. To that end, our

documentation includes features that make information available to users of

assistive technology. This documentation is available in HTML format, and contains

markup to facilitate access by the disabled community. Standards will continue to

evolve over time, and Oracle is actively engaged with other market-leading

technology vendors to address technical obstacles so that our documentation can be

accessible to all of our customers. For additional information, visit the Oracle

Accessibility Program Web site at

http://www.oracle.com/accessibility/

Accessibility of Links to External Web Sites in Documentation This

documentation may contain links to Web sites of other companies or organizations

that Oracle does not own or control. Oracle neither evaluates nor makes any

representations regarding the accessibility of these Web sites.

xiv

Organization

This document contains:

Chapter 1, "Oracle HTTP Server Overview"

This chapter describes the Oracle HTTP Server, highlighting the differences
between the Oracle distribution and the open source Apache product on which it is
based. It also explains how to start, stop and restart the server.

Chapter 2, "Oracle HTTP Server Concepts"

This chapter introduces you to the Oracle HTTP Server directory structure, and
configuration files, configuration file syntax, modules, and directives.

Chapter 3, "Specifying Server and File Locations"

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

Chapter 4, "Managing Server Processes"

This chapter provides an overview of the Oracle HTTP Server processes, and
provides information on how to regulate, and monitor these processes.

Chapter 5, "Managing the Network Connection"

This chapter provides information about specifying IP addresses and ports, and
managing server interaction, and network connection persistence.

Chapter 6, "Configuring and Using Server Logs"

This chapter discusses Oracle Diagnostic Logging, log formats, and describes
various log files and their locations.

Chapter 7, "Oracle HTTP Server Modules"

This chapter describes the modules (mods) included in the Oracle HTTP Server. The
modules extend the basic functionality of the Web server, and support integration
between Oracle HTTP Server and other Oracle Database components.

Chapter 8, "Managing Security"

This chapter provides an overview of Oracle HTTP Server security features and
configuration information for setting up a secure Web site using them.

xv

Chapter 9, "Frequently Asked Questions"

This chapter provides answers to frequently asked questions about Oracle HTTP

Server.

Chapter A, "Oracle HTTP Server Configuration Files"

This appendix lists commonly used Oracle HTTP Server configuration files.

Chapter B, "Third Party Licenses"

This appendix includes the Third Party License for all the third party products

included with Oracle Database.

Glossary

The glossary defines terminology used throughout this guide and the Oracle

Database documentation set.

Related Documentation

For more information, see these Oracle resources:

■ Oracle Database Documentation Library

■ Oracle Database Platform-Specific Documentation on Oracle Database Disk 1

Printed documentation is available for sale in the Oracle Store at

http://oraclestore.oracle.com/

xvi

To download free release notes, installation documentation, white papers, or other

collateral, please visit the Oracle Technology Network (OTN). You must register

online before using OTN; registration is free and can be done at

http://otn.oracle.com/membership/

If you already have a username and password for OTN, then you can go directly to

the documentation section of the OTN Web site at

http://otn.oracle.com/documentation/

Conventions

This section describes the conventions used in the text and code examples of this
documentation set. It describes:

■ Conventions in Text

■ Conventions in Code Examples

■ Conventions for Windows Operating Systems

Conventions in Text

We use various conventions in text to help you more quickly identify special terms.
The following table describes those conventions and provides examples of their use.

Convention Meaning Example

Bold Bold typeface indicates terms that are

Italics Italic typeface indicates book titles or

UPPERCASE
monospace
(fixed-width)
font

defined in the text or terms that appear in
a glossary, or both.

emphasis.

Uppercase monospace typeface indicates
elements supplied by the system. Such
elements include parameters, privileges,
datatypes, RMAN keywords, SQL
keywords, SQL*Plus or utility commands,
packages and methods, as well as
system-supplied column names, database
objects and structures, usernames, and
roles.

When you specify this clause, you create an
index-organized table.

Oracle9i Database Concepts

Ensure that the recovery catalog and target
database do not reside on the same disk.

You can specify this clause only for a NUMBER
column.

You can back up the database by using the
BACKUP command.

Query the TABLE_NAME column in the USER_
TABLES data dictionary view.

Use the DBMS_STATS.GENERATE_STATS
procedure.

xvii

Convention Meaning Example

lowercase
monospace
(fixed-width)
font

lowercase
italic
monospace
(fixed-width)
font

Lowercase monospace typeface indicates

executables, filenames, directory names,

and sample user-supplied elements. Such

elements include computer and database

names, net service names, and connect

identifiers, as well as user-supplied

database objects and structures, column

names, packages and classes, usernames

and roles, program units, and parameter

values.

Note: Some programmatic elements use a

mixture of UPPERCASE and lowercase.

Enter these elements as shown.

Lowercase italic monospace font

represents placeholders or variables.

Enter sqlplus to open SQL*Plus.

The password is specified in the orapwd file.

Back up the datafiles and control files in the
/disk1/oracle/dbs directory.

The department_id, department_name,
and location_id columns are in the
hr.departments table.

Set the QUERY_REWRITE_ENABLED
initialization parameter to true.

Connect as oe user.

The JRepUtil class implements these
methods.

You can specify the parallel_clause.

Run Uold_release.SQL where old_
release refers to the release you installed
prior to upgrading.

Conventions in Code Examples

Code examples illustrate SQL, PL/SQL, SQL*Plus, or other command-line

statements. They are displayed in a monospace (fixed-width) font and separated

from normal text as shown in this example:

SELECT username FROM dba_users WHERE username = ’MIGRATE’;

The following table describes typographic conventions used in code examples and

provides examples of their use.

Convention Meaning Example

[ ] Brackets enclose one or more optional

items. Do not enter the brackets.

{ } Braces enclose two or more items, one of

which is required. Do not enter the braces.

| A vertical bar represents a choice of two

or more options within brackets or braces.

Enter one of the options. Do not enter the

vertical bar.

xviii

DECIMAL (digits [ , precision ])

{ENABLE | DISABLE}

{ENABLE | DISABLE}
[COMPRESS | NOCOMPRESS]

Convention Meaning Example

... Horizontal ellipsis points indicate either:

■ That we have omitted parts of the

CREATE TABLE ... AS subquery;

code that are not directly related to
the example

■ That you can repeat a portion of the

SELECT col1, col2, ... , coln FROM
employees;

code

.
.
.

Vertical ellipsis points indicate that we
have omitted several lines of code not
directly related to the example.

Other notation You must enter symbols other than

brackets, braces, vertical bars, and ellipsis
points as shown.

Italics Italicized text indicates placeholders or

variables for which you must supply
particular values.

UPPERCASE Uppercase typeface indicates elements

supplied by the system. We show these
terms in uppercase in order to distinguish
them from terms you define. Unless terms
appear in brackets, enter them in the
order and with the spelling shown.
However, because these terms are not
case sensitive, you can enter them in
lowercase.

lowercase Lowercase typeface indicates

programmatic elements that you supply.
For example, lowercase indicates names
of tables, columns, or files.

Note: Some programmatic elements use a
mixture of UPPERCASE and lowercase.
Enter these elements as shown.

SQL> SELECT NAME FROM V$DATAFILE;
NAME

-----------------------------------­/fsl/dbs/tbs_01.dbf
/fs1/dbs/tbs_02.dbf
.
.
.
/fsl/dbs/tbs_09.dbf
9 rows selected.

acctbal NUMBER(11,2);
acct CONSTANT NUMBER(4) := 3;

CONNECT SYSTEM/system_password
DB_NAME = database_name

SELECT last_name, employee_id FROM
employees;
SELECT * FROM USER_TABLES;
DROP TABLE hr.employees;

SELECT last_name, employee_id FROM
employees;
sqlplus hr/hr
CREATE USER mjones IDENTIFIED BY ty3MU9;

xix

Conventions for Windows Operating Systems

The following table describes conventions for Windows operating systems and

provides examples of their use.

Convention Meaning Example

Choose Start > How to start a program. To start the Database Configuration Assistant,

File and directory
names

C:\> Represents the Windows command

Special characters The backslash (\) special character is

HOME_NAME Represents the Oracle home name. The

File and directory names are not case

sensitive. The following special characters

are not allowed: left angle bracket (<),

right angle bracket (>), colon (:), double

quotation marks ("), slash (/), pipe (|),

and dash (-). The special character

backslash (\) is treated as an element

separator, even when it appears in quotes.

If the file name begins with \\, then

Windows assumes it uses the Universal

Naming Convention.

prompt of the current hard disk drive.

The escape character in a command

prompt is the caret (^). Your prompt

reflects the subdirectory in which you are

working. Referred to as the command

prompt in this manual.

sometimes required as an escape

character for the double quotation mark

(") special character at the Windows

command prompt. Parentheses and the

single quotation mark (’) do not require

an escape character. Refer to your

Windows operating system

documentation for more information on

escape and special characters.

home name can be up to 16 alphanumeric

characters. The only special character

allowed in the home name is the

underscore.

choose Start > Programs > Oracle - HOME_
NAME > Configuration and Migration Tools >
Database Configuration Assistant.

c:\winnt"\"system32 is the same as
C:\WINNT\SYSTEM32

C:\oracle\oradata>

C:\>exp scott/tiger TABLES=emp
QUERY=\"WHERE job=’SALESMAN’ and
sal<1600\"
C:\>imp SYSTEM/password FROMUSER=scott
TABLES=(emp, dept)

C:\> net start OracleHOME_NAMETNSListener

xx

Convention Meaning Example

ORACLE_HOME
and ORACLE_
BASE

In releases prior to Oracle8i release 8.1.3,
when you installed Oracle components,
all subdirectories were located under a
top level ORACLE_HOME directory. For
Windows NT, the default location was
C:\orant.

This release complies with Optimal
Flexible Architecture (OFA) guidelines.
All subdirectories are not under a top
level ORACLE_HOME directory. There is a
top level directory called ORACLE_BASE
that by default is C:\oracle. If you
install the latest Oracle release on a
computer with no other Oracle software
installed, then the default setting for the
first Oracle home directory is
C:\oracle\orann, where nn is the
latest release number. The Oracle home
directory is located directly under
ORACLE_BASE.

All directory path examples in this guide
follow OFA conventions.

Refer to Oracle9i Database Getting Starting
for Windows for additional information
about OFA compliances and for
information about installing Oracle
products in non-OFA compliant
directories.

Go to the ORACLE_BASE\ORACLE_
HOME\rdbms\admin directory.

xxi

xxii

1

Oracle HTTP Server Overview

This chapter describes the Oracle HTTP Server, highlighting the differences
between the Oracle distribution and the open source Apache product on which it is
based. It also explains how to start, stop and restart the server.

Topics discussed are:

■ Oracle HTTP Server Features

■ Oracle HTTP Server Components

■ Oracle HTTP Server Support

■ Oracle HTTP Server Management

■ Starting, Stopping, and Restarting Oracle HTTP Server

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.

Oracle HTTP Server Overview 1-1

Oracle HTTP Server Features

Oracle HTTP Server Features

Oracle HTTP Server is the Web server component of Oracle Database. It is based on

the Apache HTTP Server, version 1.3.28. It is a robust, reliable Web server,

preconfigured to do the following:

■ provide a high availability infrastructure integration with Oracle Process

Manager and Notification Server (OPMN), for process management, death

detection and failover for Oracle HTTP Server processes.

See Also: Oracle Application Server 10g High Availability Guide

■ provide Dynamic Monitoring Services (DMS) metrics that give runtime

performance statistics for Oracle HTTP Server processes.

See Also: Oracle Application Server 10g Performance Guide

■ provide a request ID, which enhances request tracking through various

components by attaching a request ID to each request. This provides more
detailed information, allowing you to see how much time a particular request
spends in any component or layer.

■ enable securing of transactions with Secure Sockets Layer (SSL) technology.

See Also:

■ Oracle Application Server 10g Security Guide

■ Chapter 8, "Managing Security" on page 8-1

■ execute Perl scripts in the same process as the Oracle HTTP Server, or as CGI

script.

■ access database stored procedures with a PL/SQL engine.

See Also: Oracle Application Server 10g mod_plsql User’s Guide

■ enable scripting of HTML pages with PL/SQL code.

1-2 Oracle HTTP Server Administrator’s Guide

Oracle HTTP Server Components

Oracle HTTP Server consists of several components that run within the same
process. These components provide the extensive list of features that Oracle HTTP
Server offers when handling client requests. Following are the major components:

■ HTTP Listener: Oracle HTTP Server is based on an Apache HTTP listener to

serve client requests. An HTTP server listener handles incoming requests and
routes them to the appropriate processing utility.

■ Modules (mods): Many of the standard Apache modules are included with

Oracle HTTP Server. Oracle also includes several internal modules that are
specific to Oracle Database components.

See Also: "Oracle HTTP Server Modules" on page 1-3 for a

complete list of modules shipped with Oracle HTTP Server.

■ Perl Interpreter: A persistent Perl runtime environment embedded in Oracle

HTTP Server through mod_perl.

See Also: Oracle Application Server 10g Concepts for more

information regarding Oracle Database components, and how they
relate to each other.

Oracle HTTP Server Components

Oracle HTTP Server Modules

Table 1–1 identifies the modules shipped with Oracle HTTP Server. Modules extend

the basic functionality of the Web server, and support integration between Oracle
HTTP Server and other Oracle Database components. Note that the list differs from
the Apache open source distribution (given the inclusion of Oracle modules), and
that not all modules are supported by Oracle.

Table 1–1 Oracle HTTP Server Modules

Module Oracle Support Notes

mod_access Yes

mod_actions Yes

mod_alias Yes

mod_asis No

mod_auth Yes

mod_auth_anon Yes

Oracle HTTP Server Overview 1-3

Oracle HTTP Server Components

Table 1–1 Oracle HTTP Server Modules (Cont.)

Module Oracle Support Notes

mod_auth_db No Disabled. Not shipped by Oracle.

mod_auth_dbm No

mod_auth_digest

No

mod_autoindex Yes

mod_cern_meta No

mod_certheaders Yes

mod_cgi Yes

mod_define Yes UNIX systems only.

mod_digest Yes

mod_dir Yes

mod_dms Yes Oracle module.

mod_env Yes

mod_example No

mod_expires Yes

mod_fastcgi Yes

mod_headers Yes

mod_imap No

mod_include Yes

mod_info Ye s

Disabled. Experimental MD5 authentication; not
shipped by Oracle.

mod_isapi No Windows systems only. Not shipped by Oracle

mod_log_agent No Deprecated.

mod_log_config Yes

mod_log_referer Yes Deprecated.

mod_mime Yes

mod_mime_magic Yes

mod_mmap_static No

mod_negotiation Yes

1-4 Oracle HTTP Server Administrator’s Guide

Table 1–1 Oracle HTTP Server Modules (Cont.)

Module Oracle Support Notes

mod_onsint Yes Oracle module.

mod_ossl Yes Oracle module.

mod_perl Yes

mod_plsql Yes Oracle module.

mod_proxy Yes

mod_rewrite Yes

mod_setenvif Yes

mod_so Yes

mod_speling Yes

mod_status Yes

mod_unique_id Yes

mod_userdir Yes

mod_usertrack Yes

Oracle HTTP Server Support

mod_vhost_alias Yes

Oracle HTTP Server Support

Oracle provides technical support for the following Oracle HTTP Server features
and conditions:

■ Modules included in the Oracle distribution, except as noted in the table in

Table 1–1, "Oracle HTTP Server Modules". Modules from any other source,

including the Apache Software Foundation, are not supported by Oracle.

■ Problems that can be reproduced within an Apache configuration consisting

only of supported Oracle Apache modules.

■ Use of the included Perl interpreter within the supported Apache configuration.

Oracle HTTP Server Overview 1-5

Oracle HTTP Server Management

Oracle HTTP Server Management

You can manage Oracle HTTP Server using opmnctl. It is the command-line utility

for Oracle Process Manager and Notification Server (OPMN) for process

management. It is located in

■ UNIX: ORACLE_HOME/opmn/bin

■ Windows: ORACLE_HOME\opmn\bin

See Also: Oracle Process Manager and Notification Server

Administrator’s Guide for more information on opmnctl.

Starting, Stopping, and Restarting Oracle HTTP Server

Oracle HTTP Server is managed by Oracle Process Manager and Notification Server

(OPMN). You must always use the opmnctl utility to start, stop and restart Oracle

HTTP Server. Otherwise, the configuration management infrastructure cannot

detect or communicate with the Oracle HTTP Server processes, and problems may

occur.

Note: Do not use the apachectl utility to manage the Oracle

HTTP Server.

To determine the state of Oracle HTTP Server, use the following command:

opmnctl status

The processes are listed with their current state such as “Up” or “Down”.

Starting Oracle HTTP Server

To start Oracle HTTP Server, use the startproc command:

■ UNIX: ORACLE_HOME/opmn/bin> opmnctl [verbose] startproc

ias-component=HTTP_Server

■ Windows: ORACLE_HOME\opmn\bin> opmnctl [verbose] startproc

ias-component=HTTP_Server

1-6 Oracle HTTP Server Administrator’s Guide

Stopping Oracle HTTP Server

To stop Oracle HTTP Server, use the stopproc command:

■ UNIX: ORACLE_HOME/opmn/bin> opmnctl [verbose] stopproc

ias-component=HTTP_Server

■ Windows: ORACLE_HOME\opmn\bin> opmnctl [verbose] stopproc

ias-component=HTTP_Server

Restarting Oracle HTTP Server

Restarting Oracle HTTP Server performs a graceful restart, which is invisible to
clients. In a graceful restart, on UNIX, a USR1 signal is sent. When the process
receives this signal, it tells the children to exit after processing the current request.
(Children that are not servicing requests exit immediately.)

The parent re-reads the configuration files and re-opens the log files, replacing the
children with new children in accordance with the settings it finds when re-reading
the configuration files. It always observes the process creation settings
(MaxClients, MaxSpareServers, MinSpareServers) specified, and takes the
current server load into account.

Starting, Stopping, and Restarting Oracle HTTP Server

To restart Oracle HTTP Server, use the restartproc command:

■ UNIX: ORACLE_HOME/opmn/bin> opmnctl [verbose] restartproc

ias-component=HTTP_Server

■ Windows: ORACLE_HOME\opmn\bin> opmnctl [verbose] restartproc

ias-component=HTTP_Server

See Also: Oracle Process Manager and Notification Server

Administrator’s Guide for more information on opmnctl command
options.

Oracle HTTP Server Overview 1-7

Starting, Stopping, and Restarting Oracle HTTP Server

1-8 Oracle HTTP Server Administrator’s Guide