Complete Contents
About This Guide
Chapter 1 Introduction to iPlanet Web Server
Chapter 2 Administrating iPlanet Web Servers
Chapter 3 Setting Administration Preferences
Chapter 4 Managing Users and Groups
Chapter 5 Working with Server Security
Chapter 6 Managing Server Clusters
Chapter 7 Configuring Server Preferences
Chapter 8 Understanding Log Files
Chapter 9 Using SNMP to Monitor Servers
Chapter 10 Configuring the Server for Performance
Chapter 11 Extending Your Server with Programs
Chapter 12 Working with Configuration Styles
Chapter 13 Managing Server Content
Chapter 14 Controlling Access to Your Server
Chapter 15 Configuring Web Publishing
Chapter 16 Using Search
Appendix A HyperText Transfer Protocol
Appendix B ACL File Syntax
Appendix C Internationalized iPlanet Web Server
Appendix D Server Extensions for Microsoft FrontPage
Appendix E iPlanet Web Server User Interface
Glossary
Index
Previous Next Contents Index Bookshelf


Appendix E iPlanet Web Server User Interface

The Install a New PKCS#11 Module Page
Public Key Cryptography Standard (PKCS) #11 defines the interface used for communication between SSL and PKCS #11 modules. The PKCS#11 modules are used for standards-based connectivity to SSL hardware accelerators. The Install a New PKCS#11 Module page allows you to import PKCS#11 modules from another location.

The following elements are displayed:

Path to Jar File. Specifies the path from which to import PKCS#11 modules in the form of .jar files.

OK. Saves your entries. You must restart the server in order for your changes to take effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Migrate a 3.x Cert Page (Server Manager)
If you are accessing this page from the Server Manager, see The Migrate a 3.x Cert Page (Server Manager) in the Server Manager section.

The Migrate a 3.X Cert page allows you to migrate certificates from Netscape Enterprise Server 3.x to iPlanet Web Server 4.1.

The following elements are displayed:

3.6 Server Root. Specifies the server root of Netscape Enterprise Server 3.6.

Alias. Specifies the alias mapped to the key-pair file and certificate file you associated it with in the Administration Server.

Password. Specifies the certificate key-pair password.

OK. Saves your entries. You must restart the server in order for your changes to take effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Cluster Management Tab
Clusters are groups of Netscape/iPlanet servers that can be administered from a single Netscape administration server. All servers in a cluster must be of the same type (web, mail, directory, and so on); the Administration Server can store a cluster for each type of Netscape/iPlanet server.

Clusters enable you to have a central administration server for administering all your Netscape/iPlanet servers. The servers can be installed on any system in a network, but the administration server containing the clusters must have access to the administration server for each of the servers in the cluster.

The Cluster Management tab contains the following pages:


The Cluster Control Page
The Cluster Control page allows you to configure the remote servers. Most Netscape/iPlanet servers let you start, stop, or restart the server by clicking the corresponding buttons on the page.

For more information, see the following sections:

The following elements are displayed:

Product selector. Specifies the type of server cluster you want to configure. All servers of that type appear listed by their unique server identifier. For example, if you select Web Server, Enterprise Edition, a list of all iPlanet Web Server, Enterprise Edition instances appear on the page. The cluster page changes to display fields that apply to that server type.

Check servers to control. Allows you the select any of the listed servers, change the information for all servers in the cluster, or unselect any servers you have chosen in the page.

Status. Displays whether the server is running or has stopped.

Start, stop, restart. Starts, stops, or restarts the remote servers.

View access, view error. Displays the specified number of lines from either the server's current access log or the error log.

Transfer. Transfers information in the selected configuration file from the selected server.

Status. Displays whether the server is running or has stopped.

Help. Displays online help.


The Add Remote Servers to Cluster Database Page
The Add Remote Servers to Cluster Database page allows you to add multiple remote servers to your cluster. If the administration server you're adding contains more than one server, all the servers that it manages are added to the cluster (you can remove the individual servers later). If the remote administration server contains a cluster, the servers in the remote cluster are not added.

For more information, see Adding a Server to the Server List.

The following elements are displayed:

Admin Server Protocol. Specifies the protocol used when contacting the remote administration server. Choose http for normal administration servers. Choose https if the remote administration server is running under SSL.

Admin Server Hostname. Specifies the host name of the remote administration server. If your DNS cannot resolve host names, enter the fully qualified host and domain name (for example, type www.mozilla.com).

Admin Server Port. Specifies the port number of the remote administration server.

The master administration server attempts to contact the remote server. When it succeeds, the server identifiers appear on the page for every server installed on the remote administration server. If you have two or more servers on different systems that use the same identifier, the page shows the server identifier and the hostname for the system. If both server identifier and hostnames are the same, the page displays the port number. If you do not want all the servers in the cluster, you can remove individual servers.

OK. Saves your entries.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Modify Server Settings in Cluster Database Page
If you change an administration server's host name, port number, or protocol used (http or https), you also need to modify the information about that administration server that is stored in the cluster. The Modify Server Settings in Cluster Database page allows you to add or edit the servers in a cluster.

For more information, see Modifying Cluster Information.

The following elements are displayed:

Product Selector. Specifies the type of server you want to change. All servers of that type appear listed by their unique server identifier.

Check Servers To Be Modified. Allows you the select any of the listed servers, change the information for all servers in the cluster, or unselect any servers you have chosen in the page.

Admin Server Protocol. Specifies the protocol used when contacting the remote administration server. Choose http for normal administration servers. Choose https if the remote administration server is running under SSL.

Admin Server Hostname. Specifies the host name of the remote administration server. If your DNS cannot resolve host names, enter the fully qualified host and domain name (for example, type www.mozilla.com).

Admin Server Port. Specifies the port number of the remote administration server.

OK. Saves your entries.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Remove Servers from Cluster Database Page
The Remove Server page allows you to remove a server from a cluster. You can still access the removed servers using their administration server, but you cannot access them from the cluster.

For more information, see Removing Servers from a Cluster.

The following elements are displayed:

Product Selector. Specifies the type of server you want to delete. All servers of that type appear listed by their unique server identifier.

Check Servers To Be Removed. Allows you the select any of the listed servers, change the information for all servers in the cluster, or unselect any servers you have chosen in the page.

OK. Saves your entries.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


Server Manager
The Server Manager allows you to manage an iPlanet Web Server instance. To access the Server Manager, complete the following steps:

  1. Click the Servers tab in the Administration Server.
  2. Click Manage Servers. The Manage Servers page appears.
  3. Select the iPlanet Web Server instance you want to manage, and click Manage. The Server Manager page appears.
To access the Server Manager directly without going through iPlanet Web Administration Server, type the following URL from a browser:

The Server Manager contains the following tabs:


The Preferences Tab (Server Manager)
The Preferences tab allows you to configure server preferences, control file access on your web site, and enable Secure Sockets Layer (SSL) to ensure privacy when communicating with other SSL-enabled products. The Preferences Tab contains the following pages:


The Server On/Off Page
The Server On/Off page displays the current status of the server and allows you to start or stop the server.

For more information, see Starting and Stopping the Server.

The following elements are displayed:

Server On. Starts the server so that all listening ports are waiting for client connections.

Server Off. Shuts the server down and stops all running processes. After you shut down the server, it may take a few seconds for the server to complete its shut-down process and for the status to change to off.

About This Server. Displays server version and third-party software information in the Version Information page.

Help. Displays online help.


The View Server Settings Page
The View Server Settings page allows you to configure the technical and content settings in the magnus.conf and obj.conf configuration files. Click any link to change the setting.

For more information, see Viewing Server Settings.

The following elements are displayed:

Server Root. Specifies the path in which the server's binaries are stored.

Hostname. Specifies the fully qualified host name of this server (for example, www.mozilla.com).

Port. Specifies the port number servicing HTTP requests when no specific port number is specified. The default is port 80.

Error Log. Specifies the location of the error log. The error log captures all the requests which resulted in an error.

User (Unix/Linux). Specifies the user name under which the server runs. The server user should have restricted access to your system resources. You can often use a user named nobody in this situation. On some systems, however, nobody is not a valid user name. You may not want to give the user nobody group access to all files. If you do not use nobody, create a new Unix/Linux user, such as adm, to be the server user.

MTA Host. Specifies the name of the mail server that this server uses to send mail.

DNS. Allows you to enable the server to do a reverse lookup of a client's IP in the DNS database before executing a CGI script. Servlets also depend on this flag to do reverse lookup.

Note. DNS lookups can slow performance, especially on a server that uses extensive CGI. By default, DNS lookups are not allowed, and hosts are identified by IP address in the CGI environment and in log files.

Security. Specifies whether SSL is running on this server.

NSAPI Library. Displays the absolute path to the NSAPI library.

NSAPI Functions. Displays the NSAPI functions called in the obj.conf file.

Additional Document Directory. Lists the additional directory path to the location of the server's web documents.

NSAPI. Displays the names and arguments of the server's NSAPIs.

Primary Document Directory. Specifies the root directory for documents. You need to change this value only if you change the root directory for documents in the Content Management page.

Restrict Access. Specifies whether access control lists (ACLs) are enabled. ACLs allow you to protect files or directories by implementing access control by user name, password, domain name, or IP address.

Index Filenames. Specifies the names of the file that the browser displays when no file name is specified in a URL. The file names are listed in order of preference.

Default MIME Type. Specifies the MIME type used if a file extension does not match any of the MIME types specified in mime.types file.

Directory Indexing. Specifies the default method for displaying the contents of a directory when there is no file matching one of the default file names. Choose a value from the drop-down list:

Access Log. Specifies the path to the server access log. The access log captures all incoming requests to a server.

For the Style. Specifies information regarding the style, such as whether ACLs are enabled, the location of the NSAPI library, and so on.

Help. Displays online help.


The Restore Configuration Page
The Restore Configuration page allows you to view a backup copy of your configuration files and revert to the configuration data saved on a specific date.

Note. On Windows NT, use this page only to roll back your own changes to the configuration files. Do not roll back to backup versions created during installation; they may not be complete.

The following elements are displayed:

Set number of sets of backups. Specifies the number of sets of backups. Click Change to apply the change.

In the following table, click Restore to revert to the version saved on the specified date, or click View to preview the settings before choosing to revert. Click a date button to restore all working files to what they were on the selected date. You can restore the following configuration files:

Help. Displays online help.

https-server_name.acl. Contains the server access control lists.

magnus.conf. Contains global settings that the server uses for initialization.

obj.conf. Defines specific steps that the server takes to process instructions. In this file, you can specify path translations, and define how things such as cgi and servlet programs are handled.

mime.types. Specifies the path to the file containing the mapping of MIME types returned by the server.

jvml2.conf. Contains the configuration for the Java virtual machine (JVM).

servlets.properties. Contains the name of each servlet and its initialization parameters.

rules.properties. Contains virtual paths for servlets.

webpub.conf. Contains the system settings and file paths. In your server's obj.conf file, the search system initialization is mapped to the webpub.conf file. When you use the Search Configuration and Search Pattern Files pages, the data you input is reflected in the webpub.conf file.


The Performance Tuning Page
The Performance Tuning page allows you to configure the server to optimize its performance.

For more information, see Configuring the Server for Performance.

The following elements are displayed:

Maximum Simultaneous Requests. Specifies an upper limit on the number of simultaneous requests accepted by the server. When a new request arrives, the server checks to see if it is already processing the maximum number of requests. If it has reached the limit, it defers processing new requests until the number of active requests drops below the maximum amount. Default is 512.

DNS Enabled. Allows you to enable the server to do a reverse lookup of a client's IP in the DNS database before executing a CGI script. Servlets also depend on this flag to do reverse lookup. DNS lookups can slow performance, especially on a server that uses extensive CGI. By default, DNS lookups are not allowed. Instead, hosts are identified by IP address in the CGI environment and in log files.

Async DNS Enabled. Specifies whether asynchronous DNS is enabled. DNS causes multiple threads to be serialized when you use DNS services. If you do not want serialization, enable asynchronous DNS. You can enable it only if you have also enabled DNS. Enabling asynchronous DNS can improve your system's performance if you are using DNS.

DNS Cache Enabled. Determines whether to cache DNS entries. If you enable the DNS cache, the server can store hostname information after receiving it. If the server needs information about the client in the future, the information is cached and available without further querying. Caching DNS entries may slow down the server.

Size of DNS cache. Specifies the size of the DNS cache if you have enabled DNS. The DNS cache can contain 32 to 32768 entries; the default value is 1024 entries.

Expire entries (sec). Specifies the number of seconds to allow before DNS entries are deleted from the cache if you have enabled DNS. Cache entry expiration time can range from 1 second to 1 year (specified in seconds); the default value is 1200 seconds (20 minutes).

