Settings

Roles:Admin

All settings descriped here are configurable by the administrator through a special page on the client. One can configure those through the configuration file on the first setup, too, but it is not required to do so.

For a complete overview of all configuration options available see the Configuration page.

Available settings

Setting	Default	Description
defaultTeamSize	2	Size of a 'default team'. Teams are not validated against this constraint but the client uses it for Quality of Life adjustments.
canTutorExcuseStudents	false	Are tutors able to excuse their students? If this is true they can set the attendance state of their students to excused. If this is false only the administrator can set the attendance states to excused.
excludeStudentsByStatus	true	Are students with student status "Hat bereits einen Schein" and "Inaktiv" excluded from the schein criteria calculation? If this is true they are excluded and will not be considered in any dashboard diagram. If this is false they will not be excluded and will contribute to the dashboard statistics.
mailingConfig	(optional)	MailingConfiguration - Options for nodemailer. For more information see below.

Mailing Configuration

The following table contains the options available for the mailing configuration, a short description and their default value (if they are optional).

Option	Default	Description
host	'localhost'	string - Hostname of the IP address of the mail server.
port	587	number - Port used by the mail server. The default depends on the secure setting.
from	''	string - Used as the sender of the mail. Must be either a valid email or a string with the form {{name}} <{{email}}>
subject	No default	string - Subject of the emails containing the TMS credentials for the users.
auth	No default	{ user: string; pass: string } - Object containing the authentication data for the mail server. Please note: For now, OAuth is not supported.