| title | description | author | ms.date | ms.author |
|---|---|---|---|---|
CycleServer Configuration Reference | Configuration reference for cycle_server.properties file | atomic-penguin | 03/28/2025 | erwolfe |
CycleCloud uses the cycle_server.properties file, located under the /opt/cycle_server/config/ directory on Linux systems, to pass the configuration parameters to the CycleServer application and Tomcat application server. The most common reason for updating this file is to configure SSL for the application server. For more information, see the SSL Configuration How-to Guide.
Important
When editing the cycle_server.properties file, first look for preexisting key-value definitions. If the file contains more than one definition, the last one is in effect.
| Setting | Type | Description | Default value |
|---|---|---|---|
| webServerMaxHeapSize | String | This setting specifies the JVM maximum heap size for the application server. CycleServer chooses platform specific defaults if you leave this setting blank. | Linux: 4096M; Windows: 2048M |
| webServerJvmOptions | String | Use this setting for any user configurable JVM settings for the application server. CycleServer appends its default JVM settings regardless of user settings. | Appended Defaults: -Djava.net.preferIPv4Stack=true -Djava.net.preferIPv4Addresses=true -XX:+HeapDumpOnOutOfMemoryError -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true' |
| webServerHostname | String | Provides a static route from cluster nodes to the CycleServer when there are multiple interfaces attached to the CycleServer instance. This value should be a hostname or IP address assigned to the CycleServer and reachable from cluster nodes. | Unset |
| webServerPort | Integer | HTTP listen port for application server | 8080 |
| webServerSslPort | Integer | HTTPS listen port for application server | 8443 |
| webServerClusterPort | Integer | Dedicated listen port for node clusters to communicate with CycleServer. | 9443 |
| webServerContextPath | String | Root context for application server. For instance, if set to /cycle_server, the effective CycleServer URI is http://localhost:8080/cycle_server. | / |
| webServerEnableHttp | Boolean | Enable HTTP listen port. | true |
| webServerEnableHttps | Boolean | Enable HTTPS listen port. | false |
| webServerRedirectHttp | Boolean | If both HTTPS and HTTP are enabled, controls whether HTTP redirects to HTTPS. | true |
| sslEnabledProtocols | String | List of + separated TLS protocols to allow, such as, TLSv1.2+TLSv1.3 | TLSv1.3 |
| brokerMaxHeapSize | String | This setting is a JVM maximum heap size setting for the message queue broker. | Linux: 1024M; Windows: 512M |
| brokerJvmOptions | String | Provide any user configurable JVM settings for the message queue broker. CycleServer only appends the message broker heap size and port options. | None |
| brokerPort | Integer | Listen port for the message queue broker. | 5672 |
| brokerJmxPort | Integer | Listen port for Java Management Extensions access to the message queue broker. | 9099 |
| brokerRmiPort | Integer | Listen port for remote method invocation for the message queue broker. | automatically assigned unused port |
| commandPort | Integer | Listen port for CycleServer administrative commands. | 6400 |
| tomcat.shutdownPort | Integer | The listen port to listen for Tomcat shutdown commands. | 8007 |