Listen Queue Size. Determines the size of the socket-level parameter that specifies the number of incoming connections the system will accept for that socket. If you manage a heavily used web site, make sure your system's listen-queue size is large enough to accommodate the listen-queue size setting from iPlanet Web Server. Setting the listen-queue size too high can degrade server performance. The listen-queue size was designed to prevent the server from becoming overloaded with connections it cannot handle. If your server is overloaded and you increase the listen-queue size, the server will only fall further behind.

The default setting is 128 (for Unix/Linux) or 100 (for Windows NT) incoming connections.

HTTP Persistent Connection Timeout. Specifies the number of seconds the server will allow a client connection to remain open with no activity. A web client may keep a connection to the server open so that multiple requests to one server can be serviced by one network connection. Since a given server can handle a finite number of open connections (limited by active threads), a high number of open connections will prevent new clients from connecting. Setting the timeout to a lower value, however, may prevent the transfer of large files as timeout does not refer to the time that the connection has been idle. For example, if you are using a 2400 baud modem, and the request timeout is set to 180 seconds, then the maximum file size that can be transferred before the connection is closed is 432000 bits (2400 multiplied by 180).

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Native Thread Pool Page (NT)
The Native Thread Pool page allows you to configure your native thread pool (NativePool). By default, the server has at least one thread pool, the native thread pool. This thread pool is the default thread pool for external plugins, unless specified otherwise. It uses fibers (user-scheduled threads) for internal request processing.

Minimum Threads. Determines the minimum number of threads in the native thread pool. If unspecified, defaults to 1.

Maximum Threads. Determines the maximum number of threads in the native thread pool. If unspecified, defaults to 128. If you specify 1, you emulate single-threaded behavior.

Queue Size. Determines the number of threads that can wait in the queue for the thread pool. If all threads in the pool are busy, the next request-handling thread that tries to get in the queue is rejected, with the result that it returns a busy response to the client. It is then free to handle another incoming request instead of being tied up waiting in the queue. If unspecified, defaults to an unlimited size.

Stack Size (bytes). Determines the stack size of each thread in the native thread pool. The minimum value you can enter is 65536. Entering 0 specifies the default stack size for the operating system.

OK. Saves your entries. You must click Save and Apply for your changes to take effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Generic Thread Pools Page (NT)
If you are accessing this page from Unix/Linux, see The Thread Pools Page (Unix/Linux).

The Generic Thread Pools Page allows you to add thread pools in addition to the native thread pool. Use these pools for a variety of purposes such as limiting a certain service to a specific number of concurrent threads.

Name of Pool. Specifies the thread pool you are adding.

Minimum Threads. Determines the minimum number of threads in the thread pool.

Maximum Threads. Determines the maximum number of threads in the thread pool. If you specify 1, you emulate single-threaded behavior.

Queue Size. Determines the number of threads that can wait in the queue for the thread pool. If all threads in the pool are busy, the next request-handling thread that tries to get in the queue is rejected, with the result that it returns a busy response to the client. It is then free to handle another incoming request instead of being tied up waiting in the queue.

Stack Size (bytes). Determines the stack size of each thread in the thread pool. The minimum value you can enter is 65536. Entering 0 specifies the default stack size for the operating system.

OK. Saves your entries. You must click Save and Apply for your changes to take effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Current Thread Pools. Lists the current thread pools. To modify a thread pool, click Edit in the thread pool row. To delete a thread pool, click Remove in the thread pool row.


The Thread Pools Page (Unix/Linux)
The Thread Pools Page allows you to add thread pools. Use these pools for a variety of purposes such as limiting a certain service to a specific number of concurrent threads. To change thread pool settings once you've added the pool, edit obj.conf.

Name of Pool. Specifies the thread pool you are adding.

Minimum Threads. Determines the minimum number of threads in the pool.

Maximum Threads. Determines the maximum number of threads in the pool. If you specify 1, you emulate single-threaded behavior.

Queue Size. Determines the number of threads that can wait in the queue for the thread pool. If all threads in the pool are busy, the next request-handling thread that tries to get in the queue is rejected, with the result that it returns a busy response to the client. It is then free to handle another incoming request instead of being tied up waiting in the queue.

Stack Size (bytes). Determines the stack size of each thread in the pool. The minimum value you can enter is 65536. Entering 0 specifies the default stack size for the operating system.

OK. Saves your entries. You must click Save and Apply for your changes to take effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Current Thread Pools. Lists the current thread pools. To modify a thread pool, click Edit in the thread pool row. To delete a thread pool, click Remove in the thread pool row.


The Global MIME Types Page
MIME (Multi-purpose Internet Mail Extension) types control what types of multimedia files your mail system supports. MIME types also specify what file extensions belong to certain server file types, for example to designate what files are CGI programs. For more information on using file extensions with programs, see Installing CGI Programs.The Global MIME Types page allows you to map a file extension with a file type.

For more information, see Specifying a Default MIME Type.

The following elements are displayed:

New Type. Adds a new MIME type. Fill in the following fields:

Category. Specifies the category of the MIME type. Choose from the following options:

Content-Type. Specifies the nature of the file. For example, the file could be text, video, and so forth. The receiving client (such as Netscape Navigator) uses the header string to determine how to handle the file, (for example, by starting a separate application or using a plug-in application).

File Suffix. Specifies all the file suffixes that will be associated with the content type. To specify more than one extension, separate the entries with a comma. File extensions must be unique; do not map one file extension to two MIME types.

Edit. Allows you to edit the category, content type, or file suffix of the MIME type.

Remove. Removes a MIME type.

Note. Do not put spaces between the file suffixes when you are adding or editing a MIME type. If you put a space between them, you may receive an error or your server may not restart. If this happens, edit your mime.types file to delete the space. The mime.types file is in your server root in the https-identifier/config directory. After you have edited the file, from the Server Manager, click Apply in the top right corner to apply your manual changes.

Help. Displays online help.


The Network Settings Page
The Network Settings page allows you to configure the server's network setting.

For more information, see Configuring Network Settings.

The following elements are displayed:

Server Location (Unix/Linux). Displays the absolute path where the server's scripts, icons, and configuration files are stored.

Server User (Unix/Linux). Specifies the user name under which the server runs. The server user should have restricted access to your system resources. You can often use a user named nobody in this situation. On some systems, however, nobody is not a valid user name. You may not want to give the user nobody group access to all files. If you do not use nobody, create a new Unix/Linux user, such as adm, to be the server user.

For Windows NT, you use the Services item in the control panel to change the server user. You can make the server a system account.

Server Name. Specifies the fully qualified host name of this server (for example, www.mozilla.com).

Server Port. Specifies the TCP port number to which the server listens to requests. The port number can be any port from 1 to 65535.

Bind To Address. Specifies the IP address of the server.

MTA Host. Specifies the name of the mail server that this server uses to send mail.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Custom Error Responses Page
A custom error response sends a detailed message to clients when they encounter errors from your server. The Custom Error Responses page allows you to specify a file to send or a CGI program to run for each HTTP code.

For more information, see Customizing Error Responses.

The following elements are displayed:

Editing. Specifies a resource for which you want to customize error responses. If you choose a directory, the customized error responses apply only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse the file system and choose a portion of the server.

Wildcard. Specifies a wildcard pattern to edit. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Error Code. Displays the following error codes which you can customize:

File. Specifies the files that contain your customized error messages.

Note. To remove a customization for an error code, delete the filename from the File field.

CGI. Specifies that the file that you specified is a CGI script, and specifies the absolute path to the file or CGI script that you want to return for that error code.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Dynamic Configuration Files Page
Server content is seldom managed entirely by one person. You may need to allow end users to access a subset of configuration options so that they can configure what they need to, without giving them access to iPlanet Web Server. The subset of configuration options are stored in dynamic configuration files. Two types of dynamic configuration files are supported by iPlanet Web Server: .htaccess and .nsconfig. The Dynamic Configuration Files page allows you to specify basic configuration for dynamic configuration files.

For more information, see Working with Dynamic Configuration Files.

The following elements are displayed:

Editing. Specifies a resource for which you want to customize error responses. If you choose a directory, the customized error responses apply only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse the files in your server.

Wildcard. Specifies a wildcard pattern to edit. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Status message: Dynamic Configuration Is/Is Not Enabled for This Resource. Specifies whether dynamic configuration is enabled. You can enable .nsconfig files in iPlanet Web Server, but you have to manually enable .htaccess files.

Base Directory from URL. Specifies the location where the server starts its search for configuration files from the document root.

Base Directory. Specifies the location where the server starts its search for configuration files from the file system directory.

File Name. Specifies the name of the configuration file to search for within the base directory.

Search. Searches for the file name in either subdirectories or in the base directory.

Disabled Types. Specifies the file types to disable in the directories where dynamic configuration is enabled.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Limit Symbolic Links Page (Unix/Linux)
The Limit Symbolic Links page allows you to limit the use of the file system links in your server. File system links are references to files stored in other directories or file systems. The reference makes the remote file as accessible as if it were in the current directory.

For more information, see Restricting Symbolic Links (Unix/Linux).

The following elements are displayed:

Editing. Specifies a resource for which you want to configure symbolic links. If you choose a directory, the symbolic links will apply only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse the file system and choose a portion of the server.

Wildcard. Specifies a wildcard pattern to edit. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Allow soft file system links. Specifies whether to allow soft file system links. A symbolic link consists of two files, an original file that contains the data, and another that points to the original file. Symbolic links are more flexible than hard links. Symbolic links can be used across different file systems and can be linked to directories.

Allow hard file system links. Specifies whether to allow hard file system links. A hard link is really two file names that point to the same set of data blocks; the original file and the link are identical. For this reason, hard links cannot be on different file systems.

From Directory. Specifies the path where the server should start looking for file system links. If you enter an absolute path, the server treats the path you give as a prefix. When it recognizes that prefix in a request, the server checks any directories following the prefix for file system links. If you type a partial path, the server looks for the partial path you give as a sub-string of the incoming request. If you enter nolinks, the server looks for a directory called nolinks in the incoming request; if it finds that directory, it checks all following directories for file system links.

OK. Saves your entries. You must click Apply in the upper right portion of the page in order for your changes to take effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Access Control List Management Page
The Access Control List page allows you to create and manage access control lists (ACLs). ACLs allow you to control which clients can access your server. ACLs can screen out certain users, groups, or hosts to either allow or deny access to part of your server, and set up authentication so that only valid users and groups can access part of the server.

For more information, see the following sections:

The following elements are displayed:

Pick a Resource
Displays all the resources in the server's document root that use ACLs to restrict access. An ACL can be any uniform resource identifier (URI). The URI in the ACLs list may be a directory, file name, or an alias to a resource such as a CGI script or servlet.

Editing. Specifies a resource to manage.

Browse. Specifies only a portion of the server.

Wildcard. Specifies a wildcard pattern to edit. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Edit Access Control. Edits the access control list for the selected resource.

Pick an Existing ACL
Specifies an ACL from the list of all the ACLs enabled for the server. Even if an ACL exists, if you have not enabled it, it will not appear in this list.

Editing. Specifies a resource to manage.

Edit Access Control. Edits the selected access control list.

Note. Do not delete all the ACL rules from the ACL files. At least one ACL file is required to start the server, and the ACL file must have at least one ACL rule.If you delete all the ACL rules in the ACL files, and try to restart the server, you will see a syntax error.

Type in the ACL Name
Creates an ACL. Use this option only if you're familiar with ACL files and the obj.conf configuration file—you'll need to manually edit obj.conf if you want to apply named ACLs to resources.

Editing. Specifies a resource to manage.

Edit Access Control. Edits the selected access control list.

Help. Displays online help.


The Edit Access Control Page
If you are accessing this page from the Administration Server, see The Edit Access Control Page (Administration Server) in the Administration Server section.

The Edit Access Control page is divided into two frames that set the access control rules. If the resource you chose already has access control, the rules will appear in the top frame.

For more information, see Restricting Access to Your Web Site and ACL File Syntax.

Upper Frame
The upper frame displays access control rules representing each configurable setting as a link. When you click on a link, the page divides into two frames, and you can use the Lower Frame to set the access control rules. The following elements are displayed in the upper frame:

Action. specifies whether to deny or allow access to the users, groups, or hosts.

Users/Groups. Allows you to specify user and group authentication when you click "anyone." The bottom frame allows you to configure User-Group authentication. By default, no users or groups outside of the group admin can access Administration Server resources. For more information, see Specifying Users and Groups.

From Host. Allows you to specify the computers you want to include in the rule when you click "anyplace". In the bottom frame, you can enter wildcard patterns of host names or IP addresses to allow or deny. For more information, see Specifying Host Names and IP Addresses.

Rights. Allows you to specify access rights to files and directories on your web site. In addition to allowing or denying all access rights, you can specify a rule that allows or denies partial access rights. For example, you can give people read-only access rights to your files, so they can view the information but not change the files. This is particularly useful when you use the web publishing feature to publish documents.

