This Configuration File Reference provides information about configuring and administering iPlanet Web Proxy Server.
This preface consists of the following sections:
This book is intended for information technology administrators in production environments. The guide assumes familiarity with the following areas:
Performing basic system administration tasks
Installing software
Using web browsers
Issuing commands in a terminal window
The guide is divided into chapters, each of which addresses specific areas and tasks. The following table lists the chapters of the guide and their contents.
Table P–1 Guide Organization
Chapter |
Description |
This chapter introduces the major configuration files that control Proxy Server and describes how to activate and edit them. |
|
Chapter 2, Server Configuration Elements in the server.xml file |
This chapter discusses the server.xml file, which controls most aspects of server operation. |
This chapter discusses the directives you can set in the magnus.conf file to configure Proxy Server during initialization. |
|
This chapter discusses the SAFs you can set in the obj.conf configuration file to configure Proxy Server during initialization. |
|
This chapter describes the predefined SAFs used in the obj.conf file. |
|
This chapter discusses the MIME types file, which maps file extensions to file types. |
|
This chapter lists other important configuration files and provides a quick reference of their contents. |
|
This appendix describes the changes in configuration files between Sun iPlanet Web Proxy Server 3.6 and iPlanet Web Proxy Server 4. |
|
This appendix describes the format strings used for dates and times in the server log. |
|
This appendix provide an alphabetical list for easy lookup of elements in the server.xml file and directives in the magnus.conf file. |
|
This appendix provide an alphabetical list for easy lookup of directives in the obj.conf file. |
The documentation set lists the Oracle documents that are related to Proxy Server. The URL for Proxy Server 4.0.14 documentation is http://docs.sun.com/coll/1311.14. For an introduction to Proxy Server, refer to the books in the order in which they are listed in the following table.
Table P–2 Proxy Server Documentation
Document Title |
Contents |
---|---|
|
|
Oracle iPlanet Web Proxy Server 4.0.14 Installation and Migration Guide |
Performing installation and migration tasks:
|
Performing administration and management tasks:
|
|
Oracle iPlanet Web Proxy Server 4.0.14 Configuration File Reference |
Editing configuration files |
Oracle iPlanet Web Proxy Server 4.0.14 NSAPI Developer’s Guide |
Creating custom Netscape Server Application Programming Interface (NSAPI) plugins |
Oracle iPlanet Web Proxy Server 4.0.14 Performance Tuning, Sizing, and Scaling Guide |
Tuning Proxy Server to optimize performance |
This section describes the following conventions used in Proxy Server documentation:
The following table describes the typographic changes that are used in this book.
Table P–3 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. |
The following table explains symbols that might be used in this book.
Table P–4 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. |
The following table shows default system prompts and superuser prompts.
Table P–5 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 |
# |
The following table describes the default paths and file names used in Proxy Server documentation.
Table P–6 Default Paths and File Names
Placeholder |
Description |
Default Value |
---|---|---|
install-dir |
Represents the base installation directory for iPlanet Web Proxy Server. |
Solaris and Linux installations: $HOME/Oracle/Middleware/ProxyServer4 Windows installations: C:\Oracle\Middleware\ProxyServer4 |
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/pls/web_prod-plq-dad/db_pages.getpage?page_id=315)
Besides searching Oracle product documentation from the docs.sun.comSM 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 URLs are referenced in this document and provide additional, related information.
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.