Install the server configuration

The ColdFusion server configuration contains an embedded copy of Tomcat and is most similar to earlier versions of ColdFusion.

Note: The cf_root directory refers to your installation directory. By default, this directory is C:\ColdFusion2023 in Windows, and /opt/ColdFusion 2023 in UNIX.

Although the Adobe ColdFusion (2023 release) installer provides an intuitive interface, it helps to plan your answers to the questions asked by the installer. Use the steps below to install the server configuration of Adobe ColdFusion (2023 release).

Installing ColdFusion using the server configuration

Once you have determined the answers to the questions in the above section Gathering information necessary to install the server configuration, you can install the ColdFusion server configuration in Windows or UNIX, as applicable.

Installing ColdFusion server configuration in Windows or MAC

Install ColdFusion in Windows or MAC

1. Read the online version of the Release Notes for any late-breaking information or updates. For more information, see Release notes.
2. Ensure that your operating system meets the system requirements.
3. Review Installation considerations for Windows and Installation considerations for all platforms (Refer to the Installing Adobe ColdFusion).
4. Determine the answers to the questions in the above table in "Gathering information necessary to install the server configuration" section.
5. Close any applications that are currently running on your computer.
6. If you plan to configure an external web server, ensure that the web server is running.
7. Insert the DVD or download the setup file from the Adobe website.
8. If the installation wizard does not start automatically when you insert the DVD, locate the appropriate installer file on the DVD and double-click it. If you are installing from a network or a downloaded file, locate the ColdFusion installer *Windows only:* coldfusion_2023_WWEJ_win32.exe/coldfusion_2023_WWEJ_win64.exe and double-click it.*MAC only:*Extract the coldfusion_2023_WWEJ_osx2023.dmg file and double-click the installer.
9. Follow the instructions in the installation wizard, and let it run to completion.
10. Click OK to open the ColdFusion Administrator and configure the server.
11. To install any other integrated Adobe or third-party technologies, see Installing Integrated Technologies.
12. Configure and manage your system, as described in Configuring your System your System.
13. To learn about ColdFusion, read the documentation, which is accessible through the Documentation link on the Resources page of the ColdFusion Administrator.

Installing the ColdFusion server configuration in UNIX

By default, ColdFusion installs into the /opt/coldfusion2023 directory. You can also choose to install ColdFusion in a different directory.

Install the ColdFusion server configuration in UNIX

1. Read the online version of the Release Notes for any late-breaking information or updates. For more information, see Release notes.
2. Ensure that your operating system meets the system requirements.
3. Review Installation considerations for UNIX and Installation considerations for all platforms  (Refer to the Installing Adobe ColdFusion).
4. Determine the answers to the questions in the above section "Gathering information necessary to install the server configuration".
5. If you plan to configure an external web server, ensure that the web server is running.

6. Log in as root.
   Copy the installation file that is appropriate for your platform and locale from the DVD or Adobe website, and save it to a directory on your local disk. The following installation files are those for the supported server configuration platforms:

• ColdFusion_2023_WWEJ_linux64.bin (64-bit systems)

  Solaris

  ColdFusion_2023_WWEJ_solaris64.bin

   

1. Using the cd command, go to the directory that contains the installation file.

2. Ensure that you have executable permission for the installation file. You can change permissions on the file by using the following command:

   chmod 777 ColdFusion_2023_WWEJ_solaris64.bin

    

3. Start the installation with the following command:

   ./<filename>

4. Follow the prompts in the installation program, and let it run to completion.

5. Start ColdFusion with the following command:

If you specified the use of an external web server when you ran the installer, ColdFusion automatically runs the cf_root/cfusion/bin/cf-connectors.sh script when it starts the first time. This shell script runs the Web Server Configuration Tool by using the settings that you specified during the installation. If there are problems running this script, review the configuration and bin directory specifications, modify as necessary, and rerun the script. You can also configure your web server by using the scripts in cf_root/cfusion/bin/connectors, as appropriate. To stop ColdFusion, use the following command:

For more information on managing processes, see Managing the ColdFusion process in UNIX.

