User Guide Cancel

Manage servers in ColdFusion Builder

Last updated on

ColdFusion User Guide
Introduction to ColdFusion
Cloud Services in ColdFusion
Install ColdFusion
Use ColdFusion
Performance Monitoring Toolset
Adobe ColdFusion Builder extension for Visual Studio Code
Use ColdFusion Builder
Coldfusion API Manager
Configure and administer ColdFusion
CFML Reference
1. Introduction to CFML Reference
2. Reserved words and variables
3. ColdFusion tags
  1. ColdFusion tags
  2. Tags in ColdFusion 10
  3. Tag summary
  4. Tags by function
  5. Tag changes since ColdFusion 5
  6. Tags a-b
  7. Tags c
  8. Tags d-e
  9. Tags f
  10. Tags g-h
  11. Tags i
  12. Tags j-l
  13. Tags m-o
  14. Tags p-q
  15. Tags r-s
  16. Tags t
  17. Tags u-z
4. ColdFusion functions
5. Ajax JavaScript functions
6. ColdFusion ActionScript functions
7. ColdFusion mobile functions
8. Application.cfc reference
9. Script functions implemented as CFCs
10. ColdFusion Flash Form style reference
11. ColdFusion event gateway reference
12. ColdFusion C++ CFX Reference
13. ColdFusion Java CFX reference
14. WDDX JavaScript Objects
Develop ColdFusion applications
1. Introducing ColdFusion
2. Changes in ColdFusion
3. Introduction to application development
4. The CFML programming language
5. Building blocks of ColdFusion applications
6. Develop CFML applications
7. Develop mobile applications
8. Access and use data
9. ColdFusion ORM
10. ColdFusion and HTML5
11. Flex and AIR integration in ColdFusion
12. Request and present information
13. Office file interoperability
14. ColdFusion portlets
15. Work with documents, charts, and reports
16. Use web elements and external objects
17. Use external resources

The comprehensive Server Management feature of ColdFusion Builder lets you start, stop, and restart the ColdFusion server, and access the ColdFusion Administrator and Server Monitor from a single Servers view. For more information about the Servers view, see Using Servers View.

You add a server, and associate it with a project to debug or preview files in the project. You also associate a server with a project to install and run the extensions that are packaged with ColdFusion Builder. For more information about adding servers, see Adding ColdFusion servers.

Understanding web server terminology

Before you set up and manage your server, read through the following topics to understand web server terms and concepts that are used in the documentation.

For detailed information about web servers and configuring them for ColdFusion, see Web Server Management in the ColdFusion Administrator's Guide

Document root

The term Document Root refers to a file system directory, from where your web server serves web pages. The term can vary from server to server, but the same concepts apply to most web servers.

URL prefix

A URL prefix maps a local file system resource with a URL.

In ColdFusion Builder, you use a URL prefix to preview or debug projects outside your web root or document root.

You can specify a URL prefix while creating a server, or by editing settings for an existing server. For more information, see URL Prefix.

You can also specify a URL prefix to an existing project or folder. For more information, see Set URL Prefix.

Usage Scenario

You have a project called "Project1". Project1 is configured to server1, whose document root is at C:\server1\MyDocs and URL is http://www.example1.com. Within Project1, you have a linked folder called " xyz ". The folder xyz points to the document root of server2, which is C:\server2\MyDocs and the URL to access it is http://www.example2.com. You want to preview all the files within the xyz linked folder in ColdFusion Builder.In this scenario, to preview files within the xyz linked folder, you create a URL prefix. You create a URL prefix by specifying the following details:

Absolute path: C:\server2\MyDocs\
URL to access the xyz folder: http://www.example2.com

Virtual host

The term Virtual Host refers to the method of hosting multiple websites (domain names) on a single web server. The multiple websites are differentiated by their apparent host names. For example, you can run websites www.example1.com, www.example2.com, and www.example3.com, on a single IP address.

In the ColdFusion Builder context, you can use a single ColdFusion server to run multiple websites that are configured as virtual hosts on an external web server like IIS or Apache.

For information on how to configure virtual hosts in the web server, see the web server- specific documentation.

When you associate a project with a virtual host, ColdFusion Builder functionality like, previewing, debugging, Content Assist, and building extensions, is extended to all the folders and subfolders within the project.

Virtual directory

The term _Virtual Directory _refers to a folder that is not physically contained in the document root although it is accessible through the server URL. To create a virtual directory, you specify an alias for the folder’s path in the URL. The alias name is used to access resources within the folder.

Suppose the document root for your website (www.example.com) is c:\xyz\docs, and the folder that provides contents to your website is at d:\abc\content. Then, you define an alias for this folder called content. You can then access the website using the URL: http://www.example.com/content/

Adding ColdFusion servers

You add a ColdFusion server to test projects or applications that you create in the ColdFusion Builder workspace. The ColdFusion server can be a development server for testing and running your applications before you deploy them on a production server. You can add a local or remote ColdFusion server.

Add a local server

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 ColdFusion server host. For example, localhost or 127.0.0.1.
Select Is Local.

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 JEE configuration) Enter the context root. The JEE environment supports multiple, isolated web applications running in a server instance. Hence, JEE 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 JEE 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 and Auto Stop to automatically start and stop the ColdFusion server every time you launch and exit ColdFusion Builder.

Click Next.

Local Server Settings

Select the Local Server Settings tab, and specify the following local server settings, as applicable.

