Updating FirstSpirit

Important: This chapter is only relevant for non-cloud customers who run their FirstSpirit installation themselves. For cloud customers, server updates are performed regularly by Crownpeak as part of the patchdays.

The following components must be taken into account during an update:

• FirstSpirit Server
  As part of the FirstSpirit releases, Crownpeak publishes updates at regular intervals. Only a current FirstSpirit version can ensure that all FirstSpirit functions will be available and that the software will run as well and reliably as possible.
  We therefore recommend updating existing FirstSpirit Servers regularly and promptly.
  An update does not change any project or user data in FirstSpirit. Only executable binaries and libraries are updated.
• FirstSpirit backend:
  Crownpeak updates the operating environment of the FirstSpirit Server (Java Service Wrapper and control files) intermittently (security updates, support for new Java versions, etc.).
  In this case, we recommend that the operating environment for existing FirstSpirit Servers is updated promptly.
• FirstSpirit modules:
  For every FirstSpirit Server update, we recommend updating all installed modules which are supplied by Crownpeak as well as recreating and updating all self-created modules using the latest FirstSpirit version.
• FirstSpirit web applications:
  All installed FirstSpirit web applications are under the control of server version management and will be rolled out again when the server is started. If the particular application directory contains a version.txt file, the system will first check if a newer version of the installed application is present before updating by using the version number in the version.txt file. If there is a new version, the new version will be rolled out. The web server control then handles the update (and restart) of the web application on one or more web servers (except for external web servers, see Web servers).
• Special case: cluster group, see Updating in a cluster group

Update options (server)

Automatic update

• FirstSpirit Server update
• optional: module updates
• no update of the FirstSpirit backend
• automated process (“push update”)
• The update can be planned for a time of your choice (via schedule management).
• GUI support
• FirstSpirit permissions: server administrator

Recommended: For systems which regularly need to be kept up to date without manual intervention and which have a sufficient maintenance window (e.g., development or QA systems).

For more information, see:

Automatic update via the update service
The file(s) required for the update can be downloaded and installed automatically and regularly directly from the Crownpeak update service (web interface) via schedule. This requires an Internet connection.

Alternatively, you can choose to receive an e-mail notification as soon as a new FirstSpirit version is available for an update (see Automatic update via the update service, option “Only notify, do not perform update”).

Replacing the FirstSpirit Server file (fs-isolated-server.jar)

• FirstSpirit Server update
• no update of the FirstSpirit backend
• additional work is required to update the modules
• very simple and quick (by replacing a single file)
• no GUI support
• manual process (“pull update”)
• execution via direct file system access in the server home directory
• permissions: corresponding access permissions in the file system of the server home directory

Recommended: For systems in permanent 24/7 operation which therefore have a short maintenance window.

For more information, see Manual update by replacing the FirstSpirit Server file.

Using ServerMonitoring

• FirstSpirit Server update
• no update of the FirstSpirit backend
• optional: FirstSpirit module updates
• GUI support
• manual process (“pull update”)
• FirstSpirit permissions: server administrator

For more information, see:

• Manual update via local files
  The file(s) required for the update must first be downloaded outside of FirstSpirit; the update is then carried out via FirstSpirit ServerMonitoring.
• Manual update via the update service         
  The file(s) required for the update is/are downloaded and installed from the Crownpeak update service (web interface) in a software-supported process. This requires an Internet connection.

Update options (backend)

Using the update archive

• FirstSpirit backend update
• no update of the FirstSpirit server
• no GUI support
• manual process (“pull update”)
• execution via the command line
• FirstSpirit permissions: server administrator

Recommended: For updates to the FirstSpirit backend.

For more information, see Updating the FirstSpirit backend.

Recommendations for Isolated Mode migration

For the conversion of an existing server from Legacy Mode to Isolated Mode see Server: Installation and Migration (→Isolated Mode Guide).