Provide mirror setup instructions via README
authorMichael Prokop <mika@grml.org>
Tue, 21 Oct 2014 07:20:47 +0000 (09:20 +0200)
committerMichael Prokop <mika@grml.org>
Tue, 21 Oct 2014 07:36:12 +0000 (09:36 +0200)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..b2b6e7e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+Mirror setup for Grml.org
+=========================
+
+This Git repository provides the according information and configuration as used by the [Grml](http://grml.org/) project and its mirror infrastructure.
+
+If you want to provide a Grml mirror you should mirror at a fixed interval, preferably every 4 hours, using rsync from rsync://ftp-master.grml.org/grml/.
+Your mirror site should make the contents of this directory available via HTTP, rsync and FTP at protocol://your.mirror/grml/
+
+Please take a look at the file [Mirrors.masterlist](https://github.com/grml/grml-mirrors/blob/master/Mirrors.masterlist) in this repository to see what kind of information we'd need from you.
+Either mail us the according information to mirror (at) grml (dot) org or (even better) open a pull request.
+Then we can integrate your mirror into our mirroring infrastructure, including the download.grml.org GeoIP balancer.
+
+The status of Grml's mirror infrastructure can be checked at [mirror.grml.org](http://mirror.grml.org/).
+
+Thanks for your interest and help in providing a Grml mirror!