3.4 Modifying the JBoss run.conf file

Modify the JBoss run file of each JBoss Application Server instance in the LiveCycle cluster to add LiveCycle options.

Before you start this procedure, determine how your LiveCycle cluster implements cluster caching so that you can correctly configure an argument for cluster caching. You can implement cluster caching by using either TCP or UDP, but not both. The following factors may affect your choice:

(Recommended) Use TCP if your cluster is either IPv4-based or IPv6-based. On an IPv6-based cluster, you must use TCP to be IPv6-compliant.

If you implement cluster caching by using TCP, also ensure that you configure the TCP locators correctly. (See “Configuring the caching locators (caching using TCP only)” .)
Option to use UDP is available only for IPv4 based cluster.

It is recommended to use TCP instead of UDP multicasting for production systems because of the inherent reliability of the TCP protocol.

To modify the JBoss run file:

Open the following file in a text editor:
- (Windows) [appserver root]/bin/run.conf.bat
- (UNIX) [appserver root]/bin/run.conf
In the JAVA_OPTS line, add or change the following argument:
```
-Djboss.partition.name=<partition_name>
```
Note: The value for <partition_name> can be any value that is unique to your LiveCycle cluster. Configure the same <partition_name> value on every node of the LiveCycle cluster, as in this example:
```
-Djboss.partition.name=livecycle_cluster
```
Note: You can also pass this value while starting JBoss server. The value should be same for all nodes in the JBoss cluster. The value should be passed either as a JVM argument or command line argument '-g <partition_name>.
In the JAVA_OPTS line, add or change the following argument:
```
-Dadobeidp.serverName=<server name>
```
Note: The value for <server name> can be any value; however, you must configure a unique <server name> value for each node of the LiveCycle cluster, as in this example:
- On one node of the cluster, configure the -Dadobeidp.serverName=server1 argument
- On another node of the cluster, configure the -Dadobeidp.serverName=server2 argument.
You can configure additional nodes for the LiveCycle cluster in a similar manner but with unique <server name> values.
In the JAVA_OPTS line, the following argument might already be set for IPv4. If not, then set the agrument:
```
-Djava.net.preferIPv4Stack=true
```
For IPv6, Remove -Djava.net.preferIPv4Stack=true and add the following arguments:
```
-Djava.net.preferIPv6Addresses=true 
-Djava.net.preferIPv6Stack=true 
```
Configure a JVM argument for cluster caching. In the JAVA_OPTS line, add or change one of the following arguments:
- (Caching using UDP only) Configure the multicast port argument in the following format:
```
-Dadobe.cache.multicast-port=<port number>
```
  Note: The value for <port number> can be any available port between 1025 and 65535. The multicast port must be unique to the LiveCycle cluster (that is, the port must not be used by any other cluster on the same network, any attempt to use the same port by any other cluster on the same network would result in bootstrap failure). It is recommended that you configure the same <port number> on all nodes in the LiveCycle cluster, as in this example:
```
-Dadobe.cache.multicast-port=33456
```
- (Caching using UDP discovery) Setting multicast address argument is optional. Default muticast addresses for IPv4 and IPv6 are as following:
```
IPv6 - FF38::1234 
IPv4 - 239.192.81.1
```
  If you have restriction on multicast addresses in your network, use following argument to set multicast addresses:
```
-Dadobe.cache.multicast-address=<ip address>
```
  The value for <ip address> is the IP address used for multicast networking. The IP address is ignored if adobe.cache.multicast-port is zero.
  
  The multicast address must be unique to the LiveCycle cluster and must not be used by any other cluster on the same network. It is recommended that you configure the same <ip address> on all nodes in the LiveCycle cluster. For example:
```
-Dadobe.cache.multicast-address=239.192.81.1
```
- (Caching using TCP only) For IPv4, configure the cluster locators argument in the following format:
```
-Dadobe.cache.cluster-locators=<IPaddress>[<port number>],<IPaddress> [<port number>]
```
  For IPv6, configure the cluster locators argument in the following format:
```
-Dadobe.cache.cluster-locators=<hostname>@<IPv6 address>[<port number>],<hostname>@<IPv6 address>[<port number>]
```
  Note: Configure, as a comma-separated list, the locators for all nodes of the cluster. The value for <IPaddress> is the IP address of the computer that is running the locator. The value for <port number> is any unused port between 1025 and 65535. It is recommended that you configure the same <port number> on all nodes in the LiveCycle cluster, as in this example:
```
-Dadobe.cache.cluster-locators=10.20.30.5[22345],10.20.30.6[22345]
```
- For machines with multiple Network Interfaces
  
  Some machines may be connected to multiple networks via multiple Network Interface Cards (NICs). For such machines, set the JVM property -Dadobe.cache.bind-address to the IP address of the network interface card that you are using for LiveCycle Server.
```
-Dadobe.cache.bind-address=<IP Address>
```
  Note: It is recommended to set JVM property -Dadobe.cache.bind-address for machines with one Network Interface Card, also.
- To prevent application server from Denial of Service attacks configure the following JVM argument:
```
-DentityExpansionLimit=10000
```
Save the edited file.
Repeat steps 1 to 6 for each node in the cluster.