From e1e8032b2b31fc3ee09f4f119eafaf351b6d66b5 Mon Sep 17 00:00:00 2001 From: Mohammed Goder Date: Wed, 13 Mar 2024 10:54:29 -0500 Subject: [PATCH] Add README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c229466 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +Git Repository Synchronizer v1 is a system that provides individuals the ability to archive a git repository without having to worry about the archive being sabotaged. + +GRS creates snapshots when it detects the source repository has been tampered with. + +Tampering is detected when the source git repository reduces in size by a certain threshold. The threshold can be set by modifying `thresholdFactor` in `grs.sh`. Setting `thresholdFactor=5` would mean that the source git repository would have to drop by 20% for it to be considered as tampering. The way 20% is derived from a `thresholdFactor` of `5` is by dividing `1/thresholdFactor` which in the case of `1/5` would equal `0.2` which is the ratio for 20%. + +The execution cycle can be set by configuring `timer.service` using systemd conventions. The settings default to executing every ten minutes on the hour. \ No newline at end of file