Application Properties¶

GeoServer Property Reference¶

Setting Application property¶

Application properties are determined using the first value obtained from: Java System Properties, Web Application context parameters, or System Environmental Variable.

Using GEOSERVER_DATA_DIR as an example:

1. Java System Properties: Supplied to the java virtual machine as part of your application server configuration.

   -DGEOSERVER_DATA_DIR=/var/lib/geoserver_data
   

   • For Tomcat on Linux edit setenv.sh to append additional java system properties:

     # Append system properties
     CATALINA_OPTS="${CATALINA_OPTS} -DGEOSERVER_DATA_DIR=/var/lib/geoserver_data"
     

   • For Tomcat on Windows use Apache Tomcat Properties application, navigating to the Java tab to edit Java Options:

     -DGEOSERVER_DATA_DIR=C:\ProgramData\GeoServer\data
     

   While not commonly used for GEOSERVER_DATA_DIR, this approach is a popular way to enable/disable optional GeoServer functionality.

2. Web Application context parameter:

   • Tomcat: Use your application server to configure the GeoServer web application via conf/Catalina/localhost/geoserver.xml file:

     <Context docBase="geoserver.war">
       <Parameter name="GEOSERVER_DATA_DIR"
                  value="/var/opt/geoserver/data" override="false"/>
     </Context>
     

     Note

     Tomcat management of application properties as using override="false" is not the most straight forward to understand. This setting prevents parameter defined in WEB-INF/web.xml (from the geoserver.war ) to override the provided file location.

     Other application servers provide a user interface to manage web application properties and are more intuitive.

   • Not recommended: Hand editing the webapps/geoserver/WEB-INF/web.xml file:

     <context-param>
       <param-name>GEOSERVER_DATA_DIR</param-name>
       <param-value>/var/lib/geoserver_data</param-value>
     </context-param>
     

     Note

     This file is part of the GeoServer application and will be replaced when updating the application.

     As a result this approach is error prone making updates more difficult and is not recommended.

3. System environmental variable:

   export GEOSERVER_DATA_DIR=/var/lib/geoserver_data
   

   This approach can be useful for GEOSERVER_DATA_DIR when running GeoServer in a docker container, traditionally managed with environmental variables.

Additional system properties¶

Cascading WFS and WMS services where GeoServer acts as a client for another web service make use of the Apache Http Components HTTP client library.

The HTTP client library respects the following java system properties:

ssl.TrustManagerFactory.algorithm
javax.net.ssl.trustStoreType
javax.net.ssl.trustStore
javax.net.ssl.trustStoreProvider
javax.net.ssl.trustStorePassword
ssl.KeyManagerFactory.algorithm
javax.net.ssl.keyStoreType
javax.net.ssl.keyStore
javax.net.ssl.keyStoreProvider
javax.net.ssl.keyStorePassword
https.protocols
https.cipherSuites
http.proxyHost
http.proxyPort
https.proxyHost
https.proxyPort
http.nonProxyHosts
http.keepAlive
http.maxConnections
http.agent

Reference:

• HttpClientBuilder