This topic helps you use the Plug-ins installation wizard to install Web server plug-ins for WebSphere Application Server. This topic is the information center version of the roadmap that is displayed when you use the Plug-ins installation wizard.
Before you begin
The primary production configuration is an application server on one machine and a Web server on a separate machine. This configuration is referred to as a remote configuration. Contrast the remote configuration to the local configuration, where the application server and the Web server are on the same machine.Why and when to perform this task
Web server plug-in installation for stand-alone 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.
Steps for this task (dependent on configuration)
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 the WebSphere Application Server Network Deployment product. See Installing the product and additional software. |
2 | A | Configure a stand-alone application server profile. See Using the Profile creation wizard to create an application server. |
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 plug-ins_install_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 was_install_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 | B |
|
10 | B | Run
the snoop servlet. 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
During the installation of the plug-ins, the temporary plugin-cfg.xml file is installed on Machine B in the plug-ins_install_root/ config/ web_server_name directory.
The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically.
To use the real 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 Web server plug-in configuration service propagates the plugin-cfg.xml file automatically for IBM HTTP Server 6.0 only.
For all other Web servers, propagate the plug-in configuration file manually. Copy the plugin-cfg.xml file from the profiles_install_root/ config/ cells/ cell_name/ nodes/ Web_server_name_node/ servers/ web_server_name directory on Machine A. Paste the file into the plug-ins_install_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. See Installing the product and additional software. |
2 | A | Create an application server profile. See Using the Profile creation wizard. |
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 | B |
Start the Web server. |
7 | B | Run
the Snoop servlet. 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 profiles_install_root/ profile_name/ 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 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 WebSphere Application Server Network Deployment. See Installing the product and additional software. |
2 | A | Create a deployment manager profile. See Using the Profile creation wizard. |
3 | A | Start the deployment manager with the ./profiles_install_root/ profile_name/ bin/ startManager.sh command or its Windows equivalent. |
4 | B | Install WebSphere Application Server Network Deployment. See Installing the product and additional software. |
5 | B | Create an application server profile. See Using the Profile creation wizard. |
6 | B | Federate the node with the ./profiles_install_root/ profile_name/ 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 plug-ins_install_root/ bin directory. |
9 | C | Copy the configureWeb_server_name script
to Machine A. If one machine is running under Linux or UNIX and the other machine is running under Windows, copy the script from the plug-ins_install_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 was_install_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 | C |
|
14 | C | Run
the Snoop servlet. 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
During the installation of the plug-ins, the temporary plugin-cfg.xml file is installed on Machine C in the plug-ins_install_root/ config/ web_server_name directory.
The Web server plug-in configuration service regenerates the plugin-cfg.xml file automatically.
To use the real 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 Web server plug-in configuration service propagates the plugin-cfg.xml file automatically for IBM HTTP Server 6.0 only.
For all other Web servers, propagate the plug-in configuration file, by manually copying the plugin-cfg.xml file from the profiles_install_root/ profile_name/ config/ cells/ cell_name/ nodes/ node_name/ servers/ web_server_name directory on Machine A to the plug-ins_install_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. See Installing the product and additional software. |
2 | A | Create a deployment manager profile. See Using the Profile creation wizard. |
3 | A | Start the deployment manager with the profiles_install_root/ profile_name/ bin/ startManager.sh command or its Windows equivalent. |
4 | B | Install WebSphere Application Server Network Deployment. See Installing the product and additional software. |
5 | B | Create an application server profile. See Using the Profile creation wizard. |
6 | B | Federate the node with the ./profiles_install_root/ profile_name/ 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 plug-ins_install_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 plug-ins_install_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 | B |
|
14 | B | Run the Snoop servlet. |
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 at the location profiles_install_root/ profile_name/ config/ cells/ cell_name/ nodes/ node_name/ servers/ web_server_name 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:
Result
You can set up a remote or local Web server by installing Application Server, the Web server, and then the Web server plug-ins.What to do next
See Web server configuration for more information about the files involved in configuring a Web server.
See Configuration behavior of the Plug-ins installation wizard 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.
Related concepts
Web server plug-ins
Related information
Web server plug-in properties settings