Default variable details

Some of ypid.epoptes default variables have more extensive configuration than simple strings or lists, here you can find documentation and examples for them.

epoptes__rooms

The epoptes__rooms dictionary allows you to configure the (class)rooms for Epoptes. The key of a given room is the room name (for example r23 or r42).

Each item is a dictionary itself with the following supported keys:

room_prefix

Optional, string. Defaults to epoptes__room_prefix.

room_suffix

Optional, string. Defaults to epoptes__room_suffix.

teachers

Required, list of strings. List of teacher hosts.

teacher_hosts

Optional, list of strings. The teacher hostnames to which clients will connect. Note that Epoptes on a student computer can only be configured to connect to one teacher computer. The first host teachers or teacher_hosts will be picked and additional once are ignored. This was done so that the role can provide a future proof interface.

students

Required, list of strings. List of student hosts.

Examples

Configure Epoptes in room r23 with r23-pc01 being the teacher host and r23-pc02 and r23-pc03 being student hosts:

epoptes__rooms:
  'r23':
    teacher_hosts:
      - 'r23-pc01.sint.example.org'
    teachers:
      - 'r23-pc01'
    students:
      - 'r23-pc02'
      - 'r23-pc03'