Install and configure Web server plug-ins for WebSphere® Application Server to allow the application server to communicate with the Web server.
Web server plug-in installation for standalone application server environments
Creates a configuration script that you run on the application server machine. Install the Web server and its plug-in on a different machine than the application server. This configuration is recommended for a production environment.
Detects the default profile on a local application server machine and creates the Web server definition for it directly. Install the Web server and its plug-in on the same machine with the application server. This configuration is for development and test environments.
Web server plug-in installation for distributed environments (cells)
Creates a configuration script that you run on the application server machine. Install the Web server and its plug-in on a different machine than the deployment manager or managed node. This configuration is recommended for a production environment.
Creates a configuration script that you run when the deployment manager is running. Install the Web server and its plug-in on the same machine with the deployment manager or a managed node. This configuration is for development and test environments.
Select a link to go to the appropriate steps in the following procedure.
The remote Web server configuration is recommended for production environments.
The
remote installation installs the Web server plug-in on the Web server
machine when the application server is on a separate machine, such
as shown in the following graphic:
Remote installation scenario
Step | Machine | Task |
---|---|---|
1 | A | Install your WebSphere Application Server product. Read the "Installing the product and additional software" topic. |
2 | A | Create an application server profile. |
3 | B | If you plan to run IBM® HTTP
Server on IBM i, it
is already installed as product 5722-DG1 or 5761-DG1. You can also
use a Domino® Web server on IBM i. Refer to the Domino documentation
for installation instructions. For either scenario, you must install the Web server Plug-ins component of the WebSphere Application Server product. See Installing Web server plug-ins on IBM i. |
4 | B | Run the manageprofiles Qshell command
to create an http profile. For example, run this command
from Qshell:
app_server_root/bin/manageprofiles -create -profileName myHttpProfile -templatePath http The myHttpProfile variable is the name of the profile. |
5 | B | Configure the IBM HTTP Server with your http profile myHttpProfile. For additional details or information on configuring your Domino HTTP Server, read the "Configuring an HTTP server instance" topic. If your Web server's name is MyWebServer., an IBM i qshell script called configureIHS_MyWebServer is created in the myHttpProfile_profile_root/config/IHS_myWebServer directory on machine B. For the default WebSphere Application Server install, themyHttpProfile_profile_root of the profile myHttpProfile is /QIBM/UserData/WebSphere/AppServer/V61/Base/profiles/myHttpProfile. Note: In the remainder of this example, webServerName refers to IHS_myWebServer. If you choose to configure a DOMINO Web server as listed below, then webServerName refers to DOMSRV01. The following steps apply to DOMINO Web servers only:
|
6 | A | Copy the configurewebServerName script from Machine B to Machine A. The script is found in the myHttpProfile_profile_root/config/webServerName directory described above |
7 | A | Place the file you copied from the previous step into the profile_root/bin directory on Machine A, where profile_root is the directory where your application server profile is located. |
8 | A | Start the application server and then run the
script that you copied in the previous step. For example,
run these commands from Qshell:
app_server_root/bin/startServer -profileName myProfile cd profile_root/bin ./configurewebServerName [wasAdminUserId] [wasAdminPassword]Note: wasAdminUserId and wasAdminPassword are optional and only needed when the application server of myProfile is running in secure mode. |
9 | A | If you use IBM HTTP
Server on IBM i, verify
that the application server is running. Open the administrative console
(ISC) and do the following:
|
10 | A | Configure a virtual host alias for the Web server
machine(B) and Web server port of MyWebServer. For details, read the "Configuring the virtual host" topic . |
11 | A | Stop and restart your application server. |
12 | A | In the administrative console (ISC) do the following:
|
13 | B | If you use IBM HTTP
Server on IBM i, start
the Web server. Open the administrative console (ISC) and do the following:
|
14 | B | Run the snoop servlet. Access the following
URL in your browser: http://host_name_of_machine_B:http_transport_port/snoop If you get an error, retrace your steps. Add a virtual host to Machine A before restarting the application server on Machine A. |
Step | Machine | Task |
---|---|---|
1 | A | Install the WebSphere Application Server Network Deployment product. Read the "Installing the product and additional software" topic. |
2 | A | Configure a standalone application server profile. |
3 | B | Install IBM HTTP Server or another supported Web server. See Installing IBM HTTP Server or the documentation for your supported Web server. |
4 | B | Install the binary plug-in module using the
Plug-ins installation wizard. See Configuring a Web server and an application server on separate machines (remote). The script for creating and configuring the Web server is created under the plugins_root /bin directory. |
5 | B | Copy the configureweb_server_name script to Machine A. See Configuring a Web server and an application server on separate machines (remote) for information about cross-platform scripts and file encoding differences. |
6 | A | Paste the configureweb_server_name script from Machine B to the app_server_root /bin directory on Machine A. See Configuring a Web server and an application server on separate machines (remote). |
7 | A | Start the application server, then run the script from a command line. |
8 | A | Verify that the application server is running. Open the administrative console and save the changed configuration. |
9 | A | Create a secure connection between the web server
plug-in and the internal HTTP transport in the application server.![]() |
10 | B | Source the plugins_root /setupPluginCfg.sh script for a Domino Web Server before starting a Domino Web server. Otherwise, start the Web server. |
11 | B | Run the snoop servlet. Access the following
URL in your browser: http://host_name_of_machine_B:http_transport_port/snoop To verify with your own application, regenerate and propagate the plugin-cfg.xml file after installing the application. |
Regeneration of the plugin-cfg.xml file
The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically.
During the installation of the plug-ins, the temporary plugin-cfg.xml file is installed on Machine B in the plugins_root/config/ web_server_name directory. To use the actual plugin-cfg.xml file from the application server, propagate the plugin-cfg.xml file as described in the next section.
Propagation of the plugin-cfg.xml file
The plugin-cfg.xml file can be propagated manually. Manual propagation of the plugin-cfg.xml file is required for DOMINO Web servers. Copy the plugin-cfg.xml file from the application server machine to the myHttpProfile_profile_root/config/IHS_MyWebServer directory on the Web server machine B. The plugin-cfg.xml file is generated in the directory named profile_root/config/cells/cell_name/nodes/host_name_of_machine_B-node/servers/IHS_myWebServer on the application server machine A.
The Web server plug-in configuration service propagates the plugin-cfg.xml file automatically for IBM HTTP Server Version 6.0 or later. For all other Web servers, propagate the plug-in configuration file manually. Copy the plugin-cfg.xml file from the profile_root/ config/cells/cell_name/nodes/web_server_name_node/servers/web_server_name directory on Machine A. Paste the file into the plugins_root/config/web_server_name directory on Machine B.
The local Web server configuration is recommended for a development or test environment.
A local installation includes the Web server
plug-in, the Web server, and the Application Server on the same machine:
Local installation scenario
Step | Machine | Task |
---|---|---|
1 | A | Install your WebSphere Application Server product. |
2 | A | Create an application server profile. |
3 | A | IBM HTTP Server on IBM i is already installed as product 5722-DG1 or 5761-DG1. Alternatively, you can also run Domino Web Server on IBM i. Refer to the Domino documentation for installation instructions. |
4 | A | Configure the IBM HTTP
Server with your WebSphere Application Server profile. For additional details or information on configuring your Domino HTTP Server, read the "Configuring an HTTP server instance" topic. The following steps apply to
DOMINO Web servers only. For these steps, assume your Web server's
name is MyWebServer.
|
5 | A | Stop and restart the application server. |
6 | A | If you use IBM HTTP
Server on IBM i, open
the administrative console (ISC) do the following:
|
7 | A | In the administrative console (ISC) do the following:
|
8 | A | If you use IBM HTTP
Server on IBM i, start
the Web server. Open the administrative console (ISC) and do the following:
|
9 | A | Run the snoop servlet. Access the following
URL in your browser: http://host_name_of_machine_A:http_transport_port/snoop If you get an error, retrace your steps. Add a virtual host to Machine A before restarting the application server on Machine A. |
Step | Machine | Task |
---|---|---|
1 | A | Install your WebSphere Application Server product. Read the "Installing the product and additional software" topic. |
2 | A | Create an application server profile. |
3 | A | Install IBM HTTP Server or another supported Web server. See Installing IBM HTTP Server. |
4 | A | Install the binary plug-in module using the
Plug-ins installation wizard. See Configuring a Web server and an application server profile on the same machine. The Web server definition is automatically created and configured during the installation of the plug-ins. |
5 | A | Verify that the application server is running. Open the administrative console and save the changed configuration. |
6 | A | Create a secure connection between the web server
plug-in and the internal HTTP transport in the application server.![]() |
7 | A | Run the plugins_root/setupPluginCfg.sh script for a Domino Web Server before starting a Domino Web server. Start the Web server. |
8 | A | Run the snoop servlet. Access the following
URL in your browser: http://host_name_of_machine_A:http_transport_port/snoop To verify with your own application, regenerate and propagate the plugin-cfg.xml file after installing the application. |
Regeneration of the plugin-cfg.xml file
The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically.
The plugin-cfg.xml file is generated in the profile_root/config/cells/cell_name/nodes/web_server_name_node/servers/web_server_name directory. The generation occurs when the Web server definition is created.
Propagation of the plugin-cfg.xml file
The local file does not require propagation.
The remote Web server configuration is recommended for production environments.
The remote distributed
installation installs the Web server plug-in on the Web server machine
when the application server is on a separate machine, such as shown
in the following graphic:
Remote distributed installation scenario
Step | Machine | Task |
---|---|---|
1 | A | Install WebSphere Application Server Network Deployment. Read the "Installing the product and additional software" topic. |
2 | A | Create a deployment manager profile. |
3 | A | Start the deployment manager with the profile_root/bin/startManager.sh command or its Windows® equivalent. |
4 | B | Install WebSphere Application Server Network Deployment. Read the "Installing the product and additional software" topic. |
5 | B | Create an application server profile. |
6 | B | Federate the node with the profile_root/bin/addNode.sh dmgrhost 8879 -includeapps command or its Windows equivalent. Federating the node starts the nodeagent process, which is required to be running during this configuration. |
7 | C | Install IBM HTTP Server or another supported Web server. See Installing IBM HTTP Server. |
8 | C | Install the binary plug-in module using the
Plug-ins installation wizard. See Configuring a Web server and an application server on separate machines (remote). The script for creating and configuring the Web server is created under the plugins_root/ bin directory. |
9 | C | Copy the configureweb_server_name script
to Machine A. If one machine is running under an operating system such as AIX® or Linux® and the other machine is running under Windows, copy the script from the plugins_root/ bin/ crossPlatformScripts directory. See Configuring a Web server and an application server on separate machines (remote) for information about cross-platform scripts and file encoding differences. |
10 | A | Paste the configureweb_server_name script from Machine C to the app_server_root/bin directory on Machine A. |
11 | A | Start the node agent and the deployment manager
if they are not already running, then run the script from a command
line. If you have enabled security or changed the default JMX connector type, edit the script and include the appropriate parameters on the wsadmin command. |
12 | A/B | Use the administrative console of the deployment manager on Machine A to start the application server on Machine B. Wait for synchronization to occur and save the new configuration. |
13 | A | Create a secure connection between the web server
plug-in and the internal HTTP transport in the application server.![]() |
14 | C | Run the plugins_root/setupPluginCfg.sh script for a Domino Web Server before starting a Domino Web server. Otherwise, start the Web server. |
15 | C | Run the snoop servlet. Access the following
URL in your browser: http://host_name_of_machine_C:http_transport_port/snoop To verify with your own application, regenerate and propagate the plugin-cfg.xml file after installing the application. |
Step | Machine | Task |
---|---|---|
1 | A | Install WebSphere Application Server Network Deployment. |
2 | A | Create a deployment manager profile or use the one created during installation. |
3 | A | Start the deployment manager. From Qshell, run
this command: app_server_root/bin/startManager -profileName name_of_dmgr_profile |
4 | B | Install WebSphere Application Server Network Deployment. |
5 | B | Create an application server profile or use the one created during installation. |
6 | B | Federate the node. From Qshell, run this command:
app_server_root/bin/addNode dmgrHost SOAP_port -profileName appProfile -includeapps Variable descriptions:
Map the application modules to servers after this step. |
7 | C | IBM HTTP Server on IBM i is already installed
as product 5722-DG1 or 5761-DG1. Alternatively, you can also run Domino Web
Server on IBM i. Refer
to the Domino documentation for installation instructions. For either scenario, you must install the Web server Plug-ins component of the WebSphere Application Server product. See Installing Web server plug-ins on IBM i. |
8 | C | Run the manageprofiles Qshell command
to create an http profile. The myHttpProfile variable is the name of the profile. |
9 | C | Configure the IBM HTTP
Server with your http profile myHttpProfile. For additional details or information on configuring your Domino HTTP Server, read the "Configuring an HTTP server instance" topic. Assuming your Web server's name is MyWebServer. an IBM i qshell script called configureIHS_MyWebServer will be created in the myHttpProfile_profile_root/config/IHS_MyWebServer directory on machine C. For the default WebSphere Application Server install, the myHttpProfile_profile_root of the profile myHttpProfile is /QIBM/UserData/WebSphere/AppServer/V61/Base/profiles/myHttpProfile. Note: In the remainder of this example, webServerName refers to IHS_myWebServer. If you choose to configure a DOMINO Web server as listed below, then webServerName refers to DOMSRV01. The following steps apply to DOMINO Web servers only:
|
10 | C | Copy the configurewebserverName script to Machine A. The script is found in the myHttpProfile_profile_root/config/webServerName directory described above. |
11 | A | Place the file you copied from the previous step into the profile_root/bin directory on Machine A, where profile_root is the directory where your deployment manager profile is located. |
12 | A/B | Start the node agent and the deployment manager
if they are not already running, then run the script that you copied
in the previous step. For example, run these commands from Qshell: Machine
A:
app_server_root/bin/startManager -profileName name_of_dmgr_profile cd profile_root/bin ./configurewebServerName [wasAdminUserId] [wasAdminPassword] Note: wasAdminUserId and wasAdminPassword are optional and only needed when the deployment manager of name_of_dmgr_profile is running in secure mode. Machine B:
app_server_root/bin/startNode -profileName appProfile |
13 | A | Use the administrative console of the deployment manager on Machine A to start the application server on Machine B. Wait for synchronization to occur and save the new configuration. |
14 | A | If you use IBM HTTP
Server on IBM i, verify
that the deployment manager is running. Open the administrative console
(ISC) and do the following:
|
15 | A | Configure a virtual host alias for the Web server
machine(C) and Web server port of MyWebServer. For details, read the "Configuring the virtual host" topic. |
16 | A | In the administrative console (ISC) do the following:
|
17 | A | Stop and restart the federated application server. |
18 | A/C | If you use IBM HTTP
Server on IBM i, start
the Web server. Open the administrative console (ISC) on machine A
and do the following:
If you use Domino HTTP Server on IBM i, start the Web server,
on machine C, from a CL command line:
|
19 | C | Run the snoop servlet. Access the following
URL in your browser: http://host_name_of_machine_C:http_transport_port/snoop If you get an error, retrace your steps. |
Regeneration of the plugin-cfg.xml file
The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically.
During the installation of the plug-ins, the temporary plugin-cfg.xml file is installed on Machine B in the plugins_root/config/web_server_name directory.
Propagation of the plugin-cfg.xml file
The plugin-cfg.xml file can be propagated manually. Manual propagation of the plugin-cfg.xml file is required for DOMINO Web servers. Copy the plugin-cfg.xml file from the application server machine to the myHttpProfile_profile_root/config/IHS_MyWebServer directory on the Web server machine C. The plugin-cfg.xml file is generated in the directory named profile_root/config/cells/cell_name/nodes/node_name/servers/IHS_myWebServer on the application server machine B.
The Web server plug-in configuration service propagates the plugin-cfg.xml file automatically for IBM HTTP Server Version 6.0 or later. For all other Web servers, propagate the plug-in configuration file, by manually copying the plugin-cfg.xml file from the profile_root/config/cells/cell_name/nodes/node_name/servers/web_server_name directory on Machine A to the plugins_root/config/web_server_name directory on Machine C.
The local Web server configuration is recommended for a development or test environment.
A local
distributed installation includes the Web server plug-in, the Web
server, and the managed application server on the same machine:
Local distributed installation scenario
Step | Machine | Task |
---|---|---|
1 | A | Install WebSphere Application Server Network Deployment. Read the "Installing the product and additional software" topic.. |
2 | A | Create a deployment manager profile. |
3 | A | Start the deployment manager with the profile_root/bin/startManager.sh command or its Windows equivalent. |
4 | B | Install WebSphere Application Server Network Deployment. Read the "Installing the product and additional software" topic. |
5 | B | Create an application server profile. |
6 | B | Federate the node with the profile_root/bin/addNode.sh dmgrhost 8879 -includeapps command or its Windows equivalent. Federating the node starts the nodeagent process, which is required to be running during this configuration. |
7 | B | Install IBM HTTP Server or another supported Web server. See Installing IBM HTTP Server. |
8 | B | Install the binary plug-in module using the
Plug-ins installation wizard. See Configuring a Web server and an application server profile on the same machine. The script for creating and configuring the Web server is created in the plugins_root/bin directory. |
11 | B | After verifying that the deployment manager
and the node agent are running on Machine A, run the configureweb_server_name script
from a command line in the plugins_root/bin directory
on Machine B. If you have enabled security or changed the default JMX connector type, edit the script and include the appropriate parameters. |
12 | A/B | Use the administrative console of the deployment manager on Machine A to start the application server on Machine B. Wait for synchronization to occur and save the new configuration. |
13 | A | Create a secure connection between the web server
plug-in and the internal HTTP transport in the application server.![]() |
14 | B | Run the plugins_root/setupPluginCfg.sh script for a Domino Web Server before starting a Domino Web server. Otherwise, start the Web server. |
15 | B | Run the snoop servlet. Access the following
URL in your browser: http://host_name_of_machine_B:http_transport_port/snoop |
Step | Machine | Task |
---|---|---|
1 | A | Install WebSphere Application Server Network Deployment. |
2 | A | Create a deployment manager profile or use the one created during installation. |
3 | A | Start the deployment manager. From Qshell, run
this command: app_server_root/bin/startManager -profileName name_of_dmgr_profile Alternatively,
issue the following commands:
cd profile_root/bin startManager |
4 | B | Install WebSphere Application Server Network Deployment. |
5 | B | Create an application server profile or use the one created during the installation. Assume the profile name is appProfile. |
6 | B | Federate the node. From Qshell, run the following
commands: app_server_root/bin/addNode dmgrHost SOAP_port -profileName appProfile -includeapps Variable descriptions:
Map the application modules to servers after this step. |
7 | B | IBM HTTP Server on IBM i is already installed as product 5722-DG1 or 5761-DG1. Alternatively, you can also run Domino Web Server on IBM i. Refer to the Domino documentation for installation instructions. |
8 | B | Configure the IBM HTTP
Server with your application server profile appProfile. For additional details or information on configuring your Domino HTTP Server, read the "Configuring an HTTP server instance" topic. Note: In the remainder of this example, webServerName refers to IHS_MyWebServer. If you choose to configure a DOMINO Web server as listed below, then webServerName refers to DOMSRV01. Also in this example, assume your Web server's name is MyWebServer. |
9 | A/B | (Domino only) The following
steps apply to the DOMINO Web server on machine B:
|
10 | A | Use the administrative console of the deployment manager on Machine A to start the application server on Machine B. |
11 | A | If you use IBM HTTP
Server on IBM i, update
the user ID and password of your Web server configuration. This step
enables your deployment manager to perform remote operations on the
Web server:
|
12 | A | In the administrative console (ISC), configure
a virtual host alias for the Web server machine(B) and Web server
port of MyWebServer. For details, read the "Configuring the virtual host" topic. |
13 | A | In the administrative console (ISC) do the following:
|
14 | A | In the administrative console (ISC), stop and restart the federated application server. |
15 | A/B | If you use IBM HTTP
Server on IBM i, start
the Web server. Open the administrative console (ISC) on machine A
and do the following:
If you use Domino HTTP Server on IBM i, start the Web server,
on machine B, from a CL command line:
|
16 | B | Run the snoop servlet. Access the following
URL in your browser: http://host_name_of_machine_B:http_transport_port/snoop If you get an error, retrace your steps. |
Regeneration of the plugin-cfg.xml file
The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically.
During the installation of the plug-ins, the temporary plugin-cfg.xml file is installed on Machine B in the plugins_root/config/web_server_name directory.
The plugin-cfg.xml file is generated at the location profile_root/config/cells/cell_name/nodes/node_name/servers/webServerName directory, when the Web server definition is created.
Regenerate the plugin-cfg.xml file in the Web server definition in the application server whenever the configuration changes. The Web server has immediate access to the file whenever it is regenerated.
When the Web server plug-in configuration service (an administration service) is enabled on Machine A, the plugin-cfg.xml file is automatically generated for all Web servers.
Propagation of the plugin-cfg.xml file
Node synchronization is used to propagate the plugin-cfg.xml file from Machine A to Machine B.
When the Web server plug-in configuration service (an administration service) is enabled on Machine A, the plugin-cfg.xml file is automatically propagated for all Web servers.
Alternate configuration
This procedure describes installing the plug-ins on
two machines. However, you can perform this procedure on a single
machine as shown in the following graphic. A local distributed installation
also includes the Web server plug-in, the Web server, the application
server, and the deployment manager on the same machine:
See Web server configuration for more information about the files involved in configuring a Web server.
See Plug-ins configuration for information about the logic behind the processing scenarios for the Plug-ins installation wizard.
See Editing Web server configuration files for information about how the Plug-ins installation wizard configures supported Web servers.
See Installing Web server plug-ins for information about other installation scenarios for installing Web server plug-ins.
See Installing Web server plug-ins on IBM i for information about other installation scenarios for installing Web server plug-ins.
In this information ...Related concepts
Related reference
| IBM Redbooks, demos, education, and more(Index) Use IBM Suggests to retrieve related content from ibm.com and beyond, identified for your convenience. This feature requires Internet access. Most of the following links will take you to information that is not part of the formal product documentation and is provided "as is." Some of these links go to non-IBM Web sites and are provided for your convenience only and do not in any manner serve as an endorsement by IBM of those Web sites, the material thereon, or the owner thereof. |