Using the command-line interface

You can also run the Web Server Configuration Tool through a command-line interface. To run the command-line interface, open a console window, change to the cf_root/runtime/lib (server configuration) or jrun_root/lib (J2EE configuration with JRun) directory, and use the following command-line syntax:

java_home/bin/java -jar wsconfig.jar [-options]

The following table lists the options:

Option	Description
-ws	Specifies the web server, as follows: IIS Apache NES iPlanet
-dir	Path to the configuration directory (Apache conf or NES/iPlanet config)
-site	Specifies the IIS website name. Specify All or 0 to configure the connector at a global level, which applies to all IIS websites.
-host	Specifies the ColdFusion server address. The default is localhost.
-server	Specifies the ColdFusion server name. The default is default.
-username	Specifies a username defined to the JRun server.The default is guest account.
-password	Specifies a password that corresponds to `-username`. The default is guest account.
-norestart	Do not restart the web server.
-cluster	Specifies the JRun cluster name. Use this option to define a connection to a JRun cluster instead of a single server.
-l	Enables verbose logging for the connector.
-a	Enables native OS memory allocation.
-s	Enables SSL between the connector and JRun server.
`-map` `.cfm,.cfc,.cfml,.jsp,.jws`	Specifies the extension mappings list (to use the webserver connector with ColdFusion MX, you should specify .cfm,.cfc,.cfml,.jsp,.jws)
-filter-prefix-only	Sets ignoresuffixmap=true in the jrun.ini file. This means that the connector module runs as an IIS extension. (IIS only).
-coldfusion	In conjunction with `-upgrade`, forces the replace of the connector module regardless of version or date stamp and starts the web server if it is down. Always use this option when configuring a web server for use with ColdFusion MX.
-upgrade	Upgrades existing configured connectors with newer modules from a newer wsconfig.jar.
-service	Specifies the Apache Windows service name. The default is Apache.
-bin	Path to Apache server binary file (apache.exe in Windows, httpd on Unix).
-script	Path to Apache UNIX control script file (apachectl, slightly different with certain Apache variants, such as Stronghold).
-v	Enables verbose output from the Web Server Configuration Tool.
-list	Lists all configured web servers.
-list -host server-host	Lists all JRun servers on the specified host.
-remove	Removes a configuration. Requires `-ws` and either `-dir` or `-site`.
-uninstall	Uninstalls all configured connectors.
-h	Lists all parameters.

Option

Description

-ws

Specifies the web server, as follows:

IIS
Apache
NES
iPlanet

-dir

Path to the configuration directory (Apache conf or NES/iPlanet config)

-site

Specifies the IIS website name. Specify All or 0 to configure the connector at a global level, which applies to all IIS websites.

-host

Specifies the ColdFusion server address. The default is localhost.

-server

Specifies the ColdFusion server name. The default is default.

-username

Specifies a username defined to the JRun server.The default is guest account.

-password

Specifies a password that corresponds to -username. The default is guest account.

-norestart

Do not restart the web server.

-cluster

Specifies the JRun cluster name. Use this option to define a connection to a JRun cluster instead of a single server.

-l

Enables verbose logging for the connector.

-a

Enables native OS memory allocation.

-s

Enables SSL between the connector and JRun server.

-map .cfm,.cfc,.cfml,.jsp,.jws

Specifies the extension mappings list (to use the webserver connector with ColdFusion MX, you should specify .cfm,.cfc,.cfml,.jsp,.jws)

-filter-prefix-only

Sets ignoresuffixmap=true in the jrun.ini file. This means that the connector module runs as an IIS extension. (IIS only).

-coldfusion

In conjunction with -upgrade, forces the replace of the connector module regardless of version or date stamp and starts the web server if it is down. Always use this option when configuring a web server for use with ColdFusion MX.

-upgrade

Upgrades existing configured connectors with newer modules from a newer wsconfig.jar.

-service

Specifies the Apache Windows service name. The default is Apache.

