Provide mirror setup instructions via README
[grml-mirrors.git] / README.md
1 Mirror setup for Grml.org
2 =========================
3
4 This Git repository provides the according information and configuration as used by the [Grml](http://grml.org/) project and its mirror infrastructure.
5
6 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/.
7 Your mirror site should make the contents of this directory available via HTTP, rsync and FTP at protocol://your.mirror/grml/
8
9 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.
10 Either mail us the according information to mirror (at) grml (dot) org or (even better) open a pull request.
11 Then we can integrate your mirror into our mirroring infrastructure, including the download.grml.org GeoIP balancer.
12
13 The status of Grml's mirror infrastructure can be checked at [mirror.grml.org](http://mirror.grml.org/).
14
15 Thanks for your interest and help in providing a Grml mirror!