diff --git a/README.md b/README.md index 147e0c3..da70cd8 100644 --- a/README.md +++ b/README.md @@ -6,5 +6,14 @@ Tampering is detected when the source git repository reduces in size by a certai The execution cycle can be set by configuring `timer.service` using systemd conventions. The settings default to executing every ten minutes on the hour. +Repositories that are to be archived must be cloned into the "repositories" directory while `grs.sh` is not running a cycle. The safest way to do this is by: + 1. Executing `systemctl stop grs.timer` + 2. Executing `watch -c "systemctl status grs.service"` to confirm that `grs.sh` is inactive. + 3. Cloning a git repository into the `repositories` directory. + Example: + 1. `cd repositories` + 2. `git clone --recursive https://git.mgoder.com/mg/GitRepositorySynchronizerV1.git` + 4. Executing `systemctl start grs.timer` + NOTE: The reasoning behind the usage of "v1" is due to it being possible to develop a better solution using a C++ compiler that reduces the strain on the storage medium and cuts the storage footprint in half by using system memory as a temporary cache to compare the pulled git changes instead of having the previous snapshot always in storage. \ No newline at end of file