documented the background service

This commit is contained in:
Nathaniel Kenschaft 2020-06-16 23:31:57 -04:00
parent b2c2d8fe20
commit e2781b60a1

View File

@ -2,4 +2,15 @@ Background Service
=================
This requires no user input. The proper events are
called by the main application to log events in the student's work directory.
called by the main application to log events in the
student's work directory. The service records file
accesses, editions, deletions, files moved from an
outside directory, and file to an outside directory.
Additionally, it records any git commands discovered
in the student's .bash_history or .histfile (zsh
equivalent), as git commands can interfere with the
service. It also checks for files that do not have
extensions that are whitelisted. The whitelist
includes common file extensions such as text files,
presentations, and programming file extensions (e.g.
.py for python and .class for java).