Home > Articles > Operating Systems, Server > Solaris

Understanding Sun Web Server 7.0 Configuration Files

This chapter takes a closer look at each Sun Web Server 7.0 configuration file as well as the syntax, usage, and considerations for each file.
This chapter is from the book

This chapter is from the book

CHAPTER 4, “Web Server 7.0 Administration,” introduced the concept of a Web Server configuration. That chapter described that a configuration consists of various components that are used to configure the runtime services of a Web Server 7.0 instance. Included in these components are various configuration files (such as magnus.conf, server.xml, and obj.conf) that are used to specify global variables and define how the server responds to specific events and client requests.

Each Web Server configuration has its own set of files that are located beneath the config directory for the server instance. Table 5.1 provides an overview of the configuration files associated with Web Server 7.0, as well as a brief description of their purpose.

Table 5.1. Web Server 7.0 Configuration Files

Filename

Overview

cert8.db

Network Security Services (NSS) certificate database. This database stores publicly accessible objects (such as certificates, certificate revocation lists, and S/MIME records) and works with the key3.db database for certificate management. This file is part of the instance’s trust database.

certmap.conf

Certificate to LDAP DN mapping configuration.

default-web.xml

Default values for all web applications.

default.acl

Default access control list (ACL) file for the server instance. This file contains the default rules governing access within the server instance.

key3.db

NSS private key database. This database stores the private keys generated by the server and works with the cert8.db database for certificate management. This file is part of the instance’s trust database.

keyfile

File containing usernames and hashed passwords for flat file authentication.

login.conf

Information for file authentication used by the Java Authentication and Authorization Service (JAAS).

magnus.conf

Contains the Netscape server application programming interface (NSAPI) plug-in initialization directives and settings that control the way NSAPI plug-ins are run.

mime.types

Multipurpose Internet mail extension (MIME) type mapping file. This file contains a mapping of file extensions to MIME types and enables the server to determine the content type of a requested resource.

obj.conf

NSAPI request processing configuration file. This file contains the instructions that tell the Web Server how to handle various HTTP requests from clients.

secmod.db

NSS PKCS #11 module database. This database stores PKCS #11 module configuration information that is used for various cryptographic modules (for example, hardware accelerator cards).

server.policy

Policy controlling the access that applications have to resources.

server.xml

The main instance configuration file, which contains the majority of settings necessary to run the server.

Configuration files are updated when you perform administrative tasks through the Administration Console or command line interface. Additionally, you can directly edit each configuration file and modify it as appropriate.

This chapter takes a closer look at each configuration file as well as the syntax, usage, and considerations for each file. Although the configuration files in Table 5.1 appear in alphabetical order, the following sections discuss Web Server 7.0’s configuration files in order of importance.

5.1 The magnus.conf File

The magnus.conf file contains the directives necessary to initialize Netscape Server Application Programming Interface (NSAPI) plug-ins. Directives may also contain additional settings that control the way the NSAPI plug-ins are run.

The Web Server consists of functionality that enables you to perform basic request processing immediately after installation. This functionality is provided by server application functions (SAFs) that are part of the Web Server platform.

You can change the way the server responds to client requests by adding or modifying directives in the magnus.conf and obj.conf files. Each directive references a SAF that is used to perform the work during a particular stage of request processing. You can elect to add directives that call SAFs provided by Web Server 7.0, or extend the functionally of the Web Server by creating your own shared libraries (or plug-ins) through the NSAPI. Additionally, you might find it necessary to include functionality that is provided by third-party vendors or by other Sun Microsystems products.

Plug-ins must be registered with the Web Server in the magnus.conf file; this is accomplished with the Init directive. Once registered, you can use the SAFs contained within the plug-ins to customize request processing within the obj.conf.

Example 5.1 demonstrates the use of the Init directive in a customized magnus.conf file.

Example 5.1. Sample magnus.conf File

#
# Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#
Init fn="load-modules"now)"
Init fn="load-modules" shlib="libfastcgi.so"
Init fn="load-modules"
  shlib="/sun/webserver7/plugins/myplugin/myplugin.so"
  funcs="myfunc1,myfunc2"

