Set a Web server and a custom profile on the same machine

This procedure describes installing a Web server and its plug-in on a machine where the default profile is a custom profile.

When multiple profiles exist, the plug-ins installer configures only the default profile. See Plug-ins configuration for a description of the flow of logic that determines how the installer selects the profile to configure.

This procedure configures the custom profile that is the default profile on the machine. This procedure assumes that you already have installed a deployment manager on Machine A.

The WAS node on Machine B is the custom node created in this procedure. This procedure starts the dmgr and federates the custom node before installing the Web server plug-ins.

Start the dmgr. The deployment manager must be running to successfully federate and configure the custom node.

Use the following procedure to install the Web server plug-in, configure the Web server, and create a Web server definition in the default custom profile (custom node).


  1. Log on to the operating system. If installing as a non-root or non-administrative user, then there are certain limitations. See the documentation for non-root installation for more information. [AIX] [HP-UX] [Linux] [Solaris]

    In addition, select a umask that allows the owner to read/write to the files, and allows others to access them according to the prevailing system policy. For root, a umask of 022 is recommended. For non-root users, a umask of 002 or 022 could be used, depending on whether or not the users share the group. To verify the umask setting, issue the following command:

    To set the umask setting to 022, issue the following command:

    umask 022

    (Windows) When installing as an administrative user on a Windows operating system, a Windows service is automatically created to autostart the appserver. The installer user account must have the following advanced user rights:

    • Act as part of the operating system

    • Log on as a service

    For example, on some Windows operating systems, click Administrative Tools > Local Security Policy > User Rights Assignments to set the advanced options. See the Windows operating system documentation for more information.

    (Windows) If we plan to run the appserver as a Windows service, do not install from a user ID that contains spaces. A user ID with spaces cannot be validated. Such a user ID is not allowed to continue the installation. To work around this restriction, install with a user ID that does not contain spaces.

  2. Install the WAS ND product.

    Read the "Installing the product and additional software" topic for more information.

  3. Create a custom profile as the first profile on the machine and federate the node as you create it.

  4. Use the admin console of the deployment manager to create an appserver on the custom node.

    Click Servers > Applications servers > New and follow the instructions to create a server. A server is not required for installing the plug-ins but it lets you verify the functionality of the Web server.

  5. Install the DefaultApplication on the new server while we are in the admin console of the dmgr.

    The DefaultApplication includes the snoop servlet. The verification step uses the snoop servlet.

  6. Stop the appserver if it is running.

    Use the stopServer or the admin console of the dmgr to stop the managed node.

  7. Install the IBM HTTP Server or another supported Web server on Machine B.

    See Install IBM HTTP Server or refer to WAS ND documentation for the Web server for more information.

  8. Launch the Plug-ins installation wizard on the machine with the Web server.

    Select the Plug-ins installation wizard from the launchpad or change directories to the plugin directory on WAS disc or in the downloaded installation image and issue the install command.

  9. Clear the check box for the roadmap or select the check box to view the roadmap, then click Next.

    If unsure of which installation scenario to follow, display the roadmap instead. Print and keep the roadmap as a handy overview of the installation steps.

    Press Ctrl-P to print the roadmap if the Web browser navigation controls and the menu bar are not present on the browser window that displays the Plug-ins roadmap. Press Ctrl-W to close the browser window if the navigation controls and the menu bar do not display. Or close the browser window with the window control in the title bar.

  10. Read the license agreement and accept the agreement it if we agree to its terms. Click Next when we are finished.

  11. If the system does not pass the prerequisites check, stop the installation, correct any problems, and restart the installation. If the system passes the prerequisites check, click Next.

    Look for the appropriate log file for information about missing prerequisites:

    • If we stop the installation, see the temporaryPluginInstallLog.txt file in the temporary directory of the user who installed the plug-ins. For example, the /tmp/temporaryPluginInstallLog.txt file might exist if the root user installed the plug-ins on an operating system such as AIX or Linux.

    • If we continue the installation in spite of warnings about missing prerequisites, see the PLUGINS_ROOT/logs/install/log.txt file after the installation is complete.

    Read the "Troubleshooting installation" topic for more information about log files.

  12. Select the type of Web server that we are configuring and click Next.

    The Plug-ins installation wizard panel prompts you to identify the Web servers to configure. Actually we can select only one Web server each time you run the Plug-ins installation wizard.

    Stop any Web server while we are configuring it. A step later in the procedure directs you to start the Web server as you begin the snoop servlet test.

    If we select the Web server identification option labeled None, the Web server installs the binary plug-ins but does not configure the Web server.

  13. Select Application Server machine (local) and click Next.

  14. Accept the default location for the installation root directory for the plug-ins. Click Next.

    We can type another new directory or click Browse to select an empty directory. The fully qualified path identifies the plug-ins installation root directory.

    The default location is shown in Directory conventions.

    Restriction: The installation directory cannot contain any unsupported characters. See "Object names: what the name string cannot contain" for more information.

    A possibility exists that the Web server might run on a platform that WAS does not support.

  15. Click Browse on the appserver installation location panel to browse for the location of the managed node, if necessary. Click Next when the installation root directory is correct.

    The fully qualified path identifies the installation root directory for WAS ND core files.

  16. Click Browse to select the configuration file for the Web server, verify that the Web server port is correct, and then click Next when you are finished.

    Select the file and not just the directory of the file. Some Web servers have two configuration files and require you to browse for each file.

    The following list shows configuration files for supported Web servers:

    Apache HTTP Server


    Domino Web Server

    names.nsf and Notes.jar

    The wizard prompts for the notes.jar file. The actual name is Notes.jar.

    The Plug-ins installation wizard verifies that the files exist but the wizard does not validate either file.

    IBM HTTP Server

    Microsoft Internet Information Services (IIS)

    The Plug-ins installation wizard can determine the correct files to edit.

    Sun Java System Web Server (formerly Sun ONE Web Server and iPlanet Web Server) V6.0 and later

    obj.conf and magnus.conf

    The wizard displays a naming panel for the nickname of the Web server definition.

  17. Specify a nick name for the Web server and click Next.

    The wizard uses the value to name configuration folders in the plug-ins installation root directory. The wizard also uses the name in the configuration script for the appserver to name the Web server definition.

  18. Accept the location for plugin-cfg.xml and click Next.

    See Plug-ins configuration for a description of the logic that determines what path is configured by default. The wizard determines the characteristics of the managed appserver node to determine the best path for the file: A federated custom node has the following path:



    Accept the default value.

  19. Click Next after verifying the characteristics of the plug-ins installation or click Back to make changes.

    Use the admin console of the deployment manager to delete an existing Web server or to create new ones. Federated nodes can have more than one Web server definition.

  20. Click Next on the pre-installation summary panel to begin the installation or click Back to change any characteristics of the installation. The wizard begins installing the plug-ins and configuring the Web server and the managed custom node.

    The wizard shows an installation status panel as it installs the plug-ins. The wizard displays the Installation summary panel at the completion of the installation.

  21. After the wizard installs the code and creates the uninstaller program, examine the post-installation summary panel. Click Next when we are finished to display the Plug-ins installation roadmap.

    The Plug-ins installation wizard installs the binary plug-in module. On a Linux system, for example, the installation creates the PLUGINS_ROOT directory. The PLUGINS_ROOT/config/Web_server_name directory contains plugin-cfg.xml.

    The wizard displays the name and location of the configuration script and plugin-cfg.xml. The wizard also displays the type of Web server configured and the nickname of the Web server.

    If a problem occurs and the installation is unsuccessful, examine the logs in the PLUGINS_ROOT/logs directory. Correct any problems and reinstall.

  22. Close the road map and click Finish to exit the wizard.

    Log files from the installation are in the PLUGINS_ROOT/logs/install directory.

  23. Complete the installation by creating the Web server definition.

    Use the admin console of the dmgr to create the Web server definition on a federated node. Or, we can run the configuration script that the Plug-ins installation wizard created.

    The script already contains all of the information that gather when using the admin console option. Select one of the following options:

    • Use the admin console

      Click Servers > Web servers > New and use the Create new Web server entry wizard to create the Web server definition.

    • Run the configuration scriptIssue the appropriate command from a command window:

      • [AIX] [HP-UX] [Linux] [Solaris]


      • (Windows) PLUGINS_ROOT\bin\configureWebServer.bat

      If we have enabled security or changed the default JMX connector type, edit the script and include the appropriate parameters on the wsadmin command.

      Shell scripts on some operating systems cannot contain double-byte characters or single-byte characters with pronunciation keys.

      If the file path to the Web server includes double-byte characters or single-byte characters with pronunciation keys, such as o-umlaut (a diacritic mark over the o), c-cedilla (a mark is under the c), or characters with other keys, the script might not run correctly. Copy the content of such a script to the command line and run the wsadmin command directly.

  24. Domino Web server only: Set the WAS_PLUGIN_CONFIG_FILE environment variable.

    On platforms such as AIX or Linux, sourcing a script to the parent shell allows child processes to inherit the exported variables. On Windows systems, run the script as you would run any other command. Sourcing is automatic on Windows systems.

    1. Open a command window.

    2. Change directories to the plug-ins installation root directory.

    3. Issue the appropriate command for the PLUGINS_ROOT/bin/ script:

      • [AIX] [HP-UX] [Solaris]

        . PLUGINS_ROOT/bin/ (Notice the space between the period and the installation root directory.)

      • (Linux) source PLUGINS_ROOT/bin/

    The script is also in the lotus_root/notesdata directory on operating systems such as AIX or Linux.

    Issue the appropriate command for the script before starting the Domino Web Server.

  25. Start the Snoop servlet to verify the ability of the Web server to retrieve an application from the appserver.

    Test the environment by starting the appserver, the Web server, and using the snoop servlet with an IP address.

    1. Start the appserver. In an ND environment, the Snoop servlet is available in the cell only if we included the DefaultApplication when adding the appserver to the cell. The -includeapps option for the addNode command migrates the DefaultApplication to the cell. If the application is not present, skip this step.Change directories to the $WP_PROFILE/bin directory and run the startServer command:

      • [AIX] [HP-UX] [Linux] [Solaris]

        ./ server1

      • (Windows) startServer server1

    2. Start the IBM HTTP Server or the Web server that you are using.

      To start the IBM HTTP Server from the command line: Access the apache and apachectl commands in the IBMHttpServer/bin directory.

      • [AIX] [HP-UX] [Linux] [Solaris]

        ./apachectl start

      • (Windows) apache

    3. Point the browser to http://localhost:9082/snoop to test the internal HTTP transport provided by the appserver. Point the browser to http://Host_name_of_Web_server_machine/snoop to test the Web server plug-in.

      The HTTP Transport port is 9082 by default and must be unique for every profile. The port is associated with a virtual host named default_host, which is configured to host the installed DefaultApplication and any installed Samples. The snoop servlet is part of the DefaultApplication. Change the port to match the actual HTTP Transport port.

    4. Verify that snoop is running.

      Either Web address should display the Snoop Servlet - Request/Client Information page.

    5. Remote IBM HTTP Server only: Verify that the automatic propagation function can work on a remote IBM HTTP Server by using the following steps. This procedure is not necessary for local Web servers.

      1. Create a user=adminUser, password=adminPassword in the IHS_root /conf/admin.passwd file. For example: c:\ws\ihs60\bin\htpasswd -cb c:\ws\ihs60\conf\admin.passwd adminUser adminPassword

      2. Use the admin console of the deployment manager or the appserver to enter the User ID and password information createdd for the admin user of IBM HTTP Server. Go to Servers > Web server > Web_server_definition > Remote Web server administration. Set the following values: admin Port=8008, User Id=adminUser, =adminPassword.

      3. Set the correct read/write permissions for httpd.conf and plugin-cfg.xml. See the IHS_root /logs/admin_error.log file for more information.

      Automatic propagation of the plug-in configuration file requires the IBM HTTP admin server to be up and running. If managing an IBM HTTP Server using the WAS admin console, the following error might display:

      "Could not connect to IHS Administration server error"

      Perform the following procedure to correct the error:

      1. Verify that the IBM HTTP Server administration server is running.

      2. Verify that the Web server host name and the port that is defined in the WAS admin console matches the IBM HTTP Server administration host name and port.

      3. Verify that the fire wall is not preventing you from accessing the IBM HTTP Server administration server from the WAS admin console.

      4. Verify that the user ID and password specified in the WAS admin console under remote managed, is created in the admin.passwd file, using the htpasswd command.

      5. If trying to connect securely, verify that you export the IBM HTTP Server administration server keydb personal certificate into the WAS key database as a signer certificate. This key database is specified by the directive in sas.client.props in the profile where your admin console is running. This consideration is primarily for self-signed certificates.

      6. If we still have problems, check the IBM HTTP Server admin_error.log file and the WAS logs (trace.log file) to determine the cause of the problem.

  26. If the dmgr does not have the DefaultApplication installed, we can test the functionality of the Web server and the custom node using an application of the own.

    See Fast paths for WAS for help in deploying applications.

  27. From the admin console of the dmgr, click System administration > Save Changes to Master Repository > Synchronize changes with Nodes > Save.

  28. To create multiple Web server definitions for the managed node, use the Plug-ins installation wizard to configure each Web server.

    Identify the same managed node each time. Give each Web server a different nick name.



This procedure results in the installation of the Web server plug-ins for WAS on a Web server machine. The Plug-ins installation wizard creates a Web server definition within the managed node.

The Plug-ins installation wizard configures the Web server to use plugin-cfg.xml that is within the managed custom node.

The dmgr regenerates the Web server plug-in configuration file, plugin-cfg.xml whenever an event occurs that affects the file. Such events include the addition or removal of an application, server, or virtual host. The creation or removal of clusters and cluster members also causes file regeneration. Automatic propagation through node synchronization copies the file after each regeneration to the following location on the custom node machine:

The installation of the binary plug-in modules results in the creation of the Plugins directory and several subdirectories.

The following directories are among those created on a Linux system...


Next steps

After installing the binary plug-in for the local Web server, we can start the managed node and the Web server after running the configuration script that completes the installation.

See Plug-ins configuration for information about the location of the plug-in configuration file.

See Web server configuration for more information about the files involved in configuring a Web server.

See Edit Web server configuration files for information about how the Plug-ins installation wizard configures supported Web servers.

See Install Web server plug-ins for information about other installation scenarios for installing Web server plug-ins.


Related concepts

Plug-ins configuration


Related tasks

Install Web server plug-ins