Configuring WebCC with Custom Parameters on Windows

WebCC can run with no parameters, but it also provides some customization options. Among other things, you can change the port number, adjust its security settings and configure it to run with SSL security.

If you installed WebCC as a Windows service, you can customize its parameters by modifying the shell script that launches WebCC, which the Windows service launches. If you use Service Launcher to run WebCC, you can easily add parameters in the Other Parameters field of the WebCC tab of Service Launcher.

WebCC Parameters Table

The following is a table of parameters that can be specified to customize the behaviour of your WebCC server. They can be used in both the WebCC shell script and in Service Launcher.

Parameter Description
-numWorkers <number>

The amount of server nodes to launch to process client requests. Each node requires one CPU core, and a single node can only process one client request at a time. Therefore, the more nodes are launched, the less likely the server is to stall under heavy load.

If this parameter is not specified, WebCC will use as many nodes as there are cores on the CPU.

-noAuth Disables authentication. With this option enabled, any user accessing the WebCC web interface will be logged in as usabatch and will administrative privileges on the entire database.

-port <port number>

The port to which HarmonyWebCC is deployed. Default: 8080.
-http <port number>

If access through the https protocol is enabled, this option allows you to also allow access through the http protocol and specify its port.

-exchange <directory>

The location of the exchange directory on the local filesystem. This directory is where all packages are stored when exporting or importing scenes.

By default, this directory is /USA_DB/exchange.

-cacheDuration <seconds> The amount of seconds to keep data in the cache. This can be set to any value between 1 and 999999. By default, this is set to 3600.
-allowAllOrigin

Enables cross-origin resource sharing on the WebCC server.

By default, as a standard security measures, only files on the same server as the WebCC server are allowed to use WebCC. With this option enabled, it is possible to create web interfaces on other servers that use resources stored on the WebCC server, or to store different modules of WebCC on different servers and let them communicate together.

In most use cases, this option should be disabled to prevent other machines from exploiting resources on the WebCC server.

-disableAnalytics Disables Google Analytics tracking for all clients. By default, this is enabled.
Options for SSL
-https <port number> Enables connection to the server through the https protocol using the specified port number. The recommended port to use is 8443.
-key <key file> The location of the private key file for the SSL session. This must be specified along with the -cert parameter.
-cert <certificate file> The location of the security certificate file for the SSL session. This must be specified along with the -key parameter.
-pfx <pfx file>

The location of the personal information exchange (.pfx) certificate which provides both the private key and the security certificate for the SSL session.

It is not required to provide a key file and a certificate file if a .pfx certificate is provided.