Note

This documentation is for the new OMERO 5.1. version. See the latest OMERO 5.0.x version or the previous versions page to find documentation for the OMERO version you are using if you have not upgraded yet.

Properties

Under the etc/ directory in both the source and the binary distributions, several files are provided which help to configure OMERO.server:

etc/omero.properties             - Our central configuration file with all defaults.
etc/hibernate.properties         - Required by Hibernate since some properties are only configurable
                                   via a classpath:hibernate.properties file.
etc/logback.xml                  - Logging configuration
etc/local.properties.example     - The properties that you will most likely want to change.
                                   This file can be copied to etc/local.properties to being, or
                                   alternatively you can run "java omero setup"
                                   (Name will change to "…default")
etc/local.properties             - Local overrides for other properties (used by build only)

The most useful of the properties are listed in a glossary.

During the build, these files get stored in the blitz.jar and are read-only. On creation of an OmeroContext, the lookup for properties is (first wins):

• Properties passed into the constructor (if none, then the default properties in config.xml)
• System.properties set via “java -Dproperty=value”
• Configuration files in order listed.

This ordering is defined for the various components via “placeholder configurers” in:

• components/server/resources/ome/services/services.xml

Once configured at start, all values declared in one of the mentioned ways can be used in Spring configurations via the syntax:

<bean id=…>
  <property name="mySetter" value="${property.name}"/>
</bean>