Registering an External Tomcat Web Server

See Also

When you download and install the Java EE version of the IDE, you can choose to install and register the Tomcat Web Server. You can also configure the IDE to deploy web applications to other installations of supported versions of the Tomcat Web Server. These Tomcat Web Server installations must first be registered. Unsupported versions of the Tomcat Web Server cannot be registered with the IDE. Instead, you can create Ant targets that you can run from the IDE to deploy an application, JSP page, or servlet to an unsupported version of the Tomcat Web Server.

To register an external Tomcat Web Server:

  1. Make sure the server is not running. If the server is running and there is a port number conflict with other installed servers, the IDE will not be able to resolve the conflict.
  2. Choose Tools > Servers.
  3. Click Add Server to display the Add Server Instance wizard.
  4. Select the Tomcat Web Server from the combo box.
  5. Click Next.
  6. In the Catalina Home text box, type or browse to the Tomcat installation directory on your local system. Note that the system verifies that you have specified a valid Tomcat home directory.
  7. (Optional) If you expect to use Tomcat in a multi-user configuration, select the Use Private Configuration Folder checkbox. In the Cataline Base text box, type or browse to the base directory. Typically, a base directory is placed under a user's directory. If you associate a base directory with the server, the base directory must have the following subdirectories. If the base directory is empty, the IDE creates the subdirectories by copying them from Tomcat's home directory. In addition, the conf directory must have a server.xml file.
  8. Type a user name and password. The user must be a Tomcat user who has a manager role.
  9. Click Finish and Close to exit the Server Manager.
    The IDE displays the server's port number in the server node's tooltip. If another server instance is using this port, you must change one of the servers' port numbers. To change a port number, right-click the server's node, choose Stop from the contextual menu. Next, right-click the server node and choose Properties from the contextual menu. Change the server port number and restart the server.

If you want to change any setting that you entered in the New Server dialog box, right-click the server's node in the Services window and choose Properties from the contextual menu.

To remove an instance of the Tomcat Web Server:
  1. Choose Tools > Server Manager.
  2. In the Server Manager, select the Tomcat Web Server from the list of servers in the left pane.
  3. Click Remove Server.
  4. Click Close.
See Also
About the Tomcat Web Server
Viewing the Tomcat Web Server in the IDE
Customizing the Tomcat Web Server
Customizing the Tomcat Configuration File

Legal Notices