Introduction
Introduction

Introduction / Installing FirstSpirit

A version number is specified in the file name of the installation archive, for example:

fs-install-1.0.0.tar.gz

This version number is identical to the version number of the FirstSpirit backend which, among other components, includes the Java Service Wrapper (see below). (This version number has no relation to the version number of the FirstSpirit server.)

In the following, the placeholder [version] will be used for the version of the installation archive used. This must be replaced with the version of the installation archive used for the respective installation.

fs-install-[version].tar.gz 

Installation (Default Settings)

A default installation:

To install with a different port see Installation with a different port.

To install in Legacy Mode see Installation in Legacy Mode (not recommended).

Installation via the install archive consists of the following steps:

1) Unpack the install archive

Usually tar xzf works. When using a primitive tar you may have to gunzip the archive first.

2) Copy the FirstSpirit server file

Now copy the FirstSpirit server file fs-isolated-server.jar for the desired FirstSpirit version into the directory ~FS/server/lib-isolated.

~FS indicated the FirstSpirit server installation directory.

See Provisioning of the Firstpirit server files.

3) Choosing a JDK

Let the environment variable FS_JAVA_HOME point to an installed JDK, e.g.:

FS_JAVA_HOME=/opt/java/jdk-11.0.4

Instead the full path to a JDK can also be specified with the parameter wrapper.java.command in the configuration file ~FS/conf/fs-wrapper.isolated.conf .

When required the path can later be modified with this parameter, seeJava Wrapper Parameters (→Documentation for Administrators).

4) Adding the license file

After installation you have to install a valid FirstSpirit license file.

If no license is installed:

  • it is possible to use FirstSpirit for 30 minutes after each start.
  • a message is sent to all logged in FirstSpirit users before the server is shut down.

5) Adjust Java VM configuration

Subsequently, the FirstSpirit Server should be configured as described in the chapter File system organisation (→Documentation for Administrators) in the FirstSpirit Manual for Administrators. Here, the subsection "Java VM and Wrapper (fs-wrapper.conf) (→Documentation for Administrators)” is of particular importance.

6) Starting FirstSpirit server

Now the FirstSpirit server can be started.

Demo and Blueprint-Project

FirstSpirit provides demo and blueprint-projects with exemplary basic contents and configurations.

If required, the following (and other) projects can be requested via Technical Support.

Projects:

Important To be able to fully use the demo project the module Apache FOP (fs-fop.fsm) is required (see Support for Apache FOP (→Documentation for Administrators)).

Further documentation:

Installation (non-default)

Installation with a different port

Before starting the FirstSpirit server the values HTTP_PORT and/or SOCKET_PORT in ~FS/conf/fs-server.conf have to be changed (see Communication (→Documentation for Administrators))

Installation in Legacy Mode (not recommended)

If you want to install in “Legacy Mode” (against our recommendation), this currently is still possible.

Important The legacy mode will be discontinued in the medium term.

The following steps have to be performed to install FirstSpirit in Legacy Mode:

  1. Unpack the install archive (as described above for the default installation).
  2. Then copy the FirstSpirit server file fs-server.jar for the desired FirstSpirit version into the directory ~FS/server/lib (here ~FS is the FirstSpirit server installation directory).
  3. The environment FS_JAVA_HOME has to point to a JDK installation directory (see default installation).
  4. The file ~FS/bin/fs5.mode has to be deleted. (When FirstSpirit servers are configured for Isolated Mode fhis file contains the word isolated.)
  5. Copy the file ~FS/bin/fs5.mode.legacy and rename the copied file to ~FS/bin/fs5.mode.
  6. Upon completion a valid FirstSpirit license has to be installed. Finally the FirstSpirit server can be started in Legacy Mode (siehe 4) Adding the license file).

Explanation: Isolated Mode and Legacy Mode

Since the introduction of “Isolated Mode” for the FirstSpirit server, modules can be developed in two different modes (Isolated and Legacy).

The “legacy Mode” will be discontinued in the medium term; by then all modules and servers should have been converted.

Goal

The “Isolated Mode” of the FirstSpirit server has the essential goal of giving the module developer greater freedom in selecting the libraries used. Especially the potential conflicts with libraries supplied by the FirstSpirit core should be minimised.

New installation (default setting - isolated)

With all new installations Isolated Mode is the default.

Use of modules

If modules are used, they should be isolated-capable to ensure smooth operation.

Even existing FirstSpirit modules that have not yet been converted to “Isolated Mode” are (still) executable. If these contain a web component that uses libraries that are not available in the module, it may be necessary to use the compatibility module until the module is converted to “Isolated Mode”. Beyond that no adjustments are necessary at short notice.

In the medium term, however, all resources in modules should be adapted to the new conditions in order to take advantage of the “Isolated Mode”.

Additional information on the Isolated Mode

See Isolated Guide root (→Isolated Mode Guide)

© 2005 - 2020 e-Spirit AG | All rights reserved. | FirstSpirit 2020-07 | Data privacy | Imprint | Contact us