On the General Settings tab in Server Settings, select the option Is Remote.
Add a ColdFusion server in VS Code extension
You add a ColdFusion server to test projects or applications that you create in the VS Code extension 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.
Adding ColdFusion servers
To add a ColdFusion server, follow the steps below:
- In the CF Servers pod, click + (Add Server).
- Enter the following details. Some are mandatory.
General Settings tab
|Server Name (mandatory)||ColdFusion server name.|
|Host Name (mandatory)||Name of the ColdFusion server host. For example, localhost or 127.0.0.1.|
|Description||Description of the server.|
|Webserver Port (mandatory)||Specify the port number of the ColdFusion server instance you are configuring. The default port number of the ColdFusion server is 8500.|
|Application Server (mandatory)||Select the server on which ColdFusion is deployed.|
|RDS User Name||If you are using RDS, specify the RDS username.|
|RDS Password||Enter the RDS password. Click Test Connection. If you’d configured RDS as expected, you will see RDS Fileview and Dataview pods with the file paths and the built-in databases respectively.|
|Type||Select the appropriate option if the ColdFusion server is hosted on your local machine or on a remote machine.|
|Enable SSL||Select this option to enable SSL support in the extension. Servers registered in the Server Manager can communicate using SSL.|
|Context Root||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||Name of the JEE Server on which ColdFusion is deployed.|
Local Server Settings tab
|Server Home (mandatory)||Browse and select the ColdFusion Server home directory. For example, <ColdFusion Home>/cfusion.|
|Document Root (mandatory)||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, ColdFusion webroot.|
|Version||Select the ColdFusion server version from the Version drop-down list.|
|Windows Service||Applicable to 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 tab
A URL prefix maps a local file system resource with a URL.
You can specify a URL prefix while creating a server, or by editing settings for an existing server. You can also specify a URL prefix to an existing project or folder.
For example, there is 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
|Local path (mandatory)||Browse to or enter the path to the local file system resource.|
|URL prefix (mandatory)||Enter the URL prefix.|
Virtual Host Settings tab
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.
|Name (mandatory)||Specify a name for the virtual host.|
|Host Name (mandatory)
||The virtual host name that is mentioned in your IIS or Apache web server settings. For example, www.example1.com. When you create a virtual host in ColdFusion Builder extension, the virtual host uses a naming convention server name-virtual host name. For example, if you created a virtual host named "vh1" in your ColdFusion server (localhost), the naming convention that ColdFusion Builder extension uses to identify the virtual host is "localhost-vh1".|
|Port (mandatory)||The port assigned to the virtual host in the web server.|
|Type (mandatory)||Select HTTP or HTTPS from the drop-down list.|
|Document Root (mandatory)||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.|
Virtual Directory settings
Specify an alias for the folder path.
|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".|
Start, stop, restart, or delete a server
- Click the server in the CF Servers pod.
- Select one of the following: Start Server, Stop Server, Restart Server, or Delete Server. Restart Server first stops and then starts the server.
Add a remote server
To add a remote server, follow the steps below:
Enter the following details:
- Server Name: ColdFusion server name.
- Webserver Port: Specify the port number of the remote ColdFusion server instance you are configuring.
- Description: (optional) Description of the server.
- Application Server: Select the drop-down list and select CF+ Tomcat Bundle.
- Host Name: Name of the remote server host.
- Enter the RDS username and password, if you're configuring an RDS.
On the Remote Server Settings tab, enter the following:
- User Name: Specify the CF Admin username.
- Password: Specify the CF Admin password.
- Admin Port: The webserver port of the remote server.
- Server name: The name of the remote instance.
Add the Mappings and Virtual Host Settings, as described in the section above.
Click Finish to add the remote ColdFusion server instance.