<
Collaboration (Beta), 2025.9
Collaboration (Beta), 2025.9

FirstSpirit Collaboration: Installation Guide

Requirements

To use FirstSpirit™ Collaboration, the following services must be installed and preconfigured:

Only one external web server is supported.

A downgrade cannot generally be guaranteed.

Configuration

A configuration is only necessary if you run a local FirstSpirit server. If FirstSpirit is hosted in the cloud, everything is already set up for you.

The configurations must be made before installing the module for the first time. The order of the configurations does not matter.

Tomcat

  1. The "postgre-[version of the database].jar" file matching the version database must be copied into the "[Tomcat]/lib/" directory.
  2. In the "[Tomcat]/lib/config/" directory, a new file with the name "fs-collaboration-microapp.properties" with the following contents must be created:

fs.microapp.collaboration.database.driver=org.postgresql.Driver
fs.microapp.collaboration.database.url=<JDBC URL>
fs.microapp.collaboration.database.user=<Username>
fs.microapp.collaboration.database.password=<Password>
fs.microapp.collaboration.database.schema=<Schema> (Standard: public)

Sample content for the file "fs-collaboration-microapp.properties":

fs.microapp.collaboration.database.driver=org.postgresql.Driver
fs.microapp.collaboration.database.url=jdbc:postgresql://localhost:5432/microapps
fs.microapp.collaboration.database.user=myDatabaseUser
fs.microapp.collaboration.database.password=myUserPassword
fs.microapp.collaboration.database.schema=collaboration

Database

The schema matching the "fs.microapp.collaboration.database.schema" parameter (if configured, it is set to public by default) must be created in the database. The user specified in the "fs.microapp.collaboration.database.user" parameter must be granted full reading & writing permissions on the schema.

The FirstSpirit™ server and Tomcat must be restarted after the installation is complete.

Installation

An installation is only necessary if you run a local FirstSpirit server. Only FirstSpirit server admins can install modules. If FirstSpirit is hosted in the cloud, everything is already set up for you.

The installation of the FirstSpirit™ Collaboration (fs-collaboration-[version].fsm) module on the FirstSpirit server is carried out as usually via the ServerManager.

To make the initial setup of the module as easy as possible, a number of things are automated during the installation. These include:

  1. Creating and deploying the global "FirstSpirit Collaboration" web app.
    • ID: fs-multisite-microapp
    • Name: FirstSpirit Collaboration | MicroApp
    • Web context: /fs-collaboration-microapp
    • The new web app is initially deployed on the same web server as the root web app.
  2. Adding the "FirstSpirit Collaboration | ContentCreator Integration" web component to the ContentCreator web app.
    • The ContentCreator web app is not deployed automatically.

The ContentCreator web app is not deployed automatically and must be deployed manually by a server administrator.
If a separate ContentCreator instance is configured for a project, the "FirstSpirit Collaboration" and "CXT-Platform | CC Integration" web components must be added.
Since every web application requires computing time, memory and storage space, it is recommended for productive environments to avoid using project-local web applications if possible.

Activation

The activation of the feature for individual projects is necessary in all FirstSpirit environments, regardless of whether FirstSpirit is hosted locally or in the cloud.

To use the feature Collaboration in a project, you must add the corresponding project component to the project.

  • Navigate to the project components of the project in which Collaboration is to be used.
    ServerManager > Project Selection > Change properties > Project components
  • Click Add.
  • Select the project component FirstSpirit Collaboration | ProjectApp.
  • Click OK.

    → Collaboration is active in your project.