The load-modules SAF is used to load and register a plug-in with the Web Server. This function is most often used to load third-party plug-ins into the Web Server to provide functionality that is not included in the base platform. An example of this might include a plug-in that is used to provide an interface to an application server.

This example specifies three plug-ins that are registered during the initialization process. The libj2eeplugin.so and libfastcgi.so plug-ins are included with Web Server 7.0. The myplugin.so plug-in is a user-created shared library that can be found beneath the /sun/webserver7/plugins/myplugin directory. The shlib parameter specifies the local file system path to the shared library.

The shlib_flags parameter (as seen in the first directive) specifies how a shared library will be loaded into the Web Server process. After it is started, the Web Server process uses the dlopen function to load additional library files into memory. The options of global and now shown in the first directive refer to the dlopen options of RTLD_GLOBAL and RTLD_NOW, respectively. You can read more about these and other options by using the UNIX man command as follows:

    # man dlopen

The third Init directive also demonstrates the capability to register specific functions within a particular plug-in (i.e., myfunc1 and myfunc2). The funcs parameter is not specified in the first two directives, so all functions defined within those plug-ins are available for use.

5.1.1 Syntax

Table 5.2 provides the general syntax for the magnus.conf file.

Table 5.2. magnus.conf Syntax

Syntax

Rules

Case Sensitivity

Items in the magnus.conf file are case-sensitive, including function names, parameter names, parameter values, and pathnames.

Comments

Hash symbols (#) are used to designate comments in the magnus.conf file. Any text that appears to the right of a hash symbol is ignored by the Web Server. The first four lines of Example 5.1 include comments.

Directives

Directives in the magnus.conf file either set a value or invoke a SAF. You can add directives or edit existing directives in the magnus.conf file, but be very careful when doing so. Simple mistakes can make the server fail to operate correctly.

There are three Init directives in Example 5.1. Each of these invoke the load-modules SAF to load the appropriate plug-in. The Init directives load and initialize server modules and NSAPI plug-ins. Refer to the Sun Java System Web Server 7.0 NSAPI Developer’s Guide for a complete list of directives available in the magnus.conf file.

Directive Parameters

For predefined SAFs, the number and names of parameters depend on the function. The order of parameters on the line is not important.

Path Names

Always use forward slashes (/) rather than backslashes (\) in path names, even on the Windows platform. A backslash character is used to escape the character that follows it.

Quotation Marks

Quotation marks (") are required around the value strings only when there is a space in the string; otherwise, they are optional. Each open quotation mark must be matched by a closed quotation mark.

Spacing

Directives in the magnus.conf file appear on their own line. You may continue long directives on the next line by beginning the next line with a space or tab. Spaces are not allowed before or after the equal (=) sign that separates a name and value. Spaces are not allowed at the end of a line or on a blank line. Line continuation is demonstrated for the first and third directives in Example 5.1. The second line for both of these directives begins with a space.

5.1.2 Context

An Administration Node may contain multiple configurations that have been deployed to the node by the Administration Server. These deployed configurations are called instances. Each instance can contain only one magnus.conf file; therefore, there is a one-to-one correspondence between an instance and the magnus.conf file. The directives defined within the magnus.conf file apply to the entire server instance and therefore any virtual servers defined within that instance.

5.1.3 Modifications

Some changes made through the Administration Console or the command line interface update the magnus.conf file. If this file is updated as a result of changes made through either of these two interfaces, you must deploy the updated configuration before the changes are reflected on the appropriate Administration Node(s).

The magnus.conf file is read when the instance is started; therefore, any changes made to the magnus.conf file require a server restart for the changes to take effect. The Administration Console and command line interface detect changes to the magnus.conf file during the deployment process. If you use these tools to deploy the new configuration, you are prompted to restart the instance. If you directly edit the magnus.conf file, you need to restart the sever on your own.

The magnus.conf file is validated at start-up time. Errors found within the file might prevent the server from starting or processing requests properly.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020