Skip to content

Commit

Permalink
Merge pull request #2635 from bjagg/doc/changes
Browse files Browse the repository at this point in the history
doc: create init CHANGES.md
  • Loading branch information
loulou2u authored Feb 6, 2023
2 parents 7bda801 + 5b89e7a commit 2ab11be
Show file tree
Hide file tree
Showing 3 changed files with 204 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ Contributors guide: https://github.com/Jasig/uPortal/blob/master/CONTRIBUTING.md
- [ ] commit message follows [commit guidelines][]
- [ ] tests are included
- [ ] documentation is changed or added
- [ ] new security keys and comments added to `security.properties`
- [ ] new general keys and comments added to `portal.properties`
- [ ] any changes that impact configuration or the database DDL added to `CHANGES.md`
- [ ] [message properties][] have been updated with new phrases
- [ ] view conforms with [WCAG 2.0 AA][]

Expand Down
163 changes: 163 additions & 0 deletions docs/CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
## v5.14.0

- new properties, HTTP Security Headers in `security.properties`
```properties
##
## Tomcat HTTP Security Headers
##

# antiClickJackingEnabled: X-Frame-Options header
sec.anti.click.jacking.enabled=false
# X-Frame-Options: deny, sameorigin, allow-from
sec.anti.click.jacking.options=sameorigin
# If allow-from is selected above, add URI
sec.anti.click.jacking.uri=

# Content-Security-Policy: default-src, script-src, style-src, img-src
# See more details at: https://content-security-policy.com/
sec.content.sec.policy.enabled=false
sec.content.sec.policy=default-src 'self'

# Strict-Transport-Security: max-age=###; includeSubDomains; preload
sec.hsts.enabled=false
sec.hsts.maxage.seconds=31536000
sec.hsts.include.subdomains=true
sec.hsts.preload=false

# X-Content-Type-Options: "nosniff" will be used if enabled is set to true
sec.x.content.type.enabled=false

# Referrer-Policy available directives to pass include:
# See more details at: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy
sec.referrer.policy.enabled=false
sec.referrer.policy=no-referrer
```

v5.13.1
- N/A

v5.13.0 - Portlet List, Analytics Event
- new table, UP_PORTLET_LIST for PortletList.java in uPortal-api-rest module
- new table, UP_PORTLET_LIST_ITEM for PortletListItem.java in uPortal-api-rest module
- new property, events.analytics.log.level in `portal.properties`
```properties
##
## Configure which analytics events (e.g. link clicks) are saved based on the the following:
## - NONE - no events are recorded
## - AUTHENTICATED - only record events from known users
## - ALL - record events from all users, including guest/anonymous users
#events.analytics.log.level:NONE
```
- new property, org.apereo.portal.events.LoginEvent.captureUserIpAddresses in `portal.properties`
```properties
##
## Configure Login Events (raw) to capture user IP addresses. This is not included in aggregation.
## N.B. This raises privacy concerns and should only be enabled after very careful consideration.
org.apereo.portal.events.LoginEvent.captureUserIpAddresses=false
```

v5.12.0
- N/A

v5.11.1
- new property, org.apereo.portal.ehcache.filename in `portal.properties`
```properties
##
## Configure which file in the properties/ directory in the classpath for ehcache.
## This is often used to selected between the default ehcache.xml file with JGroups
## vs. the ehache-no-jgroups.xml file that has JGroups removed.
#
#org.apereo.portal.ehcache.filename:ehcache.xml
```

v5.11.0
- fixed table reference, UP_PORTLET_MDATA -> UP_PORTLET_DEF_MDATA for PortletLocalizationData.java in uPortal-content-portlet module

v5.10.0
- new properties, PersonalizationFilter in `portal.properties`
```properties
# Personalization
# ---------------
# Disabled by default
#
# org.apereo.portal.utils.web.PersonalizationFilter.enable=false

# `prefix` and `pattern` are combined to define how the placement tokens
# appear in the portlet-definitions, such as:
# `<desc>Bookmarks for @up@apereo.displayName@up@</desc>`
#
# org.apereo.portal.utils.personalize.PersonalizerImpl.prefix=apereo.
# org.apereo.portal.utils.personalize.PersonalizerImpl.pattern=@up@(.*?)@up@
```

v5.9.0
- new property, org.apereo.portal.portlet.worker.threadPool.queueSize in `portal.properties`
```properties
##
## Portlet worker thread pool queue max size
##
#org.apereo.portal.portlet.worker.threadPool.queueSize=0
```

v5.8.2
- replace property, cas.authenticationFilter.service with portal.allServerNames in `security.properties`
```properties
# All server names values for multi server name management, separator is a space
# This property should be set/overridden in PORTAL_HOME/uPortal.properties
# Example: portal1.univ.edu portal2.univ.edu
portal.allServerNames=${portal.server}
```
- new property, org.apereo.portal.index.relativePath in `portal.properties`
```properties
# Search Indexing
# ---------------
# Search indexing was introduced in v5.5.0. To disable indexing, uncomment
# and set the value of this property to "#{null}" (without double quotes)
#
#org.apereo.portal.index.relativePath=/WEB-INF/index
```

v5.8.1
- new cache, org.apereo.portal.groups.RDBMEntityGroupStore.search in `ehcache.xml`/`ehcache-no-jgroups.xml`
```xml
<!--
| Caches search results from searchForGroups() in RDBMEntityGroupStore.
| - 1 x search criteria
+-->
<cache name="org.apereo.portal.groups.RDBMEntityGroupStore.search"
eternal="false" maxElementsInMemory="500" overflowToDisk="false" diskPersistent="false"
timeToIdleSeconds="0" timeToLiveSeconds="300" memoryStoreEvictionPolicy="LRU" statistics="true" >
<cacheEventListenerFactory class="org.apereo.portal.utils.cache.SpringCacheEventListenerFactory" properties="beanName=insufficientSizeCacheEventListener" listenFor="local" />
</cache>
```

