Useful standard configuration parameters for fs-server.conf

Author: isenberg
Publication Date: 7/3/2015 9:41

This addendum extents

    PDF: Installation Instructions Firstspirit 5.x

This document lists the common configuration settings used with most FirstSpirit servers after initial installation.

The file should be modified from the FirstSpirit ServerMonitor web based interface, section Configuration.

All available parameters for fs-server.conf are explained in the FirstSpirit Manual for Administrators, section 4.3.1 FirstSpirit Server configuration (fs-server.conf).

Configuration -> Server (file fs-server.conf):

# embedded Jetty AppServer
INTERNAL_SERVLET_ENGINE=1
HTTP_PORT=8000
# internal communication between FirstSpirit WebApps and FirstSpirit Server
# deactivate SOCKET_HOST if AppServer is used on different host
SOCKET_PORT=1088
SOCKET_HOST=localhost
# Cross site request forgery protection
# Add all hostnames and IP-addresses of URLs used for accessing
# this FirstSpirit Server. Usually those are the FirstSpirit host itself and
# applications servers or frontend servers.
# default: hostname (without IP address) and all configured application servers
allowedRedirectHosts=cmshost.mydomain.com,cmshost,localhost,100.124.125.126
# page title and headline on FirstSpirit start page
WEBAPP_ROOT_TITLE=FirstSpirit Development System
SYMBOLIC_HOSTNAME=Development System
# JMX monitoring for JVM and FirstSpirit performance data
#jmx.port=8002
#jmx.password.file=conf/fs-jmxpasswd.conf
# to enable JMX authentication, create file firstspirit5/conf/fs-jmxpasswd.conf
# with the following content:
# monitorRole PASSWORD1
# controlRole PASSWORD2
# log waring if JVM GC pauses exceed this limit in seconds
hiccup.warningLogLimit=3
# activate, if external Frontend Server, AppServer
# or different DNS name for start page is used
#URL=http://cmshost.mydomain.com
#fs.url.hostname=cmshost.mydomain.com
#fs.url.httpport=80
#fs.url.usehttps=false
# connection parameters for SiteArchitect and ServerManager
# usually no change is required here
webstart.client.server=
webstart.client.port=0
webstart.client.usehttps=false
webstart.client.connection=HTTP
webstart.client.servletZone=
webstart.client.compression=0
webstart.client.encryption=0
webstart.client.parameters=
webstart.client.memory=0
webstart.admin.server=
webstart.admin.port=0
webstart.admin.usehttps=false
webstart.admin.connection=HTTP
webstart.admin.servletZone=
webstart.admin.compression=0
webstart.admin.encryption=0
webstart.admin.parameters=
webstart.admin.memory=0
# SMTP configuration
# mail recipient will be set specifically in FirstSpirit tasks or workflows
mail.smtp=mail.mydomain.com
mail.sender=firstspirit-cmshost@mydomain.com
mail.default-recipient=
LICENSE_EXPIRATION_MAIL_ADDRESS=name@mydomain.com
LICENSE_EXPIRATION_WARNING_DAYS=30
# assign FirstSpirit Server Administrator role to LDAP groups
externalServerAdminGroup.1=CN=firstspirit-admins,OU=FirstSpirit,DC=mydomain,DC=com
# LDAP authentication and group membership
# in addition, all lines with "LdapLoginModule" must be activated
# in ServerMonitor -> Configuration -> Authentication (fs-jaas.conf)
LDAP.NAME=mydomain.com
LDAP.HOST_URL=ldap://ldaphost1.mydomain.com ldap://ldaphost2.mydomain.com
LDAP.SSL=FALSE
LDAP.AUTHENTICATION=SEARCH_BIND
LDAP.SEARCH.BIND_DN=cn=technicaluser,cn=users,dc=mydomain,dc=com
LDAP.SEARCH.BIND_PASSWORD=password
LDAP.SEARCH.BASE_DN=DC=e-spirit,DC=de
LDAP.SEARCH.FILTER=(sAMAccountName=$USER_LOGIN$)
LDAP.IMPORT_USER=TRUE
LDAP.IMPORT_USER.GROUP_ATTRIBUTE=memberof
LDAP.IMPORT_USER.LOGIN_ATTRIBUTE=sAMAccountName
LDAP.IMPORT_USER.NAME_ATTRIBUTE=givenName,sn
LDAP.IMPORT_USER.EMAIL_ATTRIBUTE=mail
LDAP.IMPORT_USER.PHONE_ATTRIBUTE=telephoneNumber
LDAP.IMPORT_USER.ABBREVIATION_ATTRIBUTE=initials
# limit FirstSpirit search recursion depth over foreign key references in datasets
indexing.maxNoOfAssociations=1
# check available filesystem space and warn by email to "mail.default-recipient"
# or shut down FirstSpirit server if given usage percentage levels are reached
hdd.limit=90
hdd.limit.active=true
hdd.shutdown=95
hdd.shutdown.active=true
# comma-separated list of directories to check
hdd.directories=${cmsroot}
# limits for project backups in byte and days
#backup.size.limit=500G
#backup.min.age=30
#backup.max.age=60
# time (seconds) after an unused project repository and project registry is removed from cache, set to 7 days
REPOSITORY_UNLOAD_TIME=604800
registry.unloadTime=604800

Tags: admindoc