-bin

Path to Apache server binary file (apache.exe in Windows, httpd on Unix).

-script

Path to Apache UNIX control script file (apachectl, slightly different with certain Apache variants, such as Stronghold).

-v

Enables verbose output from the Web Server Configuration Tool.

-list

Lists all configured web servers.

-list -host server-host

Lists all JRun servers on the specified host.

-remove

Removes a configuration. Requires -ws and either -dir or -site.

-uninstall

Uninstalls all configured connectors.

-h

Lists all parameters.

Using the batch files and shell scripts

ColdFusion MX ships with batch files and shell scripts that implement typical command-line connector configurations. These files are in cf_root/bin/connectors. For example, IIS_connector.bat configures all sites in IIS to site 0, which establishes a globally defined connector so that all sites inherit the filter and mappings.

If you use Apache or iPlanet, use these files as prototypes, editing and saving them, as appropriate for your site.

Command-line interface examples

This section provides examples of multiple use-cases for different web servers:

Configure a specific IIS site:

java_home/bin/java -jar wsconfig.jar -ws iis -site "web31" -filter-prefix-
only -map .cfm,.cfc,.cfml,.jsp,.jws -coldfusion -v

On systems where all sites are .cfm, there is generally no need to configure an individual site.

Configure all existing IIS sites: (ISPs):

java_home/bin/java -jar wsconfig.jar -ws iis -site 0 -filter-prefix-only 

-map .cfm,.cfc,.cfml,.jsp,.jws -coldfusion -v

This does not automatically configure newly added sites after the first "-site 0" run but you can rerun with "-site 0" at a later time and the Web Server Configuration Tool configures new sites only.

Netscape on UNIX:

java_home/bin/java -jar /opt/coldfusionmx/runtime/lib/wsconfig.jar -ws nes 

-dir [path to config] -map .cfm,.cfc,.cfml,.jsp,.jws -coldfusion -v

SunOne Web Server on UNIX:

java_home/bin/java -jar /opt/coldfusionmx/runtime/lib/wsconfig.jar -ws 
iplanet -dir [path to config] -map .cfm,.cfc,.cfml,.jsp,.jws -coldfusion 

-v

Apache on UNIX:

java_home/bin/java -jar /opt/coldfusionmx/runtime/lib/wsconfig.jar -ws 
Apache -bin /opt/apache2/bin/httpd -script /opt/apache2/bin/apachectl -dir 
/opt/apache2/conf -map .cfm,.cfc,.cfml,.jsp,.jws -coldfusion -v

Apache in Windows:

java_home/bin/java -jar wsconfig.jar  -ws apache -dir 
"c:\program files\apache group\apache2\conf" -map 
.cfm,.cfc,.cfml,.jsp,.jws -coldfusion -v

Version 6.1

Comments are no longer accepted for ColdFusion MX 6.1. ColdFusion 8 is the current version.

Comments

jrunrandy said on Nov 11, 2003 at 7:19 AM :

The .jws mapping is a feature of JRun web services. For more information, see http://livedocs.macromedia.com/jrun/4/Programmers_Guide/wspublish2.htm

tomp said on Oct 11, 2004 at 5:01 AM :

For IIS, the site name (-site) can be obtained by running java -jar wsconfig.jar -list

This generates a list of all sites running togather with their instance numbers. The site name for this command is actually the number and not the name.

You will also need to apply the -server parameter if you have more than one host server instance which is almost certainly going to be the case if you're using this tool.

To get the server name, run the list command above, but add -host localhost

This will list the server instances. When you come to configure the site, append -server nameofCFserverinstance

You will also need this parameter if using -remove

Also consider using the -norestart parameter as otherwise all your websites will restart. You can then manually restart anything you need to.

Current page: http://livedocs.adobe.com/coldfusion/6.1/htmldocs/websera7.htm


Contents > Configuring and Administering ColdFusion MX > Web Server Management > Web server configuration > Using the command-line interface