Changelog

Sophora 6: Update Notes (Draft)

Instructions for updating from the previous Sophora version.

General Update Notes (Draft)

Sophora Server Update Notes (Draft)

Minimum Sophora Version prior to Upgrade

For compatibility reasons all of your Sophora Servers must be running with at least version 5.x.x (TBD) prior to the upgrade to 6.

Major changes in Version 6

Sophora Server version 6 comes with the following changes:

  • The Sophora Server now hosts a new gRPC-based Sophora API on an additional port (default 2026).
  • The module Linkchecker has been sourced out in version 5 and has been removed from Sophora Server 6.
  • The Sophora Server IQuery search API now only allows to search in SolrCloud.

Configuration changes (Pre-Release information)

Document Store configuration

Several new configuration options have been added for the Document Store in Sophora 6.

StatusDocument Store configurationDescriptionDefault
NEWsophora.documentstore.sophoraids.declutter.cronSchedules cleanup of the Sophora ID table. Removes IDs of fully deleted documents if their ID base is continued by other documents.0 0 0 * * * (00:00)
NEWsophora.documentstore.cache.documents.maxSizeDocument cache located directly behind the database. Prevents database lookups when fetching documents. Stores live and working versions.5000
NEWsophora.documentstore.cache.summaries.maxSizeDocument summary cache located directly behind the database. Prevents database lookups when fetching summaries. Stores live and working versions.5000
NEWsophora.documentstore.cache.ids.maxSizeDocument ID cache located directly behind the database. Used for resolving references and executing simple queries. Stores live and working versions.100000
NEWsophora.documentstore.cache.primaryTypes.maxSizeResolves the primary type of a document based on its document ID.100000
NEWsophora.proposals.cache.maxSectionsMaximum number of proposal sections stored in the cache.2000
NEWsophora.proposals.cache.maxProposalsMaximum number of proposals stored in the cache.20000
REMOVEDsophora.backupSystemDocuments.cronExpressionAutomatic backup of user settings is no longer supported.
REMOVEDsophora.autoPublish.legacyModeThe released status is no longer considered during publishing.
REMOVEDsophora.repository.transaction.uuidlocks.enabledThis lock is no longer needed due to the updated transaction model in the Document Store.

PostgreSQL configuration

The PostgreSQL configuration has been available since Sophora 5 but is included here for completeness.

PropertyDescriptionDefault
sophora.persistence.postgres.hostnameHostname of the PostgreSQL server
sophora.persistence.postgres.portPort of the PostgreSQL server
sophora.persistence.postgres.usernamePostgreSQL username
sophora.persistence.postgres.passwordPostgreSQL password
sophora.persistence.postgres.databaseDatabase used for both Version Store and Document Store
sophora.persistence.postgres.maxPoolSizeMaximum number of connections in the connection pool. Determines how many SQL requests can be processed in parallel. Connections are reused.10
sophora.persistence.postgres.minIdleConnectionsMinimum number of connections that should always be available
sophora.persistence.postgres.connectionTimeoutMsMaximum time the Sophora Server waits for a connection30000 (30s)
sophora.persistence.postgres.idleTimeoutMsMaximum time a connection should remain idle before being closed10000 (10s)
sophora.persistence.postgres.validationTimeoutMsAfter this timeout, the Sophora Server checks the connection’s health status5000 (5s)

List of breaking changes

VersionTimingChanges
6.0.0Before the update, preferably months beforeThe Sophora Server does no longer come with an internal Linkchecker. If you use this feature and have not yet switched to the external Linkchecker application, you should install it before updating.
6.0.0Before the update, preferably months beforeSupport for the legacy structure node document type "sophora-nt:structureNodeDocument" is discontinued in version 6. Please ensure that you do not use this document type anywhere. Since version 3 it is replaced by "sophora-nt:structureNode2".
6.0.0Before the update, preferably months beforeThe Sophora Server no longer supports to search its PostgreSQL based document repository with IQuerys. Instead all queries will search in SolrCloud. The SearchParameters forceRepositorySearch flag will be ignored by the Sophora Server.
6.0.0Before the update, preferably months beforeThe Sophora Server has a default implementation for composing and parsing URLs, which uses the URL components of the Sophora Webapp-Framework instead of requesting the deliveries.This implementation can handle both Sophora document URLs and URLs for the Sophora Image Service. It also avoids HTTP calls to the deliveries and thus it's much faster.

Using the URL handling from the deliveries by setting the property sophora.url.use-url-library=false in the configuration file is no longer possible. The configuration sophora.documentUuidProvider.servletPath has also been removed.

For more information about the properties, see the description in the documentation of the Sophora Server configuration.
6.0.0Before the update, preferably months beforeSince the method getAdditionalXPath was removed from the ITimingActionScript interface, all implementations must also omit this method.
6.0.0Before the update, preferably months beforeThe Sophora Server no longer natively supports HTTPS and all associated configuration options have been removed. We highly recommend using an SSL-terminating reverse-proxy like nginx to connect to the Sophora Server. Read the configuration guide for more information how to configure Sophora correctly.
6.0.0Before the update, preferably months beforeThe Sophora Server now hosts the new gRPC-based Sophora API on an additional port. The previous API remains but will be removed with the future Sophora Server 7 release. The new API comes with its own list of breaking changes, which can be found on the "Sophora 6: API changes" page. Read the page carefully and see, if any of your own tools uses one of the deprecated methods.

Last modified on 8/6/25

The content of this page is licensed under the CC BY 4.0 License. Code samples are licensed under the MIT License.

Icon