...
Beginning with version 4.0.10, uPortal provides an optional mechanism to override these settings with a file that is completely outside uPortal source, the build/deploy system, and even Tomcat. This approach allows systems administrators to change these settings without rebuilding. It also provides an easy way for adopters to keep sensitive information outside of their Source Code Management system.
There are 2 options for properties overrides
${CATALINA_HOME}/portal/overrides.properties
${PORTAL_HOME}/overrides.properties
The first of these (#1) The properties files may be stored relative to CATALINA_HOME or PORTAL_HOME.
The CATALINA_HOME location is a canonical location approach: simply create a a portal/
directory directory within your Tomcat root (CATALINA_HOME
) and place a file named named overrides.properties or uPortal_overrides.properties
within within it. Use this option if this location works for you.
The second approach (#2) PORTAL_HOME location is more flexible. For this option, place the the overrides.properties
or uPortal_overrides.properties
file file anywhere you want, then set PORTAL_HOME as an environment variable or pass it as a JVM argument (e.g. -DPORTAL_HOME=/my/chosen/location
).
In either case, you choose which properties to override. As the name suggests, values in in overrides.properties
will will trump (override) values set elsewhere.
There are 2 options for properties overrides:
Option 1: overrides.properties (also used by portlets)
${CATALINA_HOME}/portal/overrides.properties
${PORTAL_HOME}/overrides.properties
Note |
---|
Option 1 (overrides.properties) should be used for properties such as database connection values that the portlets could also use since they may load those property files. See the section 'Portlet Properties Overrides recommendation' below. If you are security conscious (running some untrusted portlets) and you have values for some reason you don't want portlets to have access to or the property name value conflicts with values used by a portlet, store the values in uPortal_overrides.properties. |
new with uPortal 4.3.0: Option 2: uPortal_overrides.properties
${CATALINA_HOME}/portal/uPortal_overrides.properties
${PORTAL_HOME}/uPortal_overrides.properties
Portlet Properties Overrides recommendation
Though not required, it's recommended that portlets load property override values using the following locations. This allows portlets to share property values with each other and with uPortal, in particular the Hibernate DB connection property values. See
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
${CATALINA_HOME}/portal/overrides.properties
${CATALINAPORTAL_HOME}/portal/{portletName}_overrides.properties
${PORTALCATALINA_HOME}/portal/{portletName}_overrides.properties
- ${PORTAL_HOME}/{portletName}_overrides.properties