v5.8.0
- new property, cas.ticketValidationFilter.encodeServiceUrl in `security.properties`
```properties
## Some CAS servers, like the CAS server in uPortal-start can not handle encoded service URLs.
## Set the following property to false to disable encoding of service URLs.
## See https://groups.google.com/a/apereo.org/d/msg/uportal-user/44Uw1YP8_Mg/hLaTlEVZFAAJ
## for the discussion regarding this property
#
#cas.ticketValidationFilter.encodeServiceUrl=true
```
- new property, org.apereo.portal.rest.search.PortletsSearchStrategy.displayScore in `portal.properties`
```properties
##
## Flag to enable or disable the display the the search strategy score of the results
##
org.apereo.portal.rest.search.PortletsSearchStrategy.displayScore:true
```

v5.7.1
- N/A

v5.7.0
- N/A

v5.6.1
- N/A




46 changes: 38 additions & 8 deletions uPortal-webapp/src/main/resources/properties/portal.properties
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,13 @@ org.apereo.portal.cluster.lock.threadPool.keepAliveSeconds=600
#org.apereo.portal.concurrency.locking.ClusterLockDao.dbLockAcquireTimeout=PT30S


##
## Configure which file in the properties/ directory in the classpath for ehcache.
## This is often used to selected between the default ehcache.xml file with JGroups
## vs. the ehache-no-jgroups.xml file that has JGroups removed.
#
#org.apereo.portal.ehcache.filename:ehcache.xml


################################################################################
## ##
Expand Down Expand Up @@ -295,14 +302,21 @@ org.apereo.portal.events.aggr.PortalEventProcessingManagerImpl.populateDimension
org.apereo.portal.events.aggr.PortalEventProcessingManagerImpl.purgeEventSessionsPeriod=61700
org.apereo.portal.events.aggr.PortalEventProcessingManagerImpl.purgeRawEventsPeriod=61300

##
## Configure which analytics events (e.g. link clicks) are saved based on the the following:
## - NONE - no events are recorded
## - AUTHENTICATED - only record events from known users
## - ALL - record events from all users, including guest/anonymous users
#events.analytics.log.level:NONE

##
## Configure Login Events (raw) to capture user IP addresses. This is not included in aggregation.
## N.B. This raises privacy concerns and should only be enabled after very careful consideration.
org.apereo.portal.events.LoginEvent.captureUserIpAddresses=false

##
## Configure how frequently Portlet Maintenance will check to see if the maintenance date
## has started or expired for a Portlet that has scheduled Portlet Maintenance
## has started or expired for a Portlet that has scheduled Portlet Maintenance
org.apereo.portal.portlets.portletadmin.PortletMaintenanceScheduler.updateLifecyclePeriod=61400

################################################################################
Expand Down Expand Up @@ -381,6 +395,11 @@ org.apereo.portal.io.threadPool.keepAliveSeconds=30
##
org.apereo.portal.portlet.ignoreTimeout=false

##
## Portlet worker thread pool queue max size
##
#org.apereo.portal.portlet.worker.threadPool.queueSize=0

##
## Ratio of hung worker threads allowed for a fname to total available worker threads. If
## any portlet fname excedes this ratio that portlet will no longer be allowed to execute
Expand Down Expand Up @@ -500,6 +519,12 @@ org.apereo.portal.portlet.container.services.PortletCookieServiceImpl.purgeExpir
org.apereo.portal.portlet.container.services.PortletCookieServiceImpl.portalCookieAlwaysSecure=false


################################################################################
## ##
## Search Configuration ##
## ##
################################################################################

##
## The messages key for the default results search tab
##
Expand All @@ -515,6 +540,11 @@ org.apereo.portal.portlet.container.services.PortletCookieServiceImpl.portalCook
##
#org.apereo.portal.portlets.searchSearchPortletController.autocompleteSearchResults=10

##
## Flag to enable or disable the display the the search strategy score of the results
##
org.apereo.portal.rest.search.PortletsSearchStrategy.displayScore:true

##
## Strings for the search result type for various search services
##
Expand All @@ -523,6 +553,13 @@ org.apereo.portal.portlets.portletRegistry.search.result.type=Portlet List
org.apereo.portal.portlets.googleSearchAppliance.search.result.type=googleAppliance
org.apereo.portal.portlets.googleWebSearch.search.result.type=googleCustom

# Search Indexing
# ---------------
# Search indexing was introduced in v5.5.0. To disable indexing, uncomment
# and set the value of this property to "#{null}" (without double quotes)
#
#org.apereo.portal.index.relativePath=/WEB-INF/index

##
## Encryption key for the String Encryption Service used for user password encryption. Should be
## set to different value at least in prod, typically by using the Spring Property override files
Expand Down Expand Up @@ -831,13 +868,6 @@ org.apereo.portal.tincan-api.enabled=false
#org.apereo.portal.security.oauth.IdTokenFactory.customClaims=


# Search Indexing
# ---------------
# Search indexing was introduced in v5.5.0. To disable indexing, uncomment
# and set the value of this property to "#{null}" (without double quotes)
#
#org.apereo.portal.index.relativePath=/WEB-INF/index

# Personalization
# ---------------
# Disabled by default
Expand Down

0 comments on commit 2ab11be

Please sign in to comment.