Extra. Allows you to specify a customized ACL entry. This is useful if you use the access control API to customize ACLs. For more information, see Writing Customized Expressions.

Continue. Specifies that the next line in the access control rule chain is evaluated before the server determines if the user is allowed access. When creating multiple lines in an access control entry, it's best to work from the most general restrictions to the most specific ones.

Trash Can Icon. Deletes the corresponding line from the access control rules.

Access Control Is On. Specifies whether access control is enabled.

New Line. Adds a default ACL rule to the bottom row of the table. You can use the up and down arrows in the left column to move the rule.

Response when Denied. Specifies the response a user sees when denied access. You can vary the message for each access control object. By default, the user is sent a message saying that the file was not found (the HTTP error code 404 Not Found is also sent).

Submit. Saves your entries.

Revert. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays the online help.

Lower Frame
The lower frame allows you to configure access control rules for the ACL in the Upper Frame. The following elements are displayed in the lower frame:

Allow/Deny

Allow. Allows the user, group, or host access.

Deny. Denies the user, group, or host access.

Update. Saves your entries.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays the online help.

User/Group

Anyone (No Authentication). Allows everyone access to the resource. No authentication is required.

Authenticated people only. Allows only authenticated users and groups to access the resource. Choose from the following options:

Prompt for Authentication. Allows you specify message text that appears in the authentication dialog box. You can use this text to describe what the user needs to enter. Depending on the operating system, the user will see about the first 40 characters of the prompt. Netscape Navigator and Netscape Communicator cache the username and password and associate them with the prompt text. This means that if the user accesses areas (files and directories) of the server that have the same prompt, the user will not have to retype usernames and passwords. Conversely, if you want to force users to reauthenticate for various areas, you must change the prompt for the ACL on that resource.

Authentication Methods.. Specifies the method the server uses when getting authentication information from the client.

Authentication Database. Lets you select a database that the server uses to authenticate users. The default setting means the server looks for users and groups in an LDAP directory. However, you can configure individual ACLs to use different databases. You can specify different databases and LDAP directories in the file server_root/userdb/dbswitch.conf. Then, you can choose the database you want to use in the ACL by selecting it in the drop-down list. If you use the access control API to use a custom database (for example, to use an Oracle or Informix database), you can type the name of the database in the "Other" field in the User/Group window.

Update. Saves your entries.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays the online help.

From Host

Any place. Allows any machine access to the resource.

Only from. Allows only the specified host names or IP address access to the resource. You specify this restriction by using wildcard patterns that match the machines' host names or IP addresses. For example, to allow or deny all computers in a specific domain, you would enter a wildcard pattern that matches all hosts from that domain, such as *.iplanet.com.

Update. Saves your entries.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays the online help.

Rights

All Access Rights. Allows the user, group, or host all access rights: read, write, execute, delete, list, and info.

Only the Following Rights. Allows the user, group, or host only the selected access rights. Choose from the following:

Update. Saves your entries.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays the online help.

Customized Expressions

Customize Expressions. Allows you to enter custom expressions for an ACL in the text box. You can use this feature if you are familiar with the syntax and structure of ACL files. For more information on customized expressions, see Writing Customized Expressions, and ACL File Syntax.

Update. Saves your entries.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays the online help.

Access Deny Response

Respond with the Default File (Redirection Off). Displays the HTTP error code 404 Not Found error when the file being requested is not found.

Respond with the Following URL: (Redirection On). Specifies a URL or the absolute path to a text or HTML file in your server's document root that you want to send to users when they are denied access. Be sure the server has read access to this file on your system—it's a good idea to have the file in a directory under the server root.


The Encryption On/Off Page (Server Manager)
If you are accessing this page from the Administration Server, see The Encryption On/Off Page (Admin) in the Administration Server section.

The Encryption On/Off page allows you to activate or deactivate SSL for the server.

For more information, see the following sections:

The following elements are displayed:

Encryption. Specifies whether encryption is activated for the server.

Port Number. Specifies the port number that the server runs on. Port numbers can be any number from 1 to 65535; however, the standard secure server port is 443.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Encryption Preferences Page (Server Manager)
If you are accessing this page from the Administration Server, see The Encryption Preferences Page (Admin) in the Administration Server section.

The Encryption Preferences page allows you to set encryption preferences for your server if SSL is activated. You can specify SSL version, whether your server will require client certificates, and which ciphers your server is able to use.

The following elements are displayed:

Allow. Specifies which SSL versions the server allows. Choose one or both of the following:

Require Client Certificates (Regardless of Access Control). Specifies whether the server should refuse any client who does not have a client certificate from a trusted CA.

SSL 2.0 Ciphers. Specifies which algorithms for the 2.0 version of SSL to use in encryption.

SSL 3.0 Ciphers. Specifies which algorithms for the 3.0 version of SSL to use in encryption.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Enforce Strong Security Requirements Page
The Enforce Strong Security Requirements page allows you to enforce stronger security requirements.

In the domestic version, the Stronger Ciphers option presents a choice of 168, 128, or 56-bit secret keysize restriction, or no restriction. In the export version, this option presents a choice of 56-bit secret keysize or no restriction. For both versions, a filename to be served when the restriction is not met can be specified. If no filename is specified, iPlanet Web Server returns a "Forbidden" status.

If you select a restriction that is not consistent with the current cipher settings under Security Preferences, iPlanet Web Server displays a popup dialog that warns that you need to enable ciphers with larger secret keysizes.

For more information, see the following sections:

The following elements are displayed:

Editing. Specifies the resource for which you want to require the secret key size.

Browse. Allows you to browse your file system.

Wildcard. Specifies a wildcard pattern. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Require 168 Bit or Larger Secret Key Size for Access. Specifies that the client must have a minimum of 168 bits in the secret key in order to successfully gain access to the server. This option is available only in the domestic version of iPlanet Web Server.

Require 128 Bit or Larger Secret Key Size for Access. Specifies that the client must have a minimum of 128 bits in the secret key in order to successfully gain access to the server. This option is available only in the domestic version of iPlanet Web Server.

Require 56 Bit or Larger Secret Key Size for Access. Specifies that the client must have a minimum of 58 bits in the secret key in order to successfully gain access to the server.

No Restrictions on Secret Key Size. Specifies that there are no minimum requirements on the secret key size.

Reject Access with File. Specifies a path to the file that will be served when the secret key size restriction is not met. If no file is specified, the server returns a "Forbidden" error.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Programs Tab
The Programs tab allows you to run server-side applications. The Programs tab contains the following pages:


The CGI Directory Page
The CGI Directory page allows you to specify the directory where CGI programs will be stored.

For more information, see Installing CGI Programs.

The following elements are displayed:

URL Prefix. Specifies the URL prefix for the CGI directory. The text you type in this field appears as the directory for the CGI programs in URLs.

For example, if you type cgi-bin as the URL prefix, then all URLs to these CGI programs have the following structure:

Note. The URL prefix you specify can be different from the real CGI directory you specify in the CGI directory field.

CGI Directory. Specifies the absolute path of the CGI directory. This this directory does not have to be under your document root.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Current CGI Directories. Lists all CGI directories currently defined for the server. To modify a CGI directory, click Edit in the directory row. To delete a CGI directory, click Remove in the directory row.


The CGI as a File Type Page
The CGI as a File Type page allows you to associate a file extension with the shell CGI feature. This is different from creating an association in Windows NT.

For more information, see Installing CGI Programs.

The following elements are displayed:

Editing. Specifies the resource you want to specify as a shell CGI type. If you choose a directory, all the files in that directory will be treated as a shell CGI script.

Browse. Allows you to browse your file system.

Wildcard. Specifies a wildcard pattern. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Activate CGI as a File Type. Activates CGI as a file type and associates a file extension with the shell CGI feature in the server, such as an association for files with the .pl extension. When the server gets a request for a file with that extension, the server knows to treat the file as a shell CGI file by calling the executable associated in Windows NT with that file extension. If you activated CGI, WinCGI, and shell CGI file types, you must specify a unique suffix for each type of CGI. For example, you cannot use the suffix .exe for both a CGI program and a shell CGI program.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Query Handler Page
A query handler processes text sent to it via the ISINDEX tag in an HTML file. ISINDEX is similar to a text field on a page in that it creates a text field in the HTML page that can accept typed input. Unlike the information in a page text field, however, the information in the ISINDEX field is immediately submitted when the user presses Return. When you specify your default query handler, you tell the server to which program to direct the input. For an in-depth discussion of the ISINDEX tag, see an HTML reference manual.

The Query Handler page allows you to specify a default query handler CGI program.

For more information, see Using the Query Handler.

The following elements are displayed:

Editing. Specifies a resource to edit. If you choose a directory, the query handler you specify runs only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse your file system.

Wildcard. Specifies a wildcard pattern. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Default Query Handler. Specifies the absolute path for the CGI program used as the default for the resource you chose.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The WAI Administration Page
A Web Application Interface (WAI) service is a type of plug-in that uses Common Object Request Broker Architecture (CORBA). The WAI Administration page allows you to enable WAI services, and use them on your server.

Note. WAI is being deprecated in iPlanet Web Server 4.1. "Deprecated" means that we no longer recommend that customers develop new applications to this API, and that it will remain in the product for another release before being completely removed. Although WAI can be used in 4.1, subsequent service packs, and 4.x releases, it will be removed in the next major release.

WAI is being deprecated so that iPlanet Web Server can better support the Java APIs, Servlets and JavaServer Pages. These application options offer similar functionality to WAI, but are widely accepted standards. For these reasons, it is better to develop new applications in Java, and to migrate current WAI applications to the Servlet API.

Note. The WAI Administration Page appears only if WAI is installed on your system. You must have installed Visibroker 3.3 or higher previously before installing WAI. iPlanet Web Server does not ship with Visibroker. By default, the installation process does not install WAI.

For more information, see Enabling WAI Services.

The following elements are displayed:

Enable WAI Services. Enables Internet Inter-ORB Protocol (IIOP) support in the server. You may have other (non-WAI) applications that need this support. If you need IIOP support, enable WAI services.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The WINCGI Directory Page (Windows NT)
The WINCGI Directory page allows you to create a directory that contains only Windows CGI programs.

For more information, see the following sections:

The following elements are displayed:

URL Prefix. Specifies the URL prefix you want to use for the WINCGI directory. That is, the text you type appears as the directory for the Windows CGI programs in URLs.

For example, if you type wcgi-programs as the URL prefix, then all URLs to these Windows CGI programs have the following structure:

http://yourserver.domain.com/wcgi-programs/program-name

The URL prefix can be different from the real Windows CGI directory you specify in the WINCGI Directory field.

WINCGI directory. Specifies the location of the CGI directory as an absolute path. This directory does not have to be under your document root.

Enable Script Tracing. Specifies whether your server will use script tracing. CGI parameters are passed from the server to Windows CGI programs through files, which the server normally deletes after the Windows CGI program finishes execution. If you enable script tracing, these files are retained in a /temp directory or wherever the environment variables TMP and TEMP are pointing. Also, any window that the Windows CGI program brings up is shown when script tracing is enabled.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Shell CGI Directory Page (Windows NT)
The Shell CGI Directory page allows you to create a directory in your server's document root that contains only shell CGI files.

For more information, see Installing Shell CGI Programs for Windows NT.

The following elements are displayed:

URL Prefix. Specifies the URL prefix associated with your shell CGI directory. For example, suppose you store all shell CGI files in a directory called C:/docs/programs/cgi/shell-cgi, but you want users to see the directory as http://www.yourserver.com/shell/. In this case, you would type shell as the URL prefix.

Shell CGI directory. Specifies the absolute path to the directory you created to store the shell CGI files. Make sure that any files in the shell CGI directory also have file associations set in Windows NT. The server returns an error if it attempts to run a file that has no file-extension association.

Warning. The server must have read and execute permissions to this directory. For Windows NT, the user account the server runs as (for example, LocalSystem) must have rights to read and execute programs in the shell CGI directory.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help.. Displays online help.


The Activate Server-Side JavaScript Page
The Activate Server-Side JavaScript page allows you to activate server-side JavaScript applications, and then access the application manager. You can also specify whether you want to require the Administration Server password for the Server-Side JavaScript Application Manager.

For more information, see

The following elements are displayed:

The Server-side JavaScript Application Manager is at http://server-id:port/appmgr/. Allows you to access the Application manager. This link appears only after you have activated the server-side JavaScript environment.

Activate the Server-Side JavaScript application environment. Specifies whether the server-side JavaScript application environment is activated.

JavaScript Thread Pool. Allows you to specify a thread pool for server-side JavaScript applications. For information about how to define thread pools, see The Native Thread Pool Page (NT), The Generic Thread Pools Page (NT), or The Thread Pools Page (Unix/Linux).