1. Open ColdFusion Administrator to run the Configuration wizard.
2. Configure and manage your system, as described in Configuring your System.
3. To install any other integrated Adobe or third-party technologies, see Installing Integrated Technologies.
4. To learn about ColdFusion, read the documentation, which is accessible through the Documentation link on the Resources page of the ColdFusion Administrator.

ColdFusion installation directory structure

By default, ColdFusion2023 is your installation directory. The following table describes the directory structure:

Using the built-in web server

ColdFusion provides in-built Tomcat application server that you can use to develop ColdFusion applications.

During the ColdFusion installation, choose a web server. If you select the built-in web server, your web root directory is located in the  cfroot / wwwroot  directory. By default, the web server runs on port 8500. It means that to display a page in your application, append:8500 to the host name or IP address in the URL; for example, http://localhost:8500/YourApp1/index.cfm. If the page does not appear, ensure that the document is located in the built-in web server's web root directory; for example, C:\ColdFusion2023\cfusion\wwwroot\YourApp1\index.cfm.

If you select an external web server during installation, the built-in web server is deactivated.

Change the port of the built-in web server

1. Back up the server.xml file. This file is in the cfroot\cfusion\runtime\conf directory.
2. Open the original server.xml file for editing.

3. Search for internal webserver start.Update the port number.

4. Save the file and then restart ColdFusion.

Configuring the built-in web server (Tomcat)

While installing, if you have configured ColdFusion on an external web server, do the following to configure ColdFusion on in-built Tomcat:

1. Open the cfroot\cfusion\runtime\conf\server.xml file.

2. Search for internal webserver start.Uncomment the following connector XML.

Save the file, and then restart ColdFusion.

To enable OS Symbolic links after switching to Tomcat, edit the context.xml file found in /cfusion/runtime/conf/ to add allowLinking="true" attribute to the context element.

Starting, stopping, and restarting ColdFusion

On Windows

At prompt, go to the directory cfroot\cfusion\bin and run the following command: coldfusion.exe -start -console. To stop ColdFusion, use the command coldfusion.exe -stop -console. To restart, use the command coldfusion.exe -restart -console.Alternatively, you could also start, stop, and restart ColdFusion server using Windows Services.

On UNIX/Linux/Solaris/MAC OSX

