Licence configuration (fs-license.conf)

File fs-license.conf is located in the FirstSpirit Server subdirectory conf and contains the FirstSpirit licence and should not be changed. 

The licence parameters of fs-license.conf can be displayed via FirstSpirit ServerMonitoring (see License). Furthermore, it is also possible to insert a new licence file via ServerMonitoring. When inserting a new configuration file fs-license.conf, it is not necessary to restart the server. The file is automatically updated on the server.

Manipulations to fs-license.conf result in an invalid licence. If changes are necessary (e.g. IP address change), please contact the manufacturer. An fs-license.conf does not have to contain all the information described in the example.

Some of these parameters are visualized in the FirstSpirit Health Center (“License Checker”, see License checker).

#FIRSTspirit license
#Mon Jan 02 10:34:22 CET 2018
license.MAXPROJECTS=5
license.EXPDATE=15.12.2019
license.MODULES=personalisation,search,integration,newsletter,portal,form_edit,enterprise_search
license.ARCHIVE=1
license.VERSION=5
license.USER=e-spirit
license.WORKFLOW=1
license.DOCUMENTGROUP=1
license.MAXSESSIONS=20
license.WEBEDIT=1
license.MAXUSER=20
license.APPTAB_SLOTS=5
-----begin FirstSpirit license key-----
...
-----end FirstSpirit license key-----

license.MAXPROJECTS

Maximum number of projects which can be created with this licence on the server. Deactivated projects are not included.

license.EXPDATE

Expiration date of the licence. The FirstSpirit Server will terminate automatically on this date. If the corresponding parameters have been set in the configuration file fs-server.conf (see Area: Mail), a reminder is sent via email prior to the expiration date.

license.VERSION

FirstSpirit software version for which this licence is valid.

license.USER

Name of the licencee.

license.FEATURES

Licence-dependent additional functions released via this licence.

license.ARCHIVE

Value “1” activates the archiving function, thus enabling the archiving of FirstSpirit objects (see Project archiving for further documentation).

license.WORKFLOW

The license parameter license.WORKFLOW controls whether only the standard workflows supplied with FirstSpirit (“Assign task” and “Request release”) may be used on a particular FirstSpirit server (license.WORKFLOW=0) or whether users may also create and use their own workflows (license.WORKFLOW=1). The parameter license.WORKFLOW=0 does not permit any workflows to be edited or created and only the workflows supplied as standard may be used. (For more documentation, see Workflows (→FirstSpirit Online Documentation).)

license.DOCUMENTGROUP

This value is set to “1” by default. Thus, the “Document group” function is activated, enabling the page references in the Site-Store to be summarised as a group and, therefore, the generation of a result document, e.g. a pdf file (see Document groups (→FirstSpirit Online Documentation) for further documentation).

license.MAXSESSIONS

Maximum number of sessions which can be simultaneously opened on the server. Internal server sessions (preview, generation) and remote sessions are not included. If the maximum number of sessions is exceeded, it is possible to open a maximum of two further server administrator sessions (unless two server administrator sessions have already been opended) to terminate current sessions, if necessary.

license.WEBEDIT

Value “1” activates the “ContentCreator” function, thus enabling the direct editing of editorial contents within the preview page in the browser window.

license.MAXUSER

Maximum number of users which can be created with this licence on the server.

license.IP

Comma-separated list of the server IP addresses for which the licence is valid. If the FirstSpirit Server is started on a computer with a different IP address, the licence is invalid.

license.MODULES

Licence parameter for modules, several modules can be separated by a comma.

license.SCOPE

Differentiation between single and corporate licence (license.SCOPE=SINGLE or license.SCOPE=CORPORATE). A license conflict (a license with license.SCOPE=SINGLE used by multiple servers) will cause termination of the FirstSpirit server. Only the first server started with this license will not be terminated. All others will terminate after appropriate log notification with a 30 minute delay. To prevent the server from shutting down, a valid license needs to be imported to the affected server (see page License). Importing a different, valid license on another FirstSpirit server on the network will not suffice. If a license conflict arises when switching between two versions of FirstSpirit, the affected license can be used on the server again only after restarting the server.

license.TYPE

Definition of the licence type:

• PRODUCTION: “Productive”
• DEVELOPMENT
• DEMO: “Demonstration”
• STAGING: “Quality assurance”
• TRAINING

The licence type is displayed among other things on the FirstSpirit start page and, with at several places of FirstSpirit SiteArchitect and FirstSpirit ContentCreator with the name of the licencee (parameter license.USER).

license.KEY

Licence key

license.APPTAB_SLOTS

Maximum number of AppCenter applications (SiteArchitect and ContentCreator) which can access the application API. With license.APPTAB_SLOTS=5, for example, five different applications can be used or URLs can be opened. It does not matter which applications these are. Because unlike licensing of a FirstSpirit (module) add-on, it is not the function that is licensed here, but the number of integrated applications. (See also Dokumentation FirstSpirit AppCenter.)

Further licence keys

For further licence keys please see respective module documentation.