Introduction / Installing FirstSpirit

Installing FirstSpirit

Table of contents

The FirstSpirit installation is carried out via the installation archive:

  • for all supported operating systems and
  • for all supported Java versions

For information on supported operating systems and Java versions see Technical requirements and recommendations (→Documentation for Administrators).

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 

A default installation:

  • uses
    • HTTP port 8000 and
    • Socket port 1088
  • uses the “Isolated Mode”

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

Installation steps

1) Unpack the install archive

Usually tar xzf works. When using a primitive tar you may have to unpack the archive first (e.g. with gunzip).

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-Projects

The CXT Blueprint project

Crownpeak provides the “CXT Blueprint project” with exemplary basic contents and configurations for FragmentCreator (see Fragment project (→Documentation “Content Experience Tools”)).

If required, the projects can be requested via Technical Support.

Further documentation:

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))

© 2005 - 2022 Crownpeak Technology GmbH | All rights reserved. | FirstSpirit 2023.2 | Data privacy