Skip to content

Configuration

Rüdiger Beck edited this page Mar 15, 2018 · 6 revisions

Configuration file syntax

  • All configuration files are in smb.conf style (i.e. *.ini) syntax.

  • The files contain sections in square brackets: [section]

  • A section contains one or more keys: name=value

  • Comments are allowed after keys and are denoted with #

  • If the section name contains a dot, the part before the first dot creates a subsection:

    [userfile.students.csv] means section userfile with subsection students.csv

  • Each name of a key (i. e. SURNAME_CHARS below) can be stated only once so:

    A List of values must be written comma separated after the key name

    LIST=bsz,abc,test

    Key-Value pairs as values are written comma separated with the equal sign.

    KEY_NAME=key1=value1,key2=value2

All combined is shown in the following example:

  [userfile.students.csv]
          ENCODING=UTF8
          SURNAME_CHARS=6 # number of characters of the surname of the user
          LIST=bsz,abc,test # Lists use one name and multiple comma separated values
          KEY_NAME=key1=value1,key2=value2 # This are Key/Value pairs

The line ENCODING sets the value of the key name ENCODING in section userfile, subsection students.csv to the value UTF8.

Configuration

Global Configuration

see the example here :

sophomorix.ini

School Configuration

see the example here :

school.ini

Clone this wiki locally