Geneos - How do I fix Web Dashboard startup issues after version upgrade?

For Default Users

If user did not have customization to the startup script prior the upgrade, they are suggested to use the copy that comes as default in the Web Server download. Users should follow the Running Start Scripts section in the Web Dashboard documentation.

For those using the PS Templates

If user is using the previous "webserverctl" script from an ITRS Professional Services implementation, please note that the older package has been deprecated. Clients are encouraged moving to "cordial" which is available at this location:
https://github.com/ITRS-Group/cordial

Users can perform the change as an inhouse project, and they may consider engaging our ITRS Professional Service team for the deployment and other services.

For those using a Custom Script

Users are advised to check the "run" and "geneows" scripts in the Web Server installation package, and apply the changes to their custom script accordingly. Here we have prepared a list of changes as of this writing.

• GA4.3.0 and above: SSO_PROPERTIES flag
• GA4.12.0 and above: library files have been moved from lib to lib64 directory (ensure LD_LIBRARY_PATH and JAVA_LIBRARY_PATH is updated).
• GA5.1.1 and above: added EXTRACTED_WAR_DIR and MAX_THREADS variables, LOG_PROPERTIES is now pointing to log4j2.properties. Has changed from:

  LOG_PROPERTIES="-Dlog4j.configuration=file:${SCRIPTPATH}/config/log4j.properties" 

  to

  LOG_PROPERTIES="-Dlog4j2.configurationFile=file:${SCRIPTPATH}/config/log4j2.properties"

• GA5.2.1 and above: SSO_PROPERTIES variables has added pointers to login.conf and krb5.conf
• GA7.0.0 and above: VALID_HOST_HEADER needs to be set as below if not present

  VALID_HOST_HEADER
           Command="${Command} -Dvalid.host.header=.*"

1. Add variable definitions in the script header as appropriate

e.g.
SECURITY_CONFIG="-DsecurityConfig=${SCRIPTPATH}/config/security.xml"
#ENABLE_SSL="-ssl true"
SSO_PROPERTIES="-Dcom.itrsgroup.sso.config.file=${SCRIPTPATH}/config/sso.properties -Djava.security.auth.login.config=${SCRIPTPATH}/config/login.conf -Djava.security.krb5.conf=/etc/krb5.conf"

2. Reference the variables in the start JVM command. Below command is taken from version GA5.11.3 as an example. (Please check the actual version of Web Server for the "geneosws" script.)

e.g.

GWS_RUN_CMD="$JRE_BIN_PATH/java -XX:+UseConcMarkSweepGC -Xmx1024M -server $EXTRACTED_WAR_DIR $HEADLESS $SECURITY_CONFIG $CONFIG $DASHBOARDS_DIR $RESOURCES $JAVA_LIBRARY_PATH $LOG_PROPERTIES $PATH_FOR_LOG4J $JAVA_PROPS $SSO_PROPERTIES $BDO_FLAGS $JMX_FLAGS $VALID_HOST_HEADER $DUMP_HEAP_ARGS $JAR_PATH $GWS_PORT $WEBAPPS $GWS_PORT $ENABLE_SSL $MAX_THREADS &"

3. Verify security.xml is correct

• Ensure that security.xml contains a valid path to the users.properties file
• If upgrading to version GA5.8.x or higher, use the updated security.xml file in the Web Server config folder. This new version updates the Spring Security libraries from:
  

  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
  http://www.springframework.org/schema/security http://www.springframework.org/schema/security/spring-security-4.2.xsd"

  
  to 
  

  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
  http://www.springframework.org/schema/security http://www.springframework.org/schema/security/spring-security.xsd"

4. Restart the Web Server process

Further Reading

Users can check out the Web Dashboard documentation.