Introduction / FirstSpirit Server configuration / Configuration files (FirstSpirit Server) / FirstSpirit Server (fs-server.conf) / Web Applications

Area: Web Applications

############################
# web applications
# - ROOT: start page with login page, etc.
# - WEBEDIT: WEBedit
# - WEBMON: WEBmonitor
# - STAGING: project generation web applications
###########################
# WEBAPP_xyz_URL: application url (must be start with a slash
# '/'); used for jumps between different applications
WEBAPP_ROOT_URL=/
WEBAPP_WEBEDIT5_URL=/${WEBAPP_WEBEDIT5_NAME}
WEBAPP_WEBMON_URL=/${WEBAPP_WEBMON_NAME}
WEBAPP_STAGING_URL=/${WEBAPP_STAGING_NAME}
WEBAPP_PREVIEW_URL=/${WEBAPP_PREVIEW_NAME}
 
# root directory of all web applications
WEB_DIR=${cmsroot}/web
 
# WEBAPP_xyz_PATH: directory of this web application
WEBAPP_ROOT_PATH=${WEB_DIR}/${WEBAPP_ROOT_NAME}
WEBAPP_WEBEDIT5_PATH=${WEB_DIR}/${WEBAPP_WEBEDIT5_NAME}
WEBAPP_WEBMON_PATH=${WEB_DIR}/${WEBAPP_WEBMON_NAME}
WEBAPP_STAGING_PATH=${WEB_DIR}/${WEBAPP_STAGING_NAME}
WEBAPP_PREVIEW_PATH=${WEB_DIR}/${WEBAPP_PREVIEW_NAME}
 
# title parameter for fs5root site
WEBAPP_ROOT_TITLE=FirstSpirit ${HOSTNAME}:${HTTP_PORT}

GLOBAL_WEBAPPS

This parameter is set automatically and contains the IDs of the global web applications available on the server (see Web applications). The parameter is managed by the FirstSpirit server and must not be modified or deleted. Additional configuration settings for the global web applications are saved using the parameters

  • WEBAPP_*_NAME
  • WEBAPP_*_CONTEXT_NAME
  • WEBAPP_*_SELECTED_WEBSERVER
  • WEBAPP_*_CONFIG_CHANGED
  • WEBAPP_*_ACTIVE_WEBSERVER

where * stands for the ID of the respective global web application. These parameters are also managed by FirstSpirit and must not be modified or deleted.

WEBAPP_LOG_LEVEL

This parameter is used to define the logging level for web applications. The following values can be specified for this purpose:

  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR

Only entries of the same or higher level as that specified are written to the log file. (See also page Logging for FirstSpirit web applications.)

Default value: WARN

WEBAPP_ROOT_URL

URL to the “FirstSpirit Start Page” web application (fs5root). The value stored here is required for mapping within the internal servlet engine (see also page 4.3.7.2). The value must always start with /, followed by the symbolic name of the particular web application. The URL is required for links to different FirstSpirit applications.
The following entry is required for operation under WebSphere:                  
WEBAPP_ROOT_URL=/fs5root
(see also page Integration into WebSphere Application Server)

Default value: /

WEBAPP_WEBEDIT5_URL

URL for the “FirstSpirit ContentCreator” web application (fs5webedit) within the start page. The value stored here is required for mapping within the internal servlet engine (see also page 4.3.7.2). The value must always start with /, followed by the symbolic name of the particular web application. The URL is required for links to different FirstSpirit applications.

Default value: /${WEBAPP_WEBEDIT5_NAME}

WEBAPP_WEBMON_URL

URL for the “FirstSpirit ServerMonitoring” web application (fs5webmon) within the start page. The value stored here is required for mapping within the internal servlet engine (see also page 4.3.7.2). The value must always start with /, followed by the symbolic name of the particular web application. The URL is required for links to different FirstSpirit applications.

Default value: /${WEBAPP_WEBMON_NAME}

WEBAPP_STAGING_URL

URL for the “FirstSpirit Staging” web application (fs5staging). The value stored here is required for mapping within the internal servlet engine (see also page 4.3.7.2). The value must always start with /, followed by the symbolic name of the particular web application. The URL is required for links to different FirstSpirit applications.

Default value: /${WEBAPP_STAGING_NAME}

WEBAPP_PREVIEW_URL

URL for the “FirstSpirit Preview” web application (fs5preview). The value stored here is required for mapping within the internal servlet engine (see also page 4.3.7.2). The value must always start with /, followed by the symbolic name of the particular web application. The URL is required for links to different FirstSpirit applications.

