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

Area: Misc

###########################
# misc
###########################

# comma seperated list of directories to check, e.g.
# hdd.directories=${cmsroot}/data/projects,${cmsroot}/web/
hdd.directories=${cmsroot}

# hdd warning limit, use hdd.limit.active=false to turn off warning
hdd.limit=90
hdd.limit.active=true

# hdd server shutdown limit, use hdd.shutdown.active=false to turn off shutdown
hdd.shutdown=95
hdd.shutdown.active=true

BATCHPATH

This parameter defines the path to the script files that can be run during deployment, for instance.

LICENSE_EXPIRATION_WARNING_DAYS

This parameter defines the number of days before a FirstSpirit license expires that a daily license expiration warning will be issued. If the specified value is 0, no e-mail will be sent (default value is 30 days).

LICENSE_EXPIRATION_MAIL_ADDRESS

this parameter defines the e-mail address to which the license expiration warning message will be sent. If no e-mail address is defined, no e‑mail will be sent.

BACKUP_PATH

The path to the backup directory — the directory in the file system where FirstSpirit server stores backups. Backups are created via the Execute project backup schedule entry or the license-dependent “FirstSpirit EnterpriseBackup” functionality (see the corresponding module documentation). Backups are stored in the FirstSpirit server backup subdirectory by default.

ODFS_BASE_URL

The parameter specifies the URL for the local online documentation.

Example:

ODFS_BASE_URL=https://myServer:8000/help/odfs

mail.backup-recipient

This parameter allows for an e-mail address to be specified that is used when the parameters backup.size.limit, backup.min.age and/or backup.max.age (see below) are enabled.

backup.size.limit

This parameter can be set so that an e-mail is sent to the e-mail address defined by the mail.backup-recipient parameter if the size of the backup files exceeds the size specified. Examples of values include 500m or 3g. No value is specified by default, which means that the function is disabled.

backup.min.age

This parameter can be set so that backup files are deleted automatically after the specified period (in days) if the value defined by the backup.size.limit parameter is reached. No value is specified by default, which means that the function is disabled. To enable this function, a value must be specified. When backup files are deleted, an e-mail is sent to the e-mail address defined by the mail.backup-recipient parameter.

backup.max.age

This parameter can be set so that backup files are deleted automatically after the specified period (in days). No value is specified by default, which means that the function is disabled. To enable this function, a value must be specified. When backup files are deleted, an e-mail is sent to the e-mail address defined by the mail.backup-recipient parameter.

hdd.directories

This parameter specifies the directories to be monitored. The default value is the FirstSpirit root directory, which is hdd.directories=${cmsroot}. This is used when the value is not entered manually. See also page Global server properties, option Directories for disk space check (comma separated), etc.

hdd.limit

This parameter is used to specify the percentage at which point a warning e-mail message is sent to the server administrator. Values from 1 to 99 can be specified. If no warning e-mail is to be sent, the value can be set to -1
The default value is 90%, i.e. hdd.limit=90. This is used if the value is not specified manually or if the value specified is not between 1 and 99 or is -1.

In addition to specifying the free storage space as a percentage, an absolute value can also be specified. When specifying absolute values, the units m (MiB), g (GiB) and t (TiB) can be used (e.g. hdd.limit=3g).

hdd.limit.active

This value is used to prevent warning e-mail messages from being sent. In this case, hdd.limit.active=false must be set. The sending of messages, however, is enabled by default when a limit is specified.

hdd.shutdown

This parameter is used to specify the percentage at which point a warning e-mail message is sent to the server administrator and the server is shut down. Values from 1 to 99 can be specified. If the server should not be shut down, the value can be set to -1. If the selected value is equal to or less than hdd.limit,  hdd.shutdown is set by the system to be 5% higher than hdd.limit.        
The default value is 95%, i.e. hdd.shutdown=95. This is used if the value is not specified manually or if the value specified is not between 1 and 99 or is -1.

In addition to specifying the free storage space as a percentage, an absolute value can also be specified. When specifying absolute values, the units m (MiB), g (GiB) and t (TiB) can be used (e.g. hdd.shutdown=2g).

hdd.shutdown.active

This value is used to prevent shutdown of the FirstSpirit Server. To prevent shutdown, hdd.shutdown.active=false must be set. Shutdown, however, is enabled by default when a limit is specified.

startpage.webstart.url

This parameter allows you to define a base URL, which is called via the FirstSpirit start page whenever SiteArchitect or ServerManager are started. The parameters that are required to start the client (the URL parameters) are appended to this URL. The parameters take account of the connection settings that have been configured and are active in each case (“FirstSpirit start page / Connection settings”, “FirstSpirit ServerManager / Server properties / Webstart” or “FirstSpirit ServerManager / Server properties / Start page”). This means, for instance, that you can use a customer-specific Java start system instead of the FirstSpirit Launcher technology.
Example: startpage.webstart.url=http://MyServer:8080/MyStartPage.jsp

startpage.logout.url

This parameter allows you to define a URL to which users are directed when they log out of FirstSpirit (“FirstSpirit start page / Logout”).                  
Example: startpage.logout.url=http://www.e-Spirit.de

Important If you use the allowedRedirectHosts parameter in addition to the startpage.webstart.url and startpage.logout.url parameters, you must take care to ensure that the relevant URLs are included in the list for allowedRedirectHosts as well (or that the FS_SERVER or ALLOW_ALL values are set). Otherwise, an “HTTP ERROR 500” error will occur on start-up. Logout triggers an actual logout process and the login page appears.

SERVICES

A FirstSpirit service is a server component that can be activated via a public interface made of input components or scripts.

Configuration via SERVICES=* (start all services automatically)

The SERVICES parameter can be used to configure the character *:

SERVICES=* 

In this case, the FirstSpirit Server starts all the services installed on the server automatically when the server itself starts, i.e.:

  • FirstSpirit's proprietary system services, e.g., the permission service
  • Services that have been installed on the FirstSpirit Server via a module

Advantage: Services cannot be forgotten or overlooked, which would then cause problems during subsequent operation (after starting the server).

Important If SERVICES=* is configured in the fs-server.conf configuration file, it is no longer possible to configure the Autostart option in ServerManager (this is the option for activating and deactivating individual services automatically).

Default: Configuration via the Autostart option (start certain services automatically)

If it is not desirable to start all services automatically, Crownpeak recommends activating the services that are to be started via the Autostart option in ServerManager or the Autostart option in ServerMonitoring.

Starting and stopping services manually: Services can also be started and stopped manually at any time:

services.start.timeout

If a service takes too long to start, the startup attempt is aborted after the time period (in seconds) configurable via this parameter.
Default is 180.

mime.types.additional

The FirstSpirit Media Store is designed to manage files of different formats within a project. They can be uploaded to FirstSpirit via SiteArchitect and ContentCreator.
Most file formats are already known by FirstSpirit and they are filed in the Media Store with the appropriate MIME type when uploaded. It is possible to search for MIME types in SiteArchitect, for example, and access them in templates and via API. For special file types which are not known in FirstSpirit, mapping can be carried out on the desired MIME types, via the mime.types.additional parameter.

Using this parameter, the desired MIME type and the file extension can be specified, separated with a colon. Several mappings can be specified, separated with semicolons.
Example:

mime.types.additional=application/zip:fsr;text/plain:conf

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