summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrent s <bts@square-r00t.net>2020-06-17 13:55:23 -0400
committerbrent s <bts@square-r00t.net>2020-06-17 13:55:23 -0400
commit29e191e8b59a2678daeec224b0a97f5c917488ce (patch)
tree0bbf0b082eed30e1b908921a7c796b2b1c6ff77a
parentfca5f12aa2cad7f6d4a885da34be66700fb18c12 (diff)
downloadRepoMirror-29e191e8b59a2678daeec224b0a97f5c917488ce.tar.xz
add README
-rw-r--r--repomirror/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/repomirror/README b/repomirror/README
new file mode 100644
index 0000000..bbd51a3
--- /dev/null
+++ b/repomirror/README
@@ -0,0 +1,11 @@
+This project will let you mirror a Linux distribution's repository/repositories (or BSD, etc.).
+
+Features:
+- Logging
+- RSync or FTP supported (RSync mirrors require rsync to be installed and in the $PATH environment variable) (HTTP/HTTPS cannot and will not be supported as there's no real way to do it reliably and efficiently.)
+- Locking - prevent a specific distribution from syncing if it is currently being synced but allow other distributions to sync
+- Customizable rsync arguments
+- Changing of directory/file ownership per-distribution
+- Mount-checking per-distribution - a distribution will be skipped if its designated mountpoint is not mounted
+- Synchronization checks - timestamp files can be read and written and are used to determine if a sync should take place or not
+-- TODO: customizable "staleness" of repos (e.g. sync if timestamp X is older than timestamp Y on server)