Default value: /${WEBAPP_PREVIEW_NAME}

WEB_DIR [obsolete]

Path to the FirstSpirit web directory for use with all FirstSpirit web applications (fs5root, fs5preview, fs5staging, fs5webedit, fs5webmon) (for ${} notation, see General configuration information).

This parameter is no longer needed if the “InternalJetty” is no longer used, and can then be removed.

WEBAPP_ROOT_PATH [obsolete]

Path to the directory in the file system where FirstSpirit Server stores the FirstSpirit Start Page (fs5root) web application (for ${} notation, see General configuration information).

This parameter is no longer needed if the “InternalJetty” is no longer used, and can then be removed.

WEBAPP_WEBEDIT5_PATH [obsolete]

Path to the directory in the file system where FirstSpirit Server stores the “FirstSpirit ContentCreator” web application (fs5webedit, for ${} notation, see General configuration information).

This parameter is no longer needed if the “InternalJetty” is no longer used, and can then be removed.

WEBAPP_WEBMON_PATH [obsolete]

Path to the directory in the file system where FirstSpirit Server stores the “FirstSpirit ServerMonitoring” web application (fs5webmon,for ${} notation, see General configuration information).

This parameter is no longer needed if the “InternalJetty” is no longer used, and can then be removed.

WEBAPP_STAGING_PATH [obsolete]

Path to the directory in the file system where FirstSpirit Server stores the “FirstSpirit Staging” web application (fs5staging). FirstSpirit Server also stores all generated project files in this directory (for ${} notation, see General configuration information).

This parameter is no longer needed if the “InternalJetty” is no longer used, and can then be removed.

WEBAPP_PREVIEW_PATH [obsolete]

Path to the directory in the file system where FirstSpirit Server stores the “FirstSpirit Preview” web application (fs5preview). FirstSpirit Server also stores the generated preview pages in this directory.

This parameter is no longer needed if the “InternalJetty” is no longer used, and can then be removed.

WEBAPP_ROOT_TITLE

This parameter can be used to change the title of the FirstSpirit start page. The default display value is FirstSpirit ${HOSTNAME}:${HTTP_PORT}.

Important If the host name of the FirstSpirit server, defined symbolically using the parameter SYMBOLIC_HOSTNAME is to be used when WEBAPP_ROOT_TITLE is not specified,  
  
WEBAPP_ROOT_TITLE=FirstSpirit ${SYMBOLIC_HOSTNAME}                   

can be set, for instance. Replacement is not automatic, since SYMBOLIC_HOSTNAME is an optional parameter that can also be empty.

WEBAPP_ENABLE_PLUGGABILITY_FEATURES_DEFAULT

Available from FirstSpirit Version 5.2.611 Web Framework Pluggability was introduced with version 3.0 of the Java Servlet Specification. This allows, for example:

  • web.xml modularization or
  • the configuration of components via Java annotations.

However, the latter function requires that all classes must be scanned for annotations when the web application is deployed (and implicitly each time the application server is started). As this process can take a long time, FirstSpirit can disable pluggability features globally or for individual web applications starting with FirstSpirit version 5.2.611.

Global configuration is carried out in the server configuration via the WEBAPP_ENABLE_PLUGGABILITY_FEATURES_DEFAULT parameter.

Possible values are:

  • WEBAPP_ENABLE_PLUGGABILITY_FEATURES_DEFAULT=true (default value) allows the servlet engine to search for pluggability for all web applications.
  • WEBAPP_ENABLE_PLUGGABILITY_FEATURES_DEFAULT=false disables the servlet engine's search for pluggability for all web applications.

Configuration for individual web applications is carried out via the “Pluggability” selection field, either for the global web applications (see Web applications, especially section Configuring web applications) or for the web components of a project (see Web components).

webserver.jetty.hide

Using this parameter you can disable the integrated webserver Jetty Web Server.

For this purpose the parameter must be set to true:

webserver.jetty.hide=true

Corresponding web servers are no longer displayed in the relevant dialogs and can no longer be selected.

Important This parameter may only be used if the “Jetty Web Server” is not configured to work and/or no web applications have been deployed to it. Otherwise, it may result in outdated deployments of the web applications running on the “Jetty Web Server”. Therefore, before setting the parameter, all web applications should be removed from configured “Jetty Web Servers”, if there are any deployed there..

© 2005 - 2024 Crownpeak Technology GmbH | All rights reserved. | FirstSpirit 2024.4 | Data privacy