Server Home: (applicable only for Server configuration deployments running on Windows) Browse and select the ColdFusion Server home directory. For example, C:\ColdFusion11\cfusion.
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.This setting is required for previewing, debugging, and CFC name resolution in ColdFusion Builder.
Version: (applicable only for Server configuration deployments running on Windows) Select the ColdFusion server version from the Version drop-down list.
Windows Service: (applicable only for Server configuration deployments running on Windows) The Windows Service option is available only for Server configuration deployments, and not JEE configuration deployments of ColdFusion. If you want to start and stop the ColdFusion server using the Windows Service, select Use Windows Service To Start/Stop Server.

URL Prefix

(optional)

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.

Select the URL Prefix tab and enter the following details:

Local Path: Browse to or enter the path to the local file system resource.
URL prefix: Enter the URL prefix.
Click Add.

Virtual Host Settings

(optional)

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.

To configure a virtual host, select the Virtual Host Settings tab, and do the following:

Click New and enter the following details in Virtual Host Settings section.

a. 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.

b. Host Name: The virtual host name as specified in your IIS or Apache web server settings. For example, www.example1.comWhen 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 created 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".

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

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

e. 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.

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

b. 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.

c. Click Add.

d. 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.

Install Extensions

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

Browse and select the ColdFusion web root location.
Browse to a location within the web root to install the extension. The extension is installed in the Extensions directory within the selected location.

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

Adding a bundled ColdFusion server

Bundled ColdFusion Server

Add a remote server

Before you add a remote server in ColdFusion Builder, do the following tasks, if you plan to use the feature within ColdFusion Builder to start/stop the remote instance.

Run the Admin server instance in the remote ColdFusion server

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

Server remote server version 7.0.2, 8.0.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

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

Multi-server/JEE remote server version 7.0.2, 8.0.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)

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

Server/Multiserver/JEE remote server version 9 and above

For ColdFusion 9 versions 9 and above, the Admin Server components are shipped by default and implemented if the Admin Server components are selected during installation.

For Server configuration, go to {cfhome}/runtime/bin and run the adminstart script file.
For multi-server configurations of ColdFusion 9 or earlier, go to JRun_Home/bin and run the adminstart script file.

Update security properties for the remote ColdFusion server

Go to {CFHome}/runtime/lib/security.properties
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 CF+Tomcat Bundle (for CF 11 Server), or select JRun (for CF9 Server or earlier), or Other to configure another JEE server.

Note:

You cannot start, stop, or restart a JEE 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 JEE configuration) Enter the context root. The JEE environment supports multiple, isolated web applications running in a server instance. Hence, JEE 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 JEE 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

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.
User Name: Specify the jmc user name, which is listed in the jrun -users. xml file.
Password: Specify the jmc password.
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.
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.
(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.
a. 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.

b. Host Name: The virtual host name as specified in your IIS or Apache web server settings. For example, www.example1.comWhen 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".

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

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

e. 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.
a. Alias: Specify an alias for the folder path.

b. 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.

c. Click Add.

d. 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.

Browse and select the ColdFusion web root location.
Browse and select the ColdFusion web root location on the remote ColdFusion server.
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.----

Using Servers View

Use the Servers View to start, stop, and restart servers in ColdFusion Builder. You can also launch the ColdFusion Server Monitor and ColdFusion Server Administrator from the Servers View.

If the Servers View is not already displayed in the workbench, add the Servers View by selecting Window > Show View > Other. Then, in the Show View dialog box, select ColdFusion > Servers View.

Start, stop, restart, or delete a server

Right-click the server in Server View.
Select one of the following: Start Server, Stop Server, Restart Server, or Delete Server. Restart Server first stops and then starts the server.

Start ColdFusion Server Administrator

Right-click in the Server View.
Select Launch ColdFusion Administrator.
Specify the username and password.
Click OK to view ColdFusion Administrator.

Connect to remote systems

You can connect to remote systems, such as, ftp, ssh, sftp, and so on.

To connect to a remote system,

Click Window > Show View > Other.
Expand the group Remote Systems and click Remote Systems, as shown below:

Remote systems

Click Open.
On the tab Remote Systems, right-click Local, and click New > Connection.
On the New Connection window, click FTP Only, if you want to connect to an FTP server, for example.

New connection

Click Next.
Enter the URL of the remote FTP location.

Remote FTP connection

Click Finish.
In the Remote Systems tab, right-click the newly added FTP location and click Connect.

Enter password

To connect, click OK.
The Console tab displays the status of the connection. You can also see that all folders in the location are granted necessary permissions.

In the Remote Systems tab, you can see the list of files in the Files sub-directory.

Import RDS server settings

If you have an RDS server configured, you can import the RDS server settings directly and add your RDS server to the Servers view.

Right-click in the Servers view, and select Add Server.
Select Import Configuration From RDS Server, and select the RDS server that you want to add to the Server view from the drop-down list.
Click OK.
To modify the RDS settings, specify changes in the Modify ColdFusion Server Setup dialog box, and click Finish.

You can now associate the server with your project, and debug, preview, and test your project.

Manage servers in ColdFusion Builder

Understanding web server terminology

Document root

URL prefix

Usage Scenario

Virtual host

Virtual directory

Adding ColdFusion servers

Add a local server

General Settings

Other Settings

Local Server Settings

URL Prefix

Virtual Host Settings

Install Extensions

Adding a bundled ColdFusion server

Add a remote server

Run the Admin server instance in the remote ColdFusion server

Server remote server version 7.0.2, 8.0.1

Multi-server/JEE remote server version 7.0.2, 8.0.1

Server/Multiserver/JEE remote server version 9 and above

Update security properties for the remote ColdFusion server

Specify the remote server settings in ColdFusion Builder

General Settings

Other Settings

Remote Server Settings

Install Extensions

Using Servers View

Start, stop, restart, or delete a server

Start ColdFusion Server Administrator

Connect to remote systems

Import RDS server settings

Ask the Community

Contact Us