Require Administration Server Password for Server-Side JavaScript Application Manager. Specifies whether your server-side JavaScript Application Manager will require the Administration Server password for access.

Warning. The JavaScript Application Manager runs on the server instance (rather than on the administration server). You may want to restrict access to the Application Manager URL (You can access it directly at http://server-id:port/appmgr) and the application URI so that only you and other trusted administrators can access them. If you do not restrict access to the Application Manager, anyone can add, remove, modify, start, and stop applications on your server.


OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Information for "JavaScript" Page
For applications written in server-side JavaScript, you can perform many administrative tasks with the server-side JavaScript Application Manager. The Application Manager displays all applications currently installed on the server in a scrolling list in the left frame. You can also run the Application Manager by loading the following URL in Navigator: http://server.domain/appmgr. The Information for "JavaScript" page allows you to install a new JavaScript application, and modify any of the attributes of an installed application (for example, its default home page, path to the .web file, and type of client-object maintenance).

Warning. If your server does not use the Secure Sockets Layer (SSL), the username and password for the Application Manager are transmitted unencrypted over the network. Any intruder who intercepts this data may be able to access the Application Manager. If you use the same password for your administration server, the intruder can also control your server. For security reasons, do not use the Application Manager from outside of your firewall unless you are using SSL.

For more information, see Server-Side JavaScript Programs.

The following elements are displayed:


Applications. Lists all the JavaScript applications installed on your server in this left frame. Click the task buttons in the left frame to perform the indicated action on the selected application.

Start. Starts the application.

Stop. Stops the application.

Restart. Restarts the application.

Run. Runs the application on your server.

Debug. Runs the debugging application to debug the application.

Modify. Allows you to edit the installation parameters of the selected application.

Remove. Removes the selected application from the server.

For the selected application, the right frame displays the application name in the title of the page and the following information:

Web File Path. Displays the path of the application .web file on the server.

Default Page. Displays the default page for the application.

Initial Page. Displays the initial page for the application.

Built-in Maximum Database Connections. Displays the number of built-in database connections allowed.

External Libraries. Displays the external libraries used by the application (if any).

Client Object Maintenance. Displays the client object maintenance technique.

Status. Displays whether the application is active or stopped. Users can run only active applications. Stopped applications are not accessible.


The Modify "JavaScript" Page
The Modify "JavaScript" page allows you to modify JavaScript applications. Click Documentation for further documentation on server-side JavaScript. Click Help for instructions on using Application Manager.

For more information, see Server-Side JavaScript Programs.

The following elements are displayed:

Web File Path. Specifies the path of the application .web file on the server.

Default Page. Specifies the default page for the application.

Initial Page. Specifies the initial page for the application.

Built-in Maximum Database Connections. Specifies the default value for the maximum number of database connections that this application can have at one time using the predefined database object. (This is provided for backward compatibility with applications that use database objects; for new applications that use a dbpool object, ignore this field. See Chapter 8, "Connecting to a Database," in the Server-Side JavaScript Guide for iPlanet Web Server for how to set this parameter for a dbpool object.)

External Libraries. Specifies the external libraries used by the application (if any).

Client Object Maintenance. Specifies the client object maintenance technique. For additional information on client objects, refer to the Writing Server-Side JavaScript Applications guide on http://www.iplanet.com/docs. Choose from one of the following options:

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Cancel. Erases your changes and resets the elements in the page to the values they contained before your changes.


The Add Application Page
The Add Application page allows you to add new JavaScript applications to your server. Click Documentation for further documentation on server-side JavaScript. Click Help for instructions on using Application Manager.

For more information, see Server-Side JavaScript Programs.

The following elements are displayed:

Name. Specifies the name of the application.

Web File Path. Specifies the path of the application .web file on the server.

Default Page. Specifies the default page for the application.

Initial Page. Specifies the initial page for the application.

Built-in Maximum Database Connections. Specifies the default value for the maximum number of database connections that this application can have at one time using the predefined database object. (This is provided for backward compatibility with applications that use database objects; for new applications that use a dbpool object, ignore this field. See Chapter 8, "Connecting to a Database," in the Server-Side JavaScript Guide for iPlanet Web Server for how to set this parameter for a dbpool object.)

External Libraries. Specifies the external libraries used by the application (if any).

Client Object Maintenance. Specifies the client object maintenance technique. Choose from one of the following options:

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Cancel. Erases your changes and resets the elements in the page to the values they contained before your changes.


The Default Values When Adding Applications Page
The Default Values When Adding Application page allows you to configure the default settings for Application Manager. Click Documentation for further documentation on server-side JavaScript. Click Help for instructions on using Application Manager.

For more information, see Server-Side JavaScript Programs.

The following elements are displayed:

Web File Path. Specifies the path of the application .web file on the server.

Default Page. Specifies the default page for the application.

Initial Page. Specifies the initial page for the application.

Built-in Maximum Database Connections. Specifies the default value for the maximum number of database connections that this application can have at one time using the predefined database object. (This is provided for backward compatibility with applications that use database objects; for new applications that use a dbpool object, ignore this field. See Chapter 8, "Connecting to a Database," in the Server-Side JavaScript Guide for iPlanet Web Server for how to set this parameter for a dbpool object.)

External Libraries. Specifies the external libraries used by the application (if any).

Client Object Maintenance. Specifies the client object maintenance technique. Choose from one of the following options:

Confirm On. Specifies whether the server should display a confirmation dialog before removing, starting, stopping, or restarting the JavaScript application.

Debug Output. Specifies whether the output from the debugging application should be displayed in the same window or open new browser window.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Cancel. Erases your changes and resets the elements in the page to the values they contained before your changes.


The Servlets Tab
The Servlets tab allows you to configure the servlet engine. The Servlets tab contains the following pages:


The Enable Servlets/JSP Page
The Enable Servlets page allows you to enable and disable servlets and JavaServer Pages (JSP).

For more information, see Enabling Servlets and JSP.

The following elements are displayed:

Activate the Servlet Engine. Specifies whether the server can serve servlets. If the servlet engine is not activated, the server cannot serve servlets. Disabling the servlet engine also disables JavaServer Pages (JSP), so the next time you enable the servlet engine you must enable JSP again if desired.

Servlet Thread Pool. Allows you to specify a thread pool for servlets. For information about how to define thread pools, see The Native Thread Pool Page (NT), The Generic Thread Pools Page (NT), or The Thread Pools Page (Unix/Linux).

Enable JSP. Specifies whether iPlanet Web Server will parse and display JavaServer Pages (JSP). JSP files must have a .jsp extension. If JSP is not enabled, accessing a .jsp file generates a server error.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Servlet Directory Page
The Servlet Directory page allows you to specify the directories where servlets are located.

For more information, see Specifying Servlet Directories.

The following elements are displayed:

URL Prefix. Specifies the prefix used in URLs for accessing the servlet directory. For example, if you want the URL http://server_name/plans to map to the directory D:/netscape/server4/docs/plans then enter plans in this field.

Servlet Directory. Specifies the absolute path to the directory to be registered as a servlet directory. Servlets in this directory are invoked by URLs that use the URL prefix specified in the previous field. iPlanet Web Server treats all files in these directories as servlets.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Current Servlet Directories. Lists the current servlet directories. To modify a servlet directory, click Edit in the servlet directory row. To delete a servlet directory, click Remove in the servlet directory row.


The Legacy JSP Directory Page
The Legacy JSP Directory page allows you to specify the directories where version 0.92 JSPs are located.

The following elements are displayed:

URL Prefix. Specifies the prefix used in URLs for accessing the legacy JSP directory. For example, if you want the URL http://server_name/plans to map to the directory D:/netscape/server4/docs/plans then enter plans in this field.

Legacy JSP Directory. Specifies the absolute path to the directory to be registered as a legacy JSP directory. JSPs in this directory are invoked by URLs that use the URL prefix specified in the previous field. iPlanet Web Server treats all files in these directories having the .jsp extension as version 0.92 JSPs.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Current JSP Directories. Lists the current legacy JSP directories. To modify a JSP directory, click Edit in the legacy JSP directory row. To delete a JSP directory, click Remove in the legacy JSP directory row.


The Configure Global Attributes for Servlets Page
The General Attributes for Servlets page allows you to specify general servlet properties.

For more information, see Configuring Global Attributes.

The following elements are displayed:

Startup Servlets. Specifies the servlets that will be loaded upon starting the server. Do not include the .class extension.

Session Manager. Specifies the session manager class value.

Session Manager Args. Specifies the session manager arguments. Separate multiple name=value parameters with a comma. Input must be in the format name=value,name2=value2, and so on.

Reload Interval. Specifies the interval (in seconds) in which the servlets and JSP are reloaded. If the servlet class file changes, a servlet instance (reflecting the changes) can be reloaded. Enter an integer value between 0 and 600 inclusive.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Configure Servlet Attributes Page
The Configure Servlet Attributes page allows you to add servlets to the servlets.properties file and to specify input parameters, class path, and virtual path translation for existing servlets. You can set up virtual path translations for servlets regardless of whether they reside in registered servlet directories. When you add a servlet through this interface, the servlet is automatically added to the servlets.properties file in iPlanet Web Server's config directory.

For more information, see Configuring Servlet Attributes.

The following elements are displayed:

Choose Servlet. Specifies the servlet to edit. Upon choosing the servlet from this drop-down list, the servlet's information is displayed in the lower portion of this page (Ignore this field if you are adding a new virtual path entry).

Note. To add a servlet to the servlets.properties file, fill out the following fields in the lower portion of the page.

Servlet Name. Specifies an identifier for the servlet. This identifier is used internally by iPlanet Web Server; it is not used in the URL for accessing the servlet. This identifier can be the same name or a different name than the servlet class name.

Servlet Code (class name). Specifies the name of the servlet's main class file. The .class extension is not required. Do not specify any directories in this field.

Servlet Classpath. Specifies the absolute path or URL to the classpath for the servlet. The classpath can point anywhere in the file system. The servlet classpath may contain a directory, a .jar or .zip file, or a URL to a directory (You cannot specify a URL as a classpath for a .zip or .jar file.). If the servlet classpath is not a registered servlet directory, you must provide a servlet virtual path translation (in the The Configure Servlet Virtual Path Translation Page) to make the servlet accessible to browsers.

Servlet Args. Lists optional initial arguments passed to the servlet. Input must be in the format name=value [,name=value], for example, name1=arg1, name2=arg2.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Configure Servlet Virtual Path Translation Page
The Configure Servlet Virtual Path Translation page allows you to add and edit virtual paths for your servlets. For example, you can set a virtual path for the servlet named servplan1 in the docs/products/mrktplans directory to allow users to invoke this servlet by using the URL http://server_name/plans/plan1.

You can specify virtual paths only for servlets that are listed in the servlets.properties file. (To add a servlet to this file, use the The Configure Servlet Attributes Page.)

For more information, see Configuring Servlet Virtual Path Translations.

The following elements are displayed:

Choose Virtual Path Entry. Specifies a virtual path to modify. Upon choosing the servlet from this drop-down list, the virtual path information will be displayed in the lower portion of this page (Ignore this field if you are adding a new virtual path entry).

Note. To add a virtual path, fill out the following fields in the lower portion of the page.

Virtual Path. Specifies a new virtual path to add, or an existing one to modify. If you want to add a new path, you can overwrite the text (if any) in this field. If you want to modify the virtual path, choose the path from the list in Choose Virtual Path Entry above this field.

Servlet. Specifies an identifier for the servlet, as entered in The Configure Servlet Attributes Page. You can create the servlet identifier in this field before specifying it in the The Configure Servlet Attributes Page, but you must specify it in The Configure Servlet Attributes Page before the virtual path will work.

To remove an existing translation, select the name of the virtual path in the Choose Virtual Path Entry menu, then click Remove.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Remove. Deletes the selected virtual path from the rules.properties file.


The Configure JVM Attributes Page
The Configure JVM Attributes page allows you to set parameters for the Java virtual machine (JVM).

For more information, see Configuring JVM Attributes.

The following elements are displayed:

Option. Specifies any options allowed by the vendor's JVM.

Profiler. Specifies a value for the optimizer. Enter "optimizeit" if you are using the Optimizeit! 3.0 profiler from Intuitive Systems.

OPTITDIR. Specifies the absolute path for the directory where Optimizeit! resides, for example, D:/App/IntuitiveSystems/OptimizeIt30D if you are using the Optimizeit! 3.0 profiler from Intuitive Systems.

Minimum Heap Size. Specifies the minimum heap size for the interpreter.

Maximum Heap Size. Specifies the maximum heap size for the interpreter. This setting has the same fuctionality as the command-line option -mx in Java.

Compiler. Specifies whether the Just-in-time (JIT) complier is on or off.

Classpath. Specifies the Java classpath where the classes for the servlet engine are located and any additional classpath information needed by servlets or JSP. Each path must be separated by semicolons (for example, /directory/directory:/directory/directory). For example, if a JSP uses a bean that is packaged in a JAR, add the JAR path to the classpath. You can add values to an existing classpath, but do not delete values from a classpath.

Enable Class GC. Specifies whether or not to enable class garbage collection.

Verbose Mode. Specifies whether the logging collection (if enabled) will be in verbose mode.

Enable Debug. Enables remote debugging.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Delete Version Files Page
The Delete Version Files page allows you to delete the files that contain the version number for the Java server pages class cache and session data cache. When the server detects these files during start-up, it checks the version and if the current version is lower then it is supposed to be, it deletes the current directories and creates new ones.

For more information, see Deleting Version Files.

The following elements are displayed:

Delete the SessionData Version File. Deletes the version file for the session data. When you apply this change, the version file is deleted immediately. The next time the server starts up, it deletes the session data cache and recreates the version file. The next time the server serves a JSP or servlet while using the MMapSessionManager session manager, it recreates the session data cache.

Delete the ClassCache Version File. Deletes the class cache version files for JSP. when you apply this change, the version file is deleted immediately. The next time the server starts up, it deletes the JSP class cache and recreates the version file. The next time the server serves a JSP, it recreates the class cache if necessary.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Security Tab (Server Manager)
The Server Manager Security tab contains the following pages:


The Create a Trust Database Page (Server Manager)
If you are accessing this page from the Administration Server, see The Create a Trust Database Page (Admin) in the Administration Server section.

The Create a Trust Database page allows you to create a new trust database with the default CA settings and protect it with a password. The server can have only one trust database, so you can create a trust database only if one does not already exist. The trust database is created with the default CA entries which are configured so that they are not trusted CAs for client certificates. To configure the server to trust these CAs for use with client certificates, see The Manage Server Certificates Page (Administration Server).

For more information, see Creating a Certificate Trust Database.

The following elements are displayed:

Database Password. Specifies the certificate database password.

Note. The database password is sent in plain text from the client to the Administration Server. To minimize security risks, you should run the browser used for server administration on the same machine as the Administration Server or run your administration server with SSL.

Password (again). Confirms the password specified in the Database Password field. If what you enter is different from what you entered in the Database Password field, you will be prompted to try again.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Request a Server Certificate Page (Server Manager)
If you are accessing this page from the Administration Server, see The Request a Server Certificate Page (Admin) in the Administration Server section.

The Request a Server Certificate page allows you to add or renew a server certificate.

For more information, see Requesting a Certificate.

The following elements are displayed:

New certificate. Specifies that the certificate being requested is new.

Certificate renewal. Specifies that the certificate being requested is a renewal of an existing certificate.

List of available certificate authorities. Lists the certificate authorities from which you can get server certificates.

Submit to Certificate Authority via. Specifies the manner in which to submit the certificate request. If you wish to contact the certificate authority via email, select CA Email Address and enter the email address in the field.

Select the module to use with the Certificate. Specifies one of the following:

Requestor name. Specifies the name under which the certificate will be issued.

Telephone number. Specifies the telephone number of the requestor.

Common name. Specifies the fully qualified hostname used in DNS lookups (for example, www.iplanet.com). This is the hostname in the URL that a browser uses to connect to your site. It is important that these two names are the same. Otherwise, a client is notified that the certificate name does not match the site name, which often makes uses doubt the authenticity of your certificate.

Email address. Specifies the business email address used for correspondence between you and the CA.

Organization. Specifies the official, legal name of your company, educational institution, organization, and so on. Most CAs require that you verify this information with legal documents (such as a copy of a business license).

Organizational Unit. Specifies a description of an organizational unit within your company. This field is optional.

Locality. Specifies a description of the city, principality, or country for the organization. This field is optional.

State or Province. Specifies the state or province in which the business is located.

Country. Specifies the two-character abbreviation of your country name (in ISO format). The country code for the United States is US.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Install a Server Certificate Page (Server Manager)
If you are accessing this page from the Administration Server, see The Install a Server Certificate Page (Admin) in the Administration Server section.

You can install your own certificate to present to clients, or a CA's certificate for use in a certificate chain.

When you receive a certificate from the CA, it will be encrypted with your public key so that only you can decrypt it. The server will use the key-pair file password you specify to decrypt the certificate when you install it.

Note. CAs' certificates for use in a certificate chain are installed using the same process as installing your own certificate. If your CA does not automatically send you their certificate, you should request it. However, many CAs include their certificate in the same email that contains your certificate. In this case, your server installs both certificates at the same time when you install your certificate.

The Install a Server Certificate page allows you to install a certificate for a server.

For more information, see Installing and Managing Certificates and Certificate Lists.

The following elements are displayed:

Certificate For. Specifies where the certificate will be used. Select from the following options:

Select the module to use with the Certificate. Specifies one of the following:

Certificate Name. Specifies the common name of the certificate. Enter the certificate name only if it differs from the fully qualified hostname of your server used in DNS lookups (for example, www.iplanet.com).

Message is in this file. Specifies the file that contains the CA certificate.

Message text (with headers). Contains the content of the CA certificate. If you copy and paste the text, be sure to include the headers "Begin Certificate" and "End Certificate."

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Change the Key Pair File Password Page (Server Manager)
If you are accessing this page from the Administration Server, see The Change the Key Pair File Password Page (Admin) in the Administration Server section.

The Change the Key Pair File Password page allows you to change the password used to access your trust database.

For more information, see Secure Your Key-Pair File.

The following elements are displayed:

Old Password. Specifies the current key pair password.

New Password. Specifies the new key pair password.

Password (again). Confirms the password specified in the New Password field. If what you enter in this field is different from what you entered in the New Password field, you will be prompted to try again.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Manage Server Certificates Page (Server Manager)
If you are accessing this page from the Administration Server, see The Manage Server Certificates Page (Administration Server) in the Administration Server section.

The Manage Server Certificates page displays all the installed certificates associated with the server and allows you to manage the certificates.

The following elements are displayed:

Certificate Name. Specifies the name of the certificate authority.

Type. Specifies the type of certificate.

Expires (Time in UTC). Displays the date and time that the certificate expires. Once a certificate has expired, you must renew it to use it again.

Help. Displays online help.


The Migrate a 3.x Cert Page (Server Manager)
If you are accessing this page from the Administration Server, see The Migrate a 3.x Cert Page (Admin) in the Administration Server section.

The Migrate a 3.x Cert page allows you to migrate certificates from Netscape Enterprise Server 3.x to iPlanet Web Server 4.x.

The following elements are displayed:

3.6 Server Root. Specifies the server root of Netscape Enterprise Server 3.6.

Alias. Specifies the alias mapped to the key-pair file and certificate file you associated it with in the Administration Server.

Password. Specifies the certificate key-pair password.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Status Tab
The Status Tab allows you to monitor your server's activity. The Status Tab contains the following pages:


The View Access Log Page
If you are accessing this page from the Administration Server, see The View Access Log Page in the Administration Server section.

The View Access Log page allows you to configure a customized view of the information about requests to the server and the responses from the server.

For more information, see the following sections:

The following elements are displayed:

View this logfile. Specifies which log file to display. Active log files for resources and archived log files appear in the drop-down list.

Number of entries. Specifies the number of entries to retrieve (starting with the most recent).

Only show entries with. Specifies a string or a character to filter the log entries. Case is important; the case of the string or character specified in this field must match the case of the entry in the access log. For example, if you want to see only access log entries that contain POST, type "POST."

OK. Displays the log entries in the lower section of this page.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Last number accesses to access. Displays the access log entries with the parameters specified in the upper section of this page.


The View Error Log Page
If you are accessing this page from the Administration Server, see The View Error Log Page (Administration Server) in the Administration Server section.

The View Error Log allows you to configure a customized view of the errors the server has encountered as well as the informational messages about the server, such as when the server was started and who has tried unsuccessfully to log in to the server.

For more information, see the following sections:

The following elements are displayed:

Number of errors to view. Specifies the number of entries to retrieve (starting with the most recent).

Only show entries with. Specifies a string or a character to filter the log entries. Case is important; the case of the string or character specified in this field must match the case of the entry in the error log. For example, if you want to see only those error messages that contain warning, type "warning."

OK. Displays the log entries in the lower section of this page

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Last number errors. Displays the error log entries with the parameters specified in the upper section of this page.


The Monitor Current Activity Page
If your server is running, the Monitor Current Activity page allows you to launch a program to monitor your server's current resource usage. This program will give you a feel for how many resources your server needs. If your server becomes sluggish at higher traffic levels, this will help you determine if you need to adjust your server configuration, or adjust the system's network kernel.

For more information, see Monitoring the Server Using HTTP.

Displays the percentage of, the total count for, and the bar graph for the following Category information:

Help. Displays online help.


The Archive Log Files Page
The Archive Log page allows you to automatically rotate your log files at regular intervals. When you archive log files, the server renames the current log files and then creates new log files with the original names. You can archive or delete the old log files, which are saved as the original file name followed by the date and time the file was archived. For example, access might become access.24Apr-04AM.

The Archive Log File page allows you to archive your log files immediately or specify days and times when archiving will take place.

Note. Automatic rotation can be used to rotate access log files only. You can not user the internal daemon log rotation or the cron base log rotation functions on this page to rotate the error logs. To archive the error log files, click "Archive the log files now."

For more information, see Archiving Log Files.

The following elements are displayed:

Internal daemon log rotation. Specifies whether to use iPlanet Web Server internal system daemon log settings for log rotation.

Cron based log rotation. Specifies whether to use the operating system's cron (or job scheduling) facility to schedule log archiving.

Note. Before archiving the log files, you must shut down the The NS Cron Control Page (Unix/Linux) from the Administration Server.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Log Preferences Page
If you are accessing this page from the Administration Server, see The Logging Options Page in the Administration Server section.

The Log Preferences page allows you to specify what information is recorded in your server's logs. Server log files can help you monitor your server's activity and troubleshoot problems.

For more information, see Setting Log Preferences.

The following elements are displayed:

Editing. Specifies a resource to which custom logging is applied. If you choose a directory, custom logging applies only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse your file system.

Wildcard. Specifies a wildcard pattern. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Log client accesses. Specifies whether to include client accesses in your log files.

Log File. Specifies the absolute path for the access log file. As a default, the log files are kept in the logs directory in the server root. If you specify a partial path, the server assumes the path is relative to the logs directory in the server root.

Record. Specifies whether the server should record domain names or IP addresses of the systems accessing the server in the access log.

Format. Specifies which type of log file format to use in the access log. You can select from the following:

Custom Format. Allows you to create a customized format for your access log. For more information about the parameters you should use for your custom format, see theonline documentation web site at http://www.iplanet.com/docs

Do not log client accesses from. Specifies the hostnames and the IP addresses whose accesses will not be logged.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Generate Report Page
The Generate Report page allows you to generate a report about a server's activity. Use the log analyzer to generate statistics about your server, such as a summary of activity, most commonly accessed URLs, times during the day when the server is accessed most frequently, and so on. You can also run the log analyzer from the Server Manager or the command line.

Note. Before running the log analyzer, you should archive the server logs. For more information about archiving server logs, see Archiving Log Files.

For more information, see Running the Log Analyzer.

The following elements are displayed:

Server name. Specifies the name of the server for which to generate the report.

Output type. Specifies whether the report should be output to an HTML file or to a plain text (ASCII) file.

Log File. Specifies the log file or files to generate the report from. To select more than one file, hold the Control key when clicking on the file.

Output file. Specifies the absolute path to where the report should go. If you leave this field blank, the analyzer displays the results on the screen. For large log files, you should save the results to a file because displaying the output on the screen may take a long time.

Totals. Specifies whether you want to generate totals for statistics. Choose "Do not generate totals" if you do not want to generate totals for statistics. If you choose to generate totals, specify the items from the following list for which you would like to generate totals:

General Statistics. Specifies whether to generate general statistics. Choose "Do not generate general statistics" if you do not want to generate general statistics. If you choose to generate statistics, choose from the following:

Generate Lists. Specifies whether to generate lists. Choose Do not generate any list if you do not want to generate any lists. If you choose to generate lists, specify the items from the following list for which you would like to generate lists:

Output Order. Specifies the order of the output. Prioritize the following items from 1 to 3 in the order that you would like each section to appear in the report. If you chose to not generate any of them, the section will automatically be left out.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The SNMP Configuration Page
Simple Network Management Protocol (SNMP) is a protocol used to exchange data about network activity. With SNMP, data travels between a managed device and a network management station (NMS) where administrators remotely monitor and manage the network. The SNMP Configuration page allows you to configure SNMP to monitor your server.

For more information, see Using SNMP to Monitor Servers.

The following elements are displayed:

Description. Specifies the description of the server (including operating system information).

Organization. Specifies the organization responsible for the server.

Location. Specifies the absolute path for the server.

Contact. Specifies the person responsible for the server and the person's contact information.

Enable SNMP Statistic Collection. Specifies whether the SNMP statistic collection is enabled.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The SNMP Subagent Control Page (Unix/Linux)
Every managed device contains an SNMP agent that gathers information regarding the network activity of the device. This agent is known as the subagent. Each server instance has a subagent. All subagents can communicate with the master agent. The SNMP Subagent Control page allows you to configure SNMP to monitor your Unix/Linux server.

Warning. You must enable the subagent for your server instance before you attempt to start it.

For more information, see Enabling the Subagent.

The following elements are displayed:

Start. Start the SNMP subagent for this server instance.

Stop. Stops the SNMP subagent for this server instance.

Restart. Stops and then starts the SNMP subagent for this server instance.


The Styles Tab
Configuration styles are an easy way to apply a set of options to specific files or directories that your server maintains. The Configuration Styles tab allows you to apply a set of options to specific files or directories that your server maintains. The Styles tab contains the following pages:


The Create a New Style Page
The Create a New Style page allows you to create a style.

For more information, see Creating a Configuration Style.

The following elements are displayed:

Style Name. Specifies the name of the style you are creating.

OK. Creates a new style with the specified name and displays the Edit a Style page so that you can configure the new style. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Remove a Style Page
The Remove a Style page allows you to remove a style.

For more information, see Removing a Configuration Style.

The following elements are displayed:

Remove. Specifies the name of the style to delete.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Edit a Style Page
The Edit a Style page allows you to change the parameters of a style.

For more information, see Editing a Configuration Style.

The following elements are displayed:

Style. Select a style from the drop-down list and Click Edit this style.

Edit. Click the configuration style category.

Table E.1 Configuration Style Categories
Category
Description
CGI file type
Allows you to activate CGI as a file type.
Character Set
Allows you to change the character set for a resource.
Default Query Handler
Allows you to set a default query handler for a server resource.
Document Footer
Allows you to add a document footer to a server resource.
Dynamic Configuration
Allows you to give people a subset of configuration options without giving them access to the Server Manager.
Error Responses
Allows you to customize the error responses that clients see when they encounter an error from your server.
Log preferences
Allows you to set preferences for access logs.
Restrict Access
Allows you to restrict access to the entire server or parts of it.
Server Parsed HTML
Allows you to specify whether the server parses files before they are sent to the client.
Symbolic links (Unix)
Allows you to limit the use of filesystem links in your server.


The Assign a Style Page
The Apply a Configuration Style page allows you to apply a configuration style to files or directories in your server. You can either specifically choose files and directories, or you can specify a wildcard pattern.

For more information, see Assigning a Configuration Style.

The following elements are displayed:

URL prefix wildcard. Specifies files or directories, or the wildcard pattern (for example, * gif). If you enter /* after the directory, the configuration style will be applied to all the directory's contents.

Style. Specifies the configuration style you want to apply. The None configuration style can be applied to files or directories to remove any configuration style previously applied to the resource.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The List Assignments Page
After you have created configuration styles and applied them to files or directories, you can list all the configuration styles and the files or directories to which they are applied. The List Assignments page displays all the configuration styles applied to the server resource.

For more information, see Listing Configuration Style Assignments.

The following elements are displayed:

Style Assignments. Lists all configuration style assignments

Pattern. displays files or directories, or the wildcard pattern, this style is applied to.

Style. Displays the name of the configuration style.

Edit this style. Click this link to edit or remove the configuration style assignment. Clicking this link takes you to the The Assign a Style Page. A Remove this Style link appears at the top of the page.

Help. Displays online help.


The Content Management Tab
The Content Management tab allows you to manage your server's content. The Content Management tab contains the following pages:


The Primary Document Directory Page
You use the Primary Document Directory page to change the primary document directory, which is the central directory where you store all the files you want to make available to remote clients.

For more information, see Changing the Primary Document Directory.

The following elements are displayed:

Primary directory. Specifies the absolute path of the server's primary document directory.

Note. Each server instance should have its own primary document directory. If server instances share a primary document directory, users could simultaneously modify the same document without knowing it.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Additional Document Directories Page
The Additional Document Directories page allows you to add document directories to your web server and to map URLs to document directories. You use the Additional Document Directories page to create additional document directories for the documents on your web server.

For more information, see Setting Additional Document Directories.

The following elements are displayed:

URL prefix. Specifies the URL prefix you want to map. For example, a mapped URL could be http://www.mozilla.com/marketing/index.html where marketing/ is the prefix you specify. Enter a nickname that maps the URL to the additional document directory you want to define such as the word, plans.

Map To Directory. Specifies the absolute path of the directory you want the URL prefix to map to, for example,
C:\Netscape\marketing\pubdocs\index.html.

Apply Style. Specifies a configuration style to apply to the additional directory's configuration.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Current Additional Directories. Displays all additional document directories on your server. To modify a directory's mapping, click Edit in the directory row. To delete a directory's mapping, click Remove in the directory row.


The User Document Directories Page (Unix/Linux)
The User Document Directories page allows you to configure public information directories that let all the users on your server create home pages and other documents without your intervention.

For more information, see Customizing User Public Information Directories (Unix/Linux).

The following elements are displayed:

User URL Prefix. Specifies the URL prefix for the user directory (~ is the default).

Subdirectory. Specifies the user's subdirectory (public_html is the default).

Password File. Specifies whether you want the server to use the system's password file or a user file you have created to look up users.

Apply Style. Specifies the configuration style to apply to the additional directory's configuration.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The File Manipulation Page
The File Manipulation page allows you to allow clients to upload files, delete files, create directories, remove directories, list the contents of a directory, and rename files on your server.

For more information, see Enabling Remote File Manipulation.

The following elements are displayed:

Editing. Specifies a resource to which you want to enable remote file manipulation. If you choose a directory, the remote file manipulation applies only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse your primary document directory.

Wildcard. Specifies a wildcard pattern. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Activate file manipulation commands. Determines whether remote file manipulation is enabled.

Note. When you enable remote file manipulation, you need to disable Web Publishing functions on your server. When you use Web Publishing, you need to disable remote file manipulation.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Document Preferences Page
The Document Preferences page allows you to specify the file name of your server's index, the type of indexing it will use, the server home page, the default MIME type, and whether or not your server will parse accept language headers.

For more information, see Configuring Document Preferences.

The following elements are displayed:

Index Filenames. Specifies the file your server will look for and display if a user does not specify a document name in a URL. The server assumes that this file is the index file. The default files are index.html and home.html. If you enter more than one file name in this field, the server looks for the files in the order they are listed in the field until it finds one. For example, if your index file names are index.htmland home.html, the server first searches for index.html, and if the server does not find the file, it then searches for home.html. You can specify any file as an index file for a directory by naming it one of these default names, which means you can also use a CGI program as an index if CGI is activated.

Directory Indexing. Determines what type of directory index to generate if the server cannot find one of the index file names specified in the Index Filenames field. The generated index has one of the following formats:

Warning. If your server is outside the firewall, turn off directory indexing as well as web publishing (from The Web Publishing State Page) to ensure that your directory structure, file names, and web publishing features are not accessible.

Home Page. Designates whether users will see a specified home page or an index file when they access your server. If you select Home Page, you must enter the URL of the home page in the field to the right of the radio button.

Index File. By default the server finds the index file specified in the Index Filename field and uses that for the home page.

Default MIME Type. Specifies the default MIME type the server returns if a client accesses a file with an extension that has not been set up as a MIME type on your server.

The default MIME type is usually text/plain, but you should set it to the type of file most commonly stored on your server. Some common MIME types include the following:

Parse Accept Language Header. Determines whether the server should parse accept language headers. Accept language headers are headers sent by clients using HTTP 1.1. These headers contain information describing the languages the clients accept.

For example, if you store documents in Japanese and English, you could choose to parse the accept language header. When clients that have Japanese as the accept language header contact the server, they receive the Japanese version of the page. When clients that have English as the accept language header contact the server, they receive the English version.

If you do not support multiple languages, you should not parse the accept language header.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The URL Forwarding Page
The URL Forwarding page allows you to redirect document requests to another server. Forwarding URLs or redirection is a method for the server to tell a user that a URL has changed (for example, because you have moved files to another directory or server). You can also use redirection to seamlessly send a person who requests a document on one server to a document on another server.

The following elements are displayed:

Add Another Forward

URL prefix. Specifies the URL prefix you want to redirect. For example, if the URL you want to map is http://www.iplanet.com/info/movies, you'd type /info/movies in this field. This setting forwards requests to a URL prefix, keeping the absolute path, and substituting one prefix for another. For example, if you forward
http://www.iplanet.com/info/movies to a prefix mozilla.com, the URL http://www.iplanet.com/info/movies redirects to
http://mozilla.com/info/movies.

Sometimes you may want to redirect requests for all the documents in one sub-directory to a specific URL. For example, if you had to remove a directory because it was causing too much traffic, or because the documents were no longer to be served for any reason, you could direct a request for any one the documents to a page explaining why the documents were no longer available. For example, a prefix on /info/movies could be redirected to http://www.iplanet.com/explain.html.

Forward requests to. Specifies the destination URL.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Current Forwarding
Displays all URL forwardings currently defined on your server. To modify a URL forwarding, click Edit in the URL row. To delete a URL forwarding, click Remove in the URL row.


The Hardware Virtual Servers Page
The Hardware Virtual Servers page allows you to set your server to respond to multiple IP addresses without installing multiple servers. With hardware virtual servers you map multiple IP address to multiple document roots; for example, if you have two IP addresses, you could map the first IP address to one document root and the second IP address to a second document root. The iPlanet Web Server can respond to up to 256 IP addresses.

Hardware virtual servers share the same server configuration information. For example, if you turn on encryption for one hardware virtual server, any other hardware virtual servers you create would also have encryption turned on.

For more information, see the following sections:

The following elements are displayed:

IP Address. Specifies your server's IP address that you want to map to a specific document root.

Document Root. Specifies the document root to which the IP address is to be mapped.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Current Virtual Servers. Displays all virtual servers currently defined on your server. To modify a virtual server, click Edit in the virtual server row. To delete a virtual servers, click Remove in the virtual server row.


The Software Virtual Servers Page
The Software Virtual Servers page allows you to set up your server to host several web sites without needing to have more than one IP address on it. For example, you can set up your system so that both www.mozilla.com and www.iplanet.com resolve to 192.3.4.5, then set up software virtual servers to handle both server names (for example, http://www.mozilla.com/ and http://www.iplanet.com).

The server can respond to requests differently depending upon the URL, even though the server only has one IP address. For example, one server can serve different pages for http://www.mozilla.com/ and http://www.iplanet.com.

For more information, see Setting up Software Virtual Servers.

The following elements are displayed:

Edit the default home page. Click this link to edit the document preferences for the default home page.

URL host. Specifies the name of the URL host whose custom home page you want to set up.

Home page. Specifies the path to the home page you want to use for this virtual server. If you type an absolute path, the server uses that specific document. If you type a partial path, the server interprets it as relative to your primary document directory.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

Current mappings. Displays all URL mappings currently defined on your server. To modify a URL mapping, click Edit in the URL mapping row. To delete a URL mapping, click Remove in the URL mapping row.


The International Characters Page
The International Characters page allows you to assign a character set to the documents on your server. The character set of a document is determined in part by the language in which it is written. You can override a client's default character set setting for a document, a set of documents, or a directory by selecting a resource and entering a character set for that resource.

For more information, see Changing the Character Set.

The following elements are displayed:

Editing. Specifies a resource to which you want to assign a character set. If you choose a directory, the character set applies only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse your primary document directory.

Wildcard. Specifies a wildcard pattern. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Character set. Specifies the name of the character set to be used for the specified resource.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Document Footer Page
The Document Footer page allows you to specify a document footer, which can include the last-modified time, for all the documents in a certain section of the server without using server-parsed HTML. This footer works for all files except output of CGI scripts or parsed HTML (.shtml) files. If you need your document footer to appear on CGI-script output or parsed HTML files, enter your footer text into a separate file and add a line of code or another server-side include to append that file to the page's output.

The following elements are displayed:

Editing. Specifies a resource to which you want to apply the document footer. If you choose a directory, the document footer applies only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse your primary document directory.

Wildcard. Specifies a wildcard pattern. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

For files of type. Specifies the type of files to include in the footer. The default is text/html.

Date Format. Specifies the date format.

Custom Date Format. Specifies a custom date format specified in the field to the right of the radio button.

Footer Text. Specifies the text that will appear in the footer. The maximum number of characters for a document footer is 765. If you want to include the date the document was last modified, type the string :LASTMOD:. Any entities (for example, &copy) are contracted after you save your changes.

Note. When you change the document footer for an HTML page, the last-modified date does not change.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Parse HTML Page
HTML is normally sent to the client exactly as it exists on disk without any server intervention. However, the server can search HTML files for special commands (that is, it can parse the HTML) before sending documents. If you want the server to parse these files and insert request-specific information or files into documents, you must first enable HTML parsing.

The Parse HTML page sets the server to search HTML files for special commands (that is, it can parse the HTML).

The following elements are displayed:

Editing. Specifies a resource to which the server will parse HTML. If you choose a directory, the server will parse HTML only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse your primary document directory.

Wildcard. Specifies a wildcard pattern. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Activate server-parsed HTML. Specifies whether server-parsed HTML is activated. The choices are:

Parse which files. Specifies which files the server will parse. The choices are:

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Cache Control Directives Page
Cache-control directives are a way for iPlanet Web Server to control what information is cached by a proxy server. Using cache-control directives, you override the default caching of the proxy to protect sensitive information from being cached, and perhaps retrieved later. For these directives to work, the proxy server must comply with HTTP 1.1.

The Cache Control Directives page allows you to control which information on your server can be cached by a proxy server.

For more information HTTP 1.1, see the Hypertext Transfer Protocol--HTTP/1.1 specification (RFC 2068) at:

The following elements are displayed:

Editing. Specifies a resource to which you want to set cache-control directives. If you choose a directory, the server will set cache-control directives only when the server receives a URL for that directory or any file in that directory.

Browse. Allows you to browse your primary document directory.

Wildcard. Specifies a wildcard pattern. For information on using wildcard patterns, see Wildcards Used in the Resource Picker.

Cache Control Response Directives. Specifies what type of information is cachable. The choices are as follows:

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Web Publishing Tab
The Web Publishing tab allows you to use Netscape Web Publisher to collaborate on projects by directly accessing, editing, and managing files on remote servers. End users can organize and publish their documents from their desktops with a web publishing interface. They can also use text search and revision control to manage content. When you click this tab, the following pages are available:


The Set Up Netshare Page
Netshare provides an iPlanet Web Server user with a personal home page from which they can store, share, and manage their server documents. Netshare is a convenient starting point for using iPlanet Web Server user services: Web Publisher and search. From their home pages, users can also obtain information about how they are defined in the server's user directory, such as their name, password, and telephone extension.

For more information, see Using Netshare.

The following elements are displayed:

Netshare Document Root. Specifies the path for where the Netshare parent directory and all the individual Netshare home directories are located. The drop-down list displays the absolute path for all the document root directories defined for your server.

Netshare Parent Directory. Specifies the path for the Netshare parent directory that is to contain the individual Netshare home directories. By default, this is /netshare, so when you create the default Netshare home directory for a user, it is named the /netshare/userID directory. Netshare creates any directory in the path that does not exist.

Name of Template. Specifies the absolute path to the file that contains the names of the files used in creating the Netshare home pages. The default is netshare.lst, which is located in server_root/bin/https/admin/html.

Save. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Create Netshare Page
The Create Netshare page allows you to create Netshare home directories for individual users, for specified groups, or for all users who have been marked as licensed. The last choice is particularly useful for server administrators who wish to add Netshare home directories for all existing users.

When you create a Netshare home directory for a user, the user is assigned as the owner of the directory and all its files. By default, only the owner can write to the directory although other users can read the files. Others cannot make any changes to the files unless the owner explicitly provides such access permissions.

Note. You must have already set up Netshare for your server before you can create Netshare home directories and Web Publishing must be enabled before your users can use Netshare.

For more information, see Using Netshare.

The following elements are displayed:

Create Netshare For. Specifies the type of Netshare account. You can create the following types of accounts:

Note. You can use the netshare utility (the -l option) to perform a batch update to mark all users as licensed before using this page.

User ID or Group Name. Specifies the user ID (if this account is for a single user) or the group name (if this account is for a group).

Owner (for groups only). Specifies the group owner.

Netshare home directory. Specifies the naming convention used for the home directory:

Create. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Web Publishing State Page
The Web Publishing State page allows you to enable or disable web publishing for your server. Web Publishing allows clients to collaborate on projects by directly accessing, editing, and managing files on remote servers. Web Publisher provides sophisticated features for server clients, such as file management, editing and publishing, document version control, search, agent services, access control, and link management.

Note. When you enable Web Publishing, you need to disable remote file manipulation. For more information, see Enabling Remote File Manipulation.

For more information, see Changing the Web Publishing State.

The following elements are displayed:

Web Publishing State. Specifies whether web publishing is enabled for your server.

Warning. If your server is outside the firewall, you should turn off directory indexing (from the Server Manager, choose Content Management, click Document Preferences, and set Directory Indexing to None) as well as web publishing. This ensures that your directory structure, filenames, and web publishing features are not accessible.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Choose Web Publishing Language Page
The Choose Web Publishing Language page allows you to change the web publishing language to any language supported by the user's installation.

Note. If you change the language of a collection, the system deletes all the existing data in the collection.

Your changes are reflected in the language.conf file, which is located in the server_root/plugins/search/admin directory.

After you change the web publishing language, your server is automatically restarted to apply the change.

The following elements are displayed:

Choose a Language. Specifies the language of all documents used by the web publisher.

OK. Saves your entries.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Maintain Web Publishing Data Page
The Maintain Web Publishing Data page allows you to report on, repair, and optimize web publishing data.

For more information, see Maintaining Web Publishing Data.

The following elements are displayed:

Document Directory. Specifies the absolute path of the directory that contains the web publishing data to be maintained. Click View to review the contents of the directory.

Include Subdirectories. Specifies whether the server maintains the subdirectories within the directory specified in the Document Directory drop-down.

Report. Reports on the consistency of the web publishing data of the selected document directory. The report includes information about the current logical consistency of the web publishing collection's data. It lists all the files in the selected document directory and also lists all the records in the web publishing collection, regardless of which directory the collection data corresponds to.

Repair. Repairs inconsistencies in the selected document directory.

Optimize. Optimizes the entire web publishing collection. Optimizing improves a collection's performance if you frequently add, delete, or update documents or directories in the collections. Optimization is similar to defragmenting your hard drive.

Help. Displays online help.


The Unlock File Page
The Unlock File page allows you to unlock a file that has been locked manually by the client or automatically by Netscape Enterprise Server as part of an edit or download operation. If a file that has been locked in Web Publisher is required for another user, you can unlock it.

Be cautious in using this function because by unlocking a file that was locked, you are making the file available for editing by other users. This is contrary to the intent of the lock owner, who may not know of the unlocking operation.

For more information, see Unlocking Files.

The following elements are displayed:

Choose. Specifies the file or directory that you want to unlock. Click View to review the contents of a directory.

Unlock. Unlocks the file or directory specified.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Add Custom Property Page
Collections have different sets of default properties that depend on which file format they are. For example, HTML files have Title and SourceType. You can also define META-tagged HTML attributes in your HTML files. Some file formats, such as PDF, have a great many default properties. The Add Custom Property page allows you to add property types to properties files.

For more information, see Adding Custom Properties.

The following elements are displayed:

Property Name. Specifies the property file name. This field has the following restrictions:

Checkbox. Specifies the property name used as the NAME of an HTML META-tagged attribute. If you select this check box, when files containing this attribute are indexed, the contents of the META attribute is used as the value of the property and you can search for files that contain this META-tagged property. The property must conform to the same conventions as property names.Use the attribute CONTENT as the value of this property for all files indexed subsequently.

Property Type. Redefines META-tagged attributes to dates or numeric values to obtain valid sort sequences. Because all attributes tagged with META are defined as text, sorting operations on fields containing dates or numbers do not sort in the expected date or number order.

Permissions. Specifies whether the client has permission to modify the custom properties. For modifiable custom properties defined as META-tagged attributes, the value in the document is extracted only the first time the document is indexed. Because users can input a different value in the attribute field through the Web Publisher Services Properties page, the server ignores the META-tagged value in subsequent indexing. In this way, the user's value is not overwritten.

Visible to user. Specifies whether this custom property is visible to clients in Web Publisher.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Manage Properties Page
The Manage Properties page lists all the file properties that are available for use. These include the default set plus any new custom properties you have created. You can remove or edit only those properties that you have created. These have active Remove and Edit links in the first two columns.

For more information, see Managing Properties.

The following elements are displayed:

Remove Property. Removes a custom property. The Remove Custom Property page appears.

Edit Property. edit a custom property. The Edit Custom Property page appears. You can only change the property's name, permissions, visibility and its option of whether to capture META-tagged attributes.

Note. You can remove or edit only those properties that you have created. These have active Remove and Edit links in the first two columns.

Click OK to update the property with your changes. Click Back to return to the Manage Properties page without editing the property. Click Reset to reset any property values you changed.

Property Name. Specifies the property file name.

Type. Redefines META-tagged attributes to dates or numeric values to obtain valid sort sequences. Because all attributes tagged with META are defined as text, sorting operations on fields containing dates or numbers do not sort in the expected date or number order.

Permissions. Specifies whether the client has permission to modify the custom properties. For modifiable custom properties defined as META-tagged attributes, the value in the document is extracted only the first time the document is indexed. Because users can input a different value in the attribute field through the Web Publisher Services Properties page, the server ignores the META-tagged value in subsequent indexing. In this way, the user's value is not overwritten.

Visible to user. Specifies whether this custom property is visible to clients in Web Publisher.

Use META CONTENT if Property Name is META NAME. Specifies whether the property name is used as the NAME of an HTML META-tagged attribute. The property must conform to the same conventions as property names.Use the attribute CONTENT as the value of this property for all files indexed subsequently.

Help. Displays online help.


The Index and Update Properties Page
The Index and Update Properties page allows you to perform bulk indexing of documents to create searchable web publishing data. You can also use it to do a bulk assignment of ownership for the files included in the collection. You can restrict or expand the scope of documents and directories to be indexed, and you can index just the file properties, called metadata, or you can also index the documents' contents.

For more information, see Indexing and Updating Properties.

The following elements are displayed:

Define Scope of Indexing

Document directory. Specifies the absolute path of the directory to be indexed. You can index documents in the primary document directory, an additional document directory, or in a subdirectory.

If you want to index a different directory, click the View button to see a list of directories. You can index any directory that is listed or you can view the subdirectories in a listed directory, and index one of those instead.

Include subdirectories. Specifies whether your server will index the subdirectories of the directory specified in the Document Directory drop-down.

Include files matching pattern. Specifies a wildcard expression that restricts indexing to documents that match that pattern. You can index all files in the chosen directory by leaving the default *.* pattern in the field or you can define your own wildcard expression to restrict indexing to documents that match that pattern. For example, you could enter *.html to index only the content in documents with the .html extension, or you could use this pattern (complete with parentheses) to index all HTML documents:

You can define multiple wildcards in an expression.

Index unindexed documents. Specifies whether the server will index any previously unindexed documents within the document directory. If this is the first time you index web publishing documents, you should check this check box. In subsequent indexing operations, you can uncheck it or you may leave it checked to index any new documents that have been added to the document directory.

Update previously indexed documents. Updates files that have already been indexed. This option can be used to assign a bulk ownership or to index the content of files that did not have this option set when they were first indexed. This option is useful when you change many files at once. You can use the Web Publisher client to index and update individual files.

Set Properties To

Set document owner to. Indicates to the server to do a bulk assignment of ownership to all files being indexed. The field contains the user name of the owner of the files. The server does not perform any validity checks on the user name, therefore, it is important that the name in this field is valid. This option updates the owner property in each file's collection entry.

Index document contents. Allows the server to index the document content. You can choose to index the documents' contents as well as their file metadata.

Index. Performs the specified indexing.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Search Tab
The Search tab allows you to search the contents and attributes of documents on the server. The Search tab contains the following pages:


The Search State Page
From the Search State page you can enable or disable the search capabilities for your server. If users do not use the search feature or if web traffic is heavy, turning search off will improve the server's performance.

For more information, see Turning Search On or Off.

The following elements are displayed:

Search State. Specifies whether the search function is on or off.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Create a Collection Page
The Create a Collection page allows you to create a collection that indexes the content of all or some of the files in a directory. You can create a collection that indexes the content of all or some of the files in a directory. You can define collections that contain only one kind of file or you can create a collection of documents in various formats that are automatically converted to HTML during indexing. When you define a multiple format collection (with the auto-convert option), the indexer first converts the documents into HTML and then indexes the contents of the HTML documents. The converted HTML documents are put into the html_doc directory in the server's search collections folder.

For more information, see the following sections:

The following elements are displayed:

Directory to Index. Specifies the currently defined document directory and provides a drop-down list of additional document directories. You can select any of the items in the drop-down list as a starting point for finding the directory you want to index.

If you want to index a different subdirectory, click View to see a list of resources. You can index any directory that is listed or you can view the subdirectories in a listed directory and index one of those instead. Once you click the index link for a directory, you return to the Create Collection page and the directory name appears in the Directory to Index field.

Documents Matching. Specifies the wildcard expression your server will match to restrict indexing. You can index all HTML files in the chosen directory by leaving the default *.html pattern in the "Documents matching" field or you can define your own wildcard expression to restrict indexing to documents that match that pattern.

For an example, you could use the pattern, *.html to only index the content in documents with the .html extension, or you could use either of these patterns (complete with parentheses) to index all HTML documents:

(*.htm|*.html)

or

*(.htm|.html)

You can define multiple wildcards in an expression.

Note. You cannot index a file that includes a semi-colon (;) in its name. You must rename such files before you can index them.

Include Subdirectories. specifies whether the server indexes the subdirectories within the specified directory to index.

Collection Name. Specifies the name for your collection. The collection name is used for collection maintenance. This is the physical file name for the file, so the collection name must follow the standard directory-naming conventions for your operating system.

You can use any characters up to a maximum of 128 characters. Spaces are converted to underscores.

Note. Do not use accented characters in the collection name. If you need accented characters, exclude the accents from the collection name, but use accented characters in the label. The label is what is displayed to the user from the search interface.

Collection Label. Specifies a user-defined name for your collection. This is what users see when they use the text search interface. Collection labels should be as descriptive and relevant as possible. You can use any characters except single or double quotation marks, up to a maximum of 128 characters.

Description. Specifies a description for your collection. The description can have a maximum of 1024 characters. This description appears in the collection contents page.

Collection Contains. Specifies the type of files the collection is to contain. The kind of file format you choose indicates which default attributes are used in the collection and which, if any, automatic HTML conversion of the content is done as part of indexing.

If you choose HTML as the file type and also try to index non-HTML files, the server creates the collection with the HTML set of default attributes and does not attempt to convert any non-HTML file it indexes. If you index HTML files into an ASCII collection, even the HTML markup tags are indexed as part of the file's contents and when you display the files, the contents appear as raw text. Regardless of the file type chosen, the content of the file is always indexed.

Extract Metatags. Extracts META-tagged attributes from HTML files during indexing. If you extract these attributes, you can search on their values. You can index on a maximum of 30 different user-defined META tags in a document. You can only use this option for HTML collections. Select No to tell the server not to extract META-tagged attributes from HTML files.

Documents are in. Specifies the collection's language. The default is English, labeled "English (ISO-8859-1)."

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Configure Collection Page
Once you have created a collection, you can use the Configure Collection page to configure the collection. You can modify its description, change its label, define a different URL for its documents, and define how to indicate highlighting in documents, which pattern files to use, and how to format dates.

For more information, see Configuring a Collection.

The following elements are displayed:

Choose Collection. Specifies the name of the collection that you are configuring.

Document Root. Specifies the primary document directory of the collection.

File Format. Specifies the format of the files in the collection.

Language. Specifies the language of the files in the collection.

Description. Specifies a description for your collection. The description can be up to 1024 characters.

Label. Specifies a user-defined name for your collection. This is what users see when they use the text search interface. Collection labels should be as descriptive and relevant as possible. You can use any characters except single or double quotation marks, up to a maximum of 128 characters.

URL for Documents. Specifies the new URL mapping for the collection's documents if it has changed.

That is, if you originally indexed the directory of files that corresponded to those defined by the URL mapping /publisher/help, and you have changed that mapping to the simpler /helpFiles, you would replace the URL of /publisher/help with the /helpFiles in this field.

Highlight begin. Specifies the HTML tags you want the server to use when highlighting a search query word or phrase in a document. The default is to use bold, with the <b> and </b> tags, but you can add to this or change it. For example, you could add <blink><FONT COLOR = #FF0000> and the corresponding </blink></FONT> to highlight with blinking bold red text.

You can define different default pattern files for displaying the search results: how the search result's header, footer, and list entry line are formatted, respectively. Initially, the pattern files are in the server_root\plugins\search\ui\text.

Highlight end. Specifies the HTML tags you want the server to use when highlighting a search query word or phrase in a document. The default is to use bold, with the <b> and </b> tags, but you can add to this or change it. For example, you could add <blink><FONT COLOR = #FF0000> and the corresponding </blink></FONT> to highlight with blinking bold red text.

You can define different default pattern files for displaying the search results: how the search result's header, footer, and list entry line are formatted, respectively. Initially, the pattern files are in the server_root\plugins\search\ui\text.

Input Date Format. Specifies how you want input dates to be interpreted when using this collection: MM/DD/YY, DD/MM/YY, or YY/MM/DD.

Pattern Files for Displaying the Search Results

Header Pattern File. Specifies the header pattern file used when displaying the search results. Pattern files are HTML files that define the layout of the text search interface. You can associate a pattern file with a search function and a set of pattern variables to create a specific portion of the interface. In the pattern file, you define the look, feel, and function of the text search interface. Pattern files use pattern variables that you can use to customize background color, help text, banners, and so on. In some cases, the values are paths to the files that contain the actual text and graphics that these variables represent; in other cases, the values represent text and HTML.

Footer Pattern File. Specifies the footer pattern file used when displaying the search results.

Pattern File for Displaying the Highlighted Document

Result Pattern File. Specifies the name of the pattern file you want to use when displaying a single highlighted document from the list of search results.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Update Collection Page
Once you have created a collection, you can use the Update Collection page to add or remove files from the collection.

For more information, see Updating a Collection.

The following elements are displayed:

Choose Collection. Specifies the name of the collection that you want to update.

Selected Collection. Lists the documents that have index entries in the currently selected collection. The list holds 100 records, and the Prev and Next buttons get the previous or next set of 100 files for collections that have more than 100 files in them.

Collection contains number documents. Lists all the documents in the collection.

Prev. Specifies whether the server gets the previous set of 100 documents that have index entries in the selected collection and display them in the Selected Collection text box.

Next. Specifies whether the server gets the next set of 100 documents that have index entries in the selected collection and display them in the Selected Collection text box.

Documents Matching. Specifies the file names that you want to add or remove from the selected collection. You can use either a single file name or wildcards to specify the type of files you want added to or removed from the collection. If you enter a wildcard such as *.html, only files with this extension are affected. You can indicate files within a subdirectory by typing in the path as it appears in the list of files. For example, you could delete all the HTML files in the /frenchDocs directory by typing in (no slash before the directory name): frenchDocs/*.html

Note. Be careful how you construct wildcard expressions. For example, if you type in index.html, you can add or remove the index file from the current collection. If instead you type in the expression */index.html, you can add or remove all index.html files in the collection.

Include Subdirectories. Specifies whether the server should index and add all matching documents in the subdirectories of the document directory that was originally defined for the collection. Matching documents are those documents that Yes button is selected, and the collection originally indexed the /publisher directory, this option looks for documents matching the new pattern within all the subdirectories within /publisher. This does not apply for removing documents.

Add Docs. Adds the indicated files and subdirectories to the server.

Remove Docs. Removes the indicated files from the server.

Help. Displays online help.


The Maintain Collection Page
Once you have created a collection, you can use the Maintain Collection page to optimize, reindex, or remove the collection.

For more information, see Maintaining a Collection.

The following elements are displayed:

Choose Collection. Specifies the name of the collection to be maintained.

Selected Collection. Displays what documents have index entries in the currently selected collection. Click Prev and Next to get the previous or next set of 100 files for collections that have more than 100 files in them.

Optimize. Improves a collection's performance if you frequently add, delete, or update documents or directories from it. Optimizing a collection is similar to defragmenting a hard drive. A collection is automatically optimized whenever you reindex or update it, so you should not need to do additional optimizing. You might want to optimize a collection before publishing it to another site or before putting it onto a read-only CD-ROM.

Reindex. Locates each file that already has an entry in the collection and reindexes its attributes and contents, extracting the META-tagged attributes if that option was selected when the files were originally indexed into the collection. This does not return to the original criteria for creating the collection, say *.html, and add any new documents that fit the original criteria. This option also removes collection entries when the source documents have been deleted and can no longer be found.

Remove. Removes the collection, not the original source documents.

Help. Displays online help.


The Schedule Collection Maintenance Page
You can use the Schedule Collection Maintenance page to optimize, reindex, or remove the collection at a designated time.

For more information, see Scheduling Regular Maintenance.

The following elements are displayed:

Choose Collection. Specifies the collection on which scheduled maintenance will be performed.

Choose Action. Specifies the action to perform on the selected collection at the scheduled time. You can set up separate schedules for reindexing, optimizing, and updating the same collection. You can choose one of these actions:

Schedule Time. Specifies the time of day that the scheduled maintenance will take place. The time must be in military format (HH:MM). HH must be less than 24 and MM must be less than 60. This field must contain a value for scheduled maintenance to take place.

Schedule Day(s) of the Week. Specifies day(s) on which to perform maintenance. You can select all the days, and must select at least one day.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Remove Scheduled Collection Maintenance Page
You can use the Remove Scheduled Collection Maintenance page to remove scheduled maintenance for your server. Scheduled maintenance includes optimizing, reindexing, or updating a collection at a designated time.

For more information, see Unscheduling Collection Maintenance.

The following elements are displayed:

Choose Collection. Specifies the name of the collection for which you will remove scheduled maintenance.

Choose Action. Specifies the type of schedule maintenance to be removed for the specified collection. The three types of maintenance are: Reindex, Optimize, and Update.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Search Configuration Page
The Search Configuration page allows you to set the default parameters that govern what users see when they get search results.

The following elements are displayed:

Default Result Set Size. Specifies the default maximum number of search result items displayed to users at a time. This value cannot be larger than the value for the largest possible result set size that you enter into the next field. The default value is 20.

Largest Possible Result Set Size. Specifies the maximum number of items in a result set. The default is 5000. For example, if this field contains the number 250, and there were 1000 documents that match the search criteria, users would only be able to see the first 250 or the 250 top-ranked documents (for searches that rank their results).

Date/Time string. Specifies the format of the date/time string in Posix format. This is how the search results are displayed to users in the search results page. For example, the format %b-%d-%y %H:%M produces Oct-1-97 14:24. You can use the symbols listed in Table 16.23.

Table E.2 Common Posix date and time formats
Format
Displayed result (example)
%a
Abbreviated week day (for example, Wed)
%A
Full week day (for example, Wednesday)
%b
Abbreviated month (for example, Oct)
%B
Full month (for example, October)
%c
Date and time formatted for current locale
%d
Day of the month as a decimal number (for example, 01-31)
%H
Hour as a decimal number, 24-hr military format (for example, 00-23)
%m
Month as a decimal number (for example, 01-12)
%M
Minute as a decimal number (for example, 00-59)
%x
Date
%X
Time
%y
Year without century (for example, 00-99)
%Y
Year with century (for example, 1999)

Default HTML title. Specifies a default title for the HTML document. This title is used if the document's author has not included a title as part of the document, tagged with the HTML Title tag. The typical default is (Untitled), which appears in the search results page for HTML files.

Check access permissions on collection root before doing a search. Checks access permission of a server user before performing a search on the collection chosen. If proper authorization is not entered, the requested search is not performed.

Check access permissions on search results. Checks the user's access permission before displaying the search results. If you click Yes, the server checks the user's access privileges for each file before displaying the documents found as a result of the search. Only the documents that you have permission to view are displayed. Select the No button to tell the server not to check the user's access permission before displaying the search results.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.


The Search Pattern Files Page
The Search Pattern Files page allows you to define the layout of the text search interface by configuring pattern files.

For more information, see HTML Pattern Files.

The following elements are displayed:

Pattern File Directory. Specifies the absolute path for the directory where you store your pattern files. The default start (header), end (footer), and query page pattern files are located in this directory.

Default Start Pattern File. Specifies the relative path for the default pattern file to use for the top of the search results page when a collection has no defined header file or when more than one collection is being searched. The path must be relative to the pattern file directory.

Default End Pattern File. Specifies the relative path for the default pattern file to use for the footer of the search results page when for a collection has no defined footer file or when more than one collection is being searched. Specify the path relative to the pattern file directory.

Pattern File for Query Page. Specifies the relative path for the pattern file you want to use for the search query page that appears when you start up the search function. Specify the path relative to the pattern file directory.

OK. Saves your entries. You must click Apply on the top right side of the page for your changes to take effect. If you do not click Apply after you update information, your changes are retained so that you can view and edit it, even though the changes have not taken effect.

Reset. Erases your changes and resets the elements in the page to the values they contained before your changes.

Help. Displays online help.

 

© Copyright © 2000 Sun Microsystems, Inc. Some preexisting portions Copyright © 2000 Netscape Communications Corp. All rights reserved.