At prompt, go to the directory cfroot\cfusion\bin and run the following command: ./coldfusion start}}To stop ColdFusion, use the command ./{{coldfusion stop. }}To restart, use the command {{./coldfusion restart.

Editing the JVM settings

To edit the JVM settings, open the cfroot\cfusion\bin\jvm.config file and update the following details:

• java.home: Java home. If not set, ColdFusion verifies the default JRE in the cfroot\jre folder, in the registry, or in the J{{AVA_HOME}} environment variable.
• java.args: Settings for -Xmx, ColdFusion classpath, and so on.
• java.library.path: Settings for library path.
• java.class.path: Additional classpath settings in a comma-separated list.
• application.home: Default is cfroot\cfusion

Creating and editing a new ColdFusion instance

After installing ColdFusion in stand-alone mode, create an instance of ColdFusion using the ColdFusion Administrator.

1. In the ColdFusion Administrator, go to Enterprise Manager > Instance Manager.
2. Click Add New Instance.
3. Enter the server name and server directory.
4. (Optional) Check Create Windows Service.
5. Click Submit. In the Instance Manager, start, stop, restart, delete, access website, or access administrator.
6. Click the Edit icon to edit the instance manager.
7. Edit the internal webserver port and load balancing factor.Load balancing factor represents the load the instance takes up. Load balancing factor is applicable only if the instance is part of the cluster. For example, the load balancing factor for the first instance is 1 and that of the second instance is 2. The second instance receives two times more requests.
8. Click Submit.

Registering a remote instance

Register a new remote instance of ColdFusion using the ColdFusion Administrator.

1. In the ColdFusion Administrator, click Enterprise Manager > Instance Manager > Register Remote Instance.

2. Specify the details such as instance name, remote host, remote port, http port, and JVM route. Instance name is a string that is used to identify the instance. Remote port and HTTP port are displayed in the Instance Manager page. These ports are provided in the server.xml file available in the runtime\conf folder of the instance. Remote port is the AJP port and the instance port is the connector port.JVM route is the remote instance name. The JVM route is an attribute that acts as an identifier for a particular Tomcat worker. JVM route is provided in the server.xml file available in the runtime\conf folder of the instance. For more information on JVM route, see http://tomcat.apache.org/tomcat-8.0-doc/cluster-howto.html.

3. If you want remote start and stop functionality over HTTP, enter Admin Component port, Admin Component user name, and Admin Component password. The default Admin Component port is 8985.

• In the remote host, open the ColdFusion_installtion\cfusion\jetty\etc\jetty.xml.
• Search for the string, org.mortbay.jetty.bio.SocketConnector.
• Update the host with the IP address of the remote host.
• Restart the jetty server.

4. Click Submit.

Adding start and stop functionality to a remote instance over HTTPS

You can start and stop a remote instance over HTTPS or HTTP. To enable this feature, install admin component while installing ColdFusion. You can install Solr, admin component, or both while installing ColdFusion.

1. Do the following in the remote host.
   1. In the remote host, generate a private key in a keystore file. Provide the details at prompt.

                b. Export the certificate. You can have a self-signed certificate or a certificate from a                               Certificate Authority.

                c. Copy the jks file created in the jetty\etc directory.
                d. Open the jetty\etc\jetty.xml file.
                e. Search for the string, To add an HTTPS SSL Listenerand add the following entry:

                f. Update the keystore name, password, key password, and jks file in the entry.
                g. Search for the string org.mortbay.jetty.bio.SocketConnector.
                h. Update the host with the IP address of the remote host.
                i. Restart the jetty server.

2. Do the following in the local host from where you add the remote instance:
   1. Copy the .cer file created in the remote host to any of the locations.
   2. Import the certificate.

                c. Register the remote instance using the ColdFusion Administrator. For more information,                       see Registering a remote instance section in this document.

                d. In the Register Remote Instance page, enter the admin component port, admin                     component user name, and admin component password (user name and                     password. These details you specified while installing the Remote Instance                     Administrator). The default https port is 8443.

                e. Select the HTTPS check box.

                f. Click Submit.

Setting up remote start and stop functionality using HTTPS in Server Manager

You can set up start and stop remote instance functionality in Server Manager. To enable this feature, install Remote Instance Administrator while installing ColdFusion.

1. Do the following in the remote host.

   1. In the remote host, generate a private key in a keystore file. Provide the details at prompt.

                b. Export the certificate. You can have a self-signed certificate or a certificate from a                               Certificate Authority.

                c. Copy the .jks file created in the remote host to the jetty\etc directory.
                d. Open the jetty\etc\jetty.xml file.
                e. Search for the string, To add a HTTPS SSL Listenerand then add the following entry:

                f. Update the keystore name, password, key password, and jks file in the entry.
                g. Search for the string, org.mortbay.jetty.bio.SocketConnector.
                h. Update the host with the port number of the remote host.
                i. Restart the jetty server.

2. Do the following in the local host from where you add remote instance:
   1. Copy the .cer file created in the remote host to any of the locations.
   2. Import the certificate.

3. Open wwwroot\CFIDE\ServerManager\ServerManager.air on the local host.
4. Specify the connection details.
5. Click Start/Stop Details.
6. Select HTTPS.
7. Provide the following information:
   • App Server Username: User name for the admin component that you specified while installing ColdFusion.  Default  value is  admin .
   • App Server Password: Password for the admin component.
   • Port: ColdFusion remote instances HTTPS port.
   • Server: ColdFusion remote instance name.
   • ColdFusion Version: For 2023 version of ColdFusion.
   • Admin Server Port: Default https port is 8443. Port of the Jetty server.
   • Context Root: Value is AdminServlet.
8. Click Apply.

Setting up remote start and stop functionality using HTTP in Server Manager

You can set up start and stop remote instance functionality in Server Manager. To enable this feature, install Remote Instance Administrator while installing ColdFusion.

1. Do the following in the remote host:
   1. In the remote host, open the ColdFusion_installation\cfusion\jetty\etc\jetty.xml.
   2. Search for the string, org.mortbay.jetty.bio.SocketConnector.
   3. Update the host with the IP address of the remote host.
   4. Start the jetty server. Go to the ColdFusion_installation\cfusion\jetty directory and use jetty.exe. You can also use the jetty services in the Windows services.
2. Open wwwroot\CFIDE\ServerManager\ServerManager.air on the local host.
3. Specify the connection details.
4. Click Start / Stop Details.
5. Select HTTP.
6. Provide the following information:
   • App Server Username: Username for the admin component that you specified while installing ColdFusion. The default value is  admin .
   • App Server Password: Password for the admin component.
   • Port: ColdFusion remote instance's HTTP port.
   • Server: ColdFusion remote instance name.
   • ColdFusion Version: For ColdFusion (2023 release), the value 2023.
   • Admin Server Port: Default https port is 8985. Port of the Jetty server.
   • Context Root: Value is AdminServlet.
7. Click Apply.

Managing clusters

1. In the ColdFusion Administrator, click Enterprise Manager > Cluster Manager.
2. Enter a cluster name and then click Add.
3. Click the cluster name and move the servers to the cluster based on the requirement.
4. (If necessary) Edit the multicast port. Multicast port is used to group the cluster members together. Default value of multicast port is 45564. After you create a cluster, the port is added in the cfroot\config\cluster.xml file. For more information on multicast port, see http://tomcat.apache.org/tomcat-8.0-doc/config/cluster-membership.html.

5. Specify if you need sticky session.Sticky session ensures that after a session is established on an instance, all future requests from the client are mapped to that instance.
   Click Submit.

Adding a remote instance to a cluster

To add a remote instance to a cluster, add the cluster block to the remote instance's server.xml. Then, register the remote instance and add the instance to the cluster. For more information on configuring clusters on Tomcat, see http://tomcat.apache.org/tomcat-8.0-doc/cluster-howto.html.

1. Register the remote instance to the local machine.
2. Create a cluster in the local machine.
3. Open the cfroot_instance-name_runtime\conf\server.xml file of the remote instance.

4. Add the following block between the entries </host> }}and {{</engine>:

5. In the entry, update the membership port with the multicast port of the cluster.

6. Using the ColdFusion Administrator of the local host, add the local instance and the remote instance to the cluster.

7. Restart all the instances.

Configuring other web servers

Use the Web Server Configuration Tool to configure other web servers.

1. Run cfroot\runtime\bin\wsconfig.exe.
   You can also configure web servers using the command-line interface as follows.
   Configuring IIS

or

Configuring cluster

Configuring Apache

or

Configuring cluster

Unconfiguring IIS

or

Unconfiguring Apache

or

Unconfiguring all webservers

Seeing the list of webservers

Configuring Secured Socket Layer (SSL)

SSL allows the browser and the server to communicate over a secured connection. Data that is sent is encrypted at one side, transmitted, and then decrypted at the other end. For more information about SSL configuration on Tomcat, see http://tomcat.apache.org/tomcat-8.0-doc/ssl-howto.html.

To configure SSL for ColdFusion using the keytool utility, do the following:

1. Create a certificate file:
   1. Run the following command:cfroot\jre\bin\keytool -genkey -alias tomcat -keyalg RSA

   2. Type the details as per the instruction.

      If you do not provide a password, the default password for keystore and key is changeit. If you don't want to use the default password, ensure that you provide the same password for the keystore and the key.

      Running this command creates a certificate.keystore in the following location:

   • Windows: C:\Documents and Settings_user's_director_y
   • Linux: usr/home
2. Open the cfroot\cfusion\runtime\conf\server.xml file and search for the string Define a SSLHTTP/1.1.

3. Uncomment the connector details and update the section as follows:

4. Restart ColdFusion.
5. Access ColdFusion using the following URL: https://<ip-address>:8443/CFIDE/administrator

Changing virtual directory and the doc root

Do the following to change the virtual directory and doc root:

1. Open CFInstallation\cfusion\runtime\conf\server.xml.
2. Under host block, search for the string, "To add virtual directory."
3. Uncomment the entry context path below.
4. To add a virtual directory, add the aliases attribute as shown below:

To change the doc root, change the docBase value in the above entry. For more details on the Context attributes, see http://tomcat.apache.org/tomcat-8.0-doc/config/context.html.

Changing the connector port for cfstat

You can use the connector output for logging cfstat metric. The cfconnector port is defined in the CFInstallation/cfusion/lib/neo-metric.xml file. If you have configured a connector, update the port with the connector port. The connector port (AJP port) is provided in the CFInstallation/cfusion/runtime/conf/server.xml.
To update the connector port using the Administrator console:

1. Login ColdFusion Administrator.
2. Click Debugging & Logging > Debug Output.
3. Update the connector port and click Submit Changes.

Enabling Search Engine Safe URLs

Search Engine Safe URL (SES) helps the search engines to index dynamic web pages. SES URLs pass parameters using slashes instead of default URL pattern. By default, SES is enabled for stand-alone installation of ColdFusion on Tomcat.

To enable SES URLs on an app server other than Tomcat, add the tags mentioned below to the web.xml file present inside WEB-INF.

This is applicable from ColdFusion 11 Update 12 and ColdFusion (2016 release) Updates 3 and 4.

Enabling Secure Profile

ColdFusion allows you to secure ColdFusion server furthermore by enabling or disabling certain settings. When installing ColdFusion, you can enable Secure Profile by selecting the option when prompted on the Secure Profile screen. Further, you could provide a comma separate list of IP addresses that may be allowed to access the ColdFusion Administrator. In ColdFusion, IP address restriction is supported at the connector-level. For more information, see this document.

Changing the log rotation settings

You can change the log rotation settings such as maximum number of backup files and the size of the backup files.

1. Specify log file settings in the neo-logging.xml, located in the <ColdFusion_Home>\lib directory.
2. The size of coldfusion-out.log and coldfusion-error.log is set to 20MB by default. You can change the size of the log in the neo-logging.xml file by changing the maxOutLogSize setting.
3. You can also change the maximum number of backups of coldfusion-out.log and coldfusion-error.log that ColdFusion takes during log rotation within the neo-logging.xml file. Change the maxOutFileBackup setting.

You can change the settings of the remaining files in the ColdFusion Administrator by going to the Debugging and Logging > Logging Settings section. Change the Maximum file size and Maximum number of Archives settings accordingly.

Enabling persistent session

To persist a session after a Tomcat restart, do the following:

1. Open the cfroot\cfusion\runtime\conf\context.xml file.

Uncomment the Manager pathname node.

Updating from an earlier version

If you have skipped the migration or you have to make modifications to the previous installation that has to be migrated, do the following:

1. Stop the server.
2. Create a folder named cfXsettings (in which X is the earlier version of ColdFusion) in cf_webapp_new_installation_root_directory/cfusion/lib. For example, name the folder cf2016settings.
3. Save settings by copying the files cf_webapp_root/WEB-INF/cfusion/lib/neo-*.xml (of previous installation) to cfXsettings.
4. Edit the ColdFusion cfusion/lib/adminconfig.xml file by setting the value of the  runmigrationwizard  and the {{migratecf}}X (in which X is the earlier version of ColdFusion) switch to true.
5. Restart the ColdFusion application.
6. To run the migration wizard, launch ColdFusion Administrator.

Uninstalling ColdFusion

Uninstalling ColdFusion deletes all program files and related components from your computer.

Uninstall ColdFusion from Windows

1. Select Start > Settings > Control Panel > Add/Remove Programs > Adobe ColdFusion 2023.
2. Click Change/Remove.
3. When the program completes, remove any remaining files and directories in the cf_root directory.

Uninstall ColdFusion from UNIX

1. Log in as root.

2. To go to the cf_root/uninstall directory, enter the following command:

3. Enter the following command:

4. When the program completes, remove any remaining files and directories in the cf_root directory. ColdFusion is deleted from your server.