Add a remote server

Before you add a remote server in ColdFusion Builder, do the following tasks.

Run the Admin server instance in the remote ColdFusion server

Depending on your remote server version and configuration, do the necessary tasks.

Standalone remote server version 7.0.2, 8.0.1

  1. Unzip the file AdminServerComponents.zip to {CFHome}

    The following files are copied to {cfhome}/runtime/bin:
    • adminstart.bat

    • admin_jvm.config

    • adminstart.sh

    The Admin Server instance is copied to {cfhome}/runtime/servers

  2. Go to {cfhome}/runtime/bin and run adminstart.bat (for Windows) or adminstart.sh (for Mac OS)

Multi-server/J2EE remote server version 7.0.2, 8.0.1

  1. In the AdminServerComponents.zip file, unzip the following files to JRun_Home/bin:

    • admin_jvm.config

    • adminstart.bat (for Windows) or adminstart.sh (for Mac OS)

  2. Go to JRun_Home/bin and run adminstart.bat (for Windows) or adminstart.sh (for Mac OS)

Standalone/multi-server/J2EE remote server version 9

For version 9 of the remote server, the Admin Server components are shipped, by default.

  • For standalone server configuration, go to {cfhome}/runtime/bin and run the adminstart script file.

  • For multi-server or J2EE server configurations, go to JRun_Home/bin and run the adminstart script file.

Update security properties for the remote ColdFusion server

  1. Go to {CFHome}/runtime/lib/security.properties

  2. Update the values of jrun.subnet.restriction and jrun.trusted.hosts with the IP address of computer where ColdFusion Builder is installed. Alternatively, you can use the asterisk wildcard (*) as the IP address value, to allow the server to start and stop without any restriction.

Specify the remote server settings in ColdFusion Builder

In the Servers view, do one of the following:

  • Right-click and select Add Server.

  • Click .

Enter the following details in the ColdFusion Server Setup wizard:

General Settings

  • Server Name: ColdFusion server name.

  • Description: (optional) Description of the server.

  • Application Server: Select the drop-down list and select JRun or select Other to configure a non-Jrun server.
    Note: You cannot start, stop, or restart a non-JRun server within ColdFusion Builder.
  • Host Name: Name of the remote server host.

  • Select Is Remote.

    Note: When you enter a Host Name other than localhost or 127.0.0.1, Is Remote is automatically selected.

Other Settings

  • Webserver Port: Specify the port number of the ColdFusion server instance you are configuring. The default port number of the ColdFusion server is 8500.

  • Context root: (applicable only for JRun servers with J2EE configuration) Enter the context root.

    The J2EE environment supports multiple, isolated web applications running in a server instance. Hence, J2EE web applications running in a server are each rooted at a unique base URL, called a context root (or context path).

  • Application Server Name: (applicable only for JRun servers with J2EE configuration) Name of the JRun Server on which ColdFusion is deployed.

  • RDS User Name: (optional) If you are using RDS, specify the RDS user name.

  • RDS Password: (optional) Specify the RDS password.

    Note: You set the RDS password in the ColdFusion Administrator. Do not confuse the RDS password with the ColdFusion Administrator password, which is also managed through the ColdFusion Administrator.
  • Select Enable SSL to enable SSL support in ColdFusion Builder. Servers registered in the Server Manager can communicate using SSL.

  • Select Auto Start to automatically start the ColdFusion server every time you launch ColdFusion Builder.

    Note: Auto Stop is not available for remote servers.

Click Next.

Remote Server Settings

  1. Naming Port: Specify the naming port of the administrator server instance running on the remote server. By default, the naming port value is 2910. The naming port value is specified in {servers}/admin/SERVER-INF/jndi.properties. The port value of property java.naming.provider.url is the naming port/jndiport.

  2. User Name: Specify the jmc user name, which is listed in the jrun-users.xml file.

  3. Password: Specify the jmc password.

  4. Document Root: Browse and select the web root location. If ColdFusion is configured with a web server, say IIS, then select the document root of the web server; for example, c:\inetpub\wwwroot.

  5. Select the Mappings tab, and enter the following details. The mapping details are used for previewing and debugging files on the remote server.

    • Local path: Path that ColdFusion Builder uses to find projects or folders on the remote ColdFusion server.

    • Remote path: (optional if you specify the URL prefix) Path to the project on the remote ColdFusion server.

    • URL prefix: (optional if you specify the remote path) Enter the URL prefix. To understand more about a URL prefix, and in what scenarios you can use a URL prefix, see URL prefix.

      Note: You don’t necessarily have to specify a URL when creating a server. You can specify a URL prefix even after creating the server by editing the server settings in the Servers view. You can also specify a URL prefix to an existing project or folder; for more information, see Set URL Prefix.
    • Click Add to add this mapping.

  6. (optional) To configure a virtual host, select the Virtual Host Settings tab, and do as follows:

    Note: When you specify a virtual host or virtual directory in ColdFusion Builder, corresponding settings must be specified in the configured web server. ColdFusion Builder does not validate these settings. So, if the settings in the web server are different from what you specify in ColdFusion Builder, ColdFusion Builder does not give an error.
    • Click New and enter the following details in Virtual Host Settings section.

      1. Name: Specify a name for the virtual host. For example, vh1.
        Note: You can provide any name and not necessarily the name that you provide in the web server.
      2. Host Name: The virtual host name as specified in your IIS or Apache web server settings. For example, www.example1.com

        When you create a virtual host in ColdFusion Builder, the virtual host uses a naming convention server name-virtual host name. The Server drop-down list in Project properties displays the virtual host name using this naming convention. For example, if you create a virtual host named "vh1" in your ColdFusion server (localhost), the naming convention that ColdFusion Builder uses to identify the virtual host is "localhost-vh1".

      3. Port: The port assigned to the virtual host in the web server.

      4. Type: Select HTTP or HTTPS from the drop-down list.

      5. Document Root: Browse to or enter the home directory of the virtual host.

        For example, if your website www.example.com is mapped to the directory C:\abc on the Apache web server, enter C:\abc as the home directory.

    • (optional) To create a virtual directory, click Virtual Directory, and enter the following details.

      1. Alias: Specify an alias for the folder path.

      2. Location: Browse to or enter the folder path to which you want to specify an alias.

        For example, if the document root of your website (www.example.com) is c:\abc, and you want to include images from a folder available on d:\xyz\images. Then, you can define an alias called "images" for the folder path "d:\xyz\images". To understand more about virtual directories, see Virtual directory.

      3. Click Add.

      4. Click OK to add the virtual directory to the Virtual Directory Settings table.

    • Click Apply. The virtual host is added to the List Virtual Hosts table.

    To modify the virtual host settings, select the virtual host from the List Virtual Hosts table, modify the settings, and click Update.

    To understand more about virtual hosts, and its relevance in the ColdFusion Builder context, see Virtual host.

Click Next.

Install Extensions

Select Install Extensions to install the extensions that are packaged with ColdFusion Builder.

  1. Browse and select the ColdFusion web root location.

  2. Browse and select the ColdFusion web root location on the remote ColdFusion server.

  3. Browse to a location within the web root to install the extensions. The extensions are installed in the Extensions directory within the selected location.

Click Finish to add the remote ColdFusion server instance. For information on using these extensions, see Using Extensions.

If the remote server is connected successfully, then the server status in ColdFusion Builder is displayed as Running. If the remote server is not connected successfully, the server status is displayed as Unknown. For more details about the error, see Console view.