| 1 |
<?xml version='1.0' encoding="UTF-8"?> |
| 2 |
<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/source_mirrors.xml,v 1.30 2006/04/03 09:54:43 neysx Exp $ --> |
| 3 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 4 |
|
| 5 |
<guide link="/doc/en/source_mirrors.xml"> |
| 6 |
|
| 7 |
<title>Gentoo Linux Source Mirrors Policy</title> |
| 8 |
|
| 9 |
<author title="Author"> |
| 10 |
<mail link="klieber@gentoo.org">Kurt Lieber</mail> |
| 11 |
</author> |
| 12 |
<author title="Editor"> |
| 13 |
<mail link="cshields@gentoo.org">Corey Shields</mail> |
| 14 |
</author> |
| 15 |
<author title="Editor"> |
| 16 |
<mail link="bennyc@gentoo.org">Benny Chuang</mail> |
| 17 |
</author> |
| 18 |
<author title="Editor"> |
| 19 |
<mail link="jforman@gentoo.org">Jeffrey Forman</mail> |
| 20 |
</author> |
| 21 |
|
| 22 |
<abstract> |
| 23 |
This document explains the requirements for source mirrors. |
| 24 |
</abstract> |
| 25 |
|
| 26 |
<!-- The content of this document is licensed under the CC-BY-SA license --> |
| 27 |
<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 28 |
<license/> |
| 29 |
<version>1.8</version> |
| 30 |
<date>2006-10-17</date> |
| 31 |
|
| 32 |
<chapter> |
| 33 |
<title>Requirements</title> |
| 34 |
<section> |
| 35 |
<title>Minimum Bandwidth</title> |
| 36 |
<body> |
| 37 |
|
| 38 |
<p> |
| 39 |
To properly host a source mirror, you should have a minimum of 5Mbps upstream |
| 40 |
bandwidth. ADSL and cable connections do not generally make adequate |
| 41 |
connections for distfile hosts due to their limited upstream performance. |
| 42 |
</p> |
| 43 |
|
| 44 |
</body> |
| 45 |
</section> |
| 46 |
<section> |
| 47 |
<title>Minimum Disk Space</title> |
| 48 |
<body> |
| 49 |
|
| 50 |
<p> |
| 51 |
The space requirements depend on whether you choose to run a "Full" mirror or a |
| 52 |
"Distfiles only" mirror. Full mirrors require 90 GB of disk space. Distfiles |
| 53 |
only mirrors require 50 GB of space. |
| 54 |
</p> |
| 55 |
|
| 56 |
</body> |
| 57 |
</section> |
| 58 |
<section> |
| 59 |
<title>Minimum User Count</title> |
| 60 |
<body> |
| 61 |
|
| 62 |
<p> |
| 63 |
We ask that you support a minimum of 15 and preferrably 30 concurrent user |
| 64 |
connections. |
| 65 |
</p> |
| 66 |
|
| 67 |
</body> |
| 68 |
</section> |
| 69 |
<section> |
| 70 |
<title>Update Frequency</title> |
| 71 |
<body> |
| 72 |
|
| 73 |
<p> |
| 74 |
All mirrors must be synchronized every four hours, starting at midnight in your |
| 75 |
local time zone. This helps distribute the load out over a period of time, |
| 76 |
rather than having all mirrors synchronize at the same time. |
| 77 |
</p> |
| 78 |
|
| 79 |
</body> |
| 80 |
</section> |
| 81 |
<section> |
| 82 |
<title>Mirror Needs</title> |
| 83 |
<body> |
| 84 |
|
| 85 |
<p> |
| 86 |
Your mirror may not be added immediately to our listing and given access to the |
| 87 |
private distribution point. We add mirrors on an as-needed basis so as not to |
| 88 |
clutter up the listing, and to provide an adequate amount of high speed |
| 89 |
mirrors. You are more than welcome to peek in #gentoo-mirrors on |
| 90 |
irc.freenode.org and chat up to see the status of your mirror being added to |
| 91 |
our official network. |
| 92 |
</p> |
| 93 |
|
| 94 |
</body> |
| 95 |
</section> |
| 96 |
</chapter> |
| 97 |
|
| 98 |
<chapter> |
| 99 |
<title>Implementation details</title> |
| 100 |
<section> |
| 101 |
<body> |
| 102 |
|
| 103 |
<p> |
| 104 |
For new source mirror requests, the procedure will be as follows: |
| 105 |
</p> |
| 106 |
|
| 107 |
<p> |
| 108 |
Set up your server to rsync with ftp.ussg.iu.edu::gentoo-distfiles. Once you |
| 109 |
have a complete mirror of that server, please file a bug report on <uri |
| 110 |
link="http://bugs.gentoo.org/enter_bug.cgi?product=Mirrors">bugs.gentoo.org</uri> |
| 111 |
under the <c>Mirrors</c> category stating that you have a new mirror and wish |
| 112 |
it to be added to the list of official mirrors. Please specify whether you |
| 113 |
wish to be a "Full" mirror or "Distfiles only" mirror. Distfiles |
| 114 |
only mirrors will be designated as such on the website. |
| 115 |
</p> |
| 116 |
|
| 117 |
<p> |
| 118 |
Full mirrors must carry the following directories (plus any directories that |
| 119 |
get added in the future): |
| 120 |
</p> |
| 121 |
|
| 122 |
<ul> |
| 123 |
<li>/releases</li> |
| 124 |
<li>/experimental</li> |
| 125 |
<li>/distfiles</li> |
| 126 |
<li>/snapshots</li> |
| 127 |
<li>/grp</li> |
| 128 |
</ul> |
| 129 |
|
| 130 |
<p> |
| 131 |
Distfiles only mirrors need to carry the following directories: |
| 132 |
</p> |
| 133 |
|
| 134 |
<ul> |
| 135 |
<li>/distfiles</li> |
| 136 |
<li>/snapshots</li> |
| 137 |
</ul> |
| 138 |
|
| 139 |
<p> |
| 140 |
We will then verify that the mirror exists and we can connect to it properly. |
| 141 |
Then, in the next 48-72 hours, we will determine if your mirror is syncing |
| 142 |
correctly and in accordance with this policy. |
| 143 |
</p> |
| 144 |
|
| 145 |
<p> |
| 146 |
If all steps went smoothly, we will then add you to our list of <uri |
| 147 |
link="/main/en/mirrors.xml">download mirrors</uri> on the main web site. We |
| 148 |
will also send you the login information for our private master distfile mirror |
| 149 |
which is only available to official Gentoo Linux source mirrors. |
| 150 |
</p> |
| 151 |
|
| 152 |
<p> |
| 153 |
Additionally, you, the mirror admin, will be requested to subscribe to the |
| 154 |
gentoo-mirrors mailing list (low traffic) so that you can follow all issues |
| 155 |
associated with source mirrors. |
| 156 |
</p> |
| 157 |
|
| 158 |
<note> |
| 159 |
Thanks for helping out Gentoo Linux users and developers! :) For any mirror |
| 160 |
administration issues or problems, please contact <mail |
| 161 |
link="mirror-admin@gentoo.org">mirror-admin@gentoo.org</mail>. |
| 162 |
</note> |
| 163 |
|
| 164 |
<warn> |
| 165 |
Do NOT email mirror-admin@gentoo.org for mirror requests, please file a bug. It |
| 166 |
makes mirror tracking easier on us. |
| 167 |
</warn> |
| 168 |
|
| 169 |
</body> |
| 170 |
</section> |
| 171 |
</chapter> |
| 172 |
|
| 173 |
<chapter> |
| 174 |
<title>Short FAQ</title> |
| 175 |
<section> |
| 176 |
<title> |
| 177 |
Q: Who should I contact regarding new mirrors or to get my mirror added to the |
| 178 |
Gentoo web site? |
| 179 |
</title> |
| 180 |
<body> |
| 181 |
|
| 182 |
<p> |
| 183 |
A: Please file a bug on bugs.gentoo.org under the <c>Mirrors</c> category. |
| 184 |
</p> |
| 185 |
|
| 186 |
</body> |
| 187 |
</section> |
| 188 |
<section> |
| 189 |
<title>Q: Who should I contact regarding mirror issues and maintenance?</title> |
| 190 |
<body> |
| 191 |
|
| 192 |
<p> |
| 193 |
A: Please file a bug on bugs.gentoo.org under the <c>Mirrors</c> category. |
| 194 |
</p> |
| 195 |
|
| 196 |
</body> |
| 197 |
</section> |
| 198 |
<section> |
| 199 |
<title> |
| 200 |
Q: I run a private source mirror for my company. Can I still access the |
| 201 |
private master source mirror? |
| 202 |
</title> |
| 203 |
<body> |
| 204 |
|
| 205 |
<p> |
| 206 |
A: Because our resources are limited, we need to ensure we allocate them in |
| 207 |
such a way to provide the maximum amount of benefit to our users. As such, we |
| 208 |
limit connections to our master rsync and distfile mirrors to public mirrors |
| 209 |
only. Users are welcome to use our regular mirror system to establish a |
| 210 |
private source mirror. |
| 211 |
</p> |
| 212 |
|
| 213 |
</body> |
| 214 |
</section> |
| 215 |
<section> |
| 216 |
<title>Q: How do I find the mirror nearest to me?</title> |
| 217 |
<body> |
| 218 |
|
| 219 |
<p> |
| 220 |
A: mirrorselect was designed to do this for you. If you haven't already run |
| 221 |
<c>emerge mirrorselect</c>, then please do so. Then run: <c>mirrorselect</c>. |
| 222 |
An ncurses-based menu will display allowing you to select a mirror close to |
| 223 |
you. |
| 224 |
</p> |
| 225 |
|
| 226 |
</body> |
| 227 |
</section> |
| 228 |
<section> |
| 229 |
<title> |
| 230 |
Q: I don't have that much disk space. Can I mirror part of the sources? |
| 231 |
</title> |
| 232 |
<body> |
| 233 |
|
| 234 |
<p> |
| 235 |
A: Yes, if you are unable to mirror our full sources, you can elect to mirror |
| 236 |
the following two directories only: |
| 237 |
</p> |
| 238 |
|
| 239 |
<ul> |
| 240 |
<li>/distfiles</li> |
| 241 |
<li>/snapshots</li> |
| 242 |
</ul> |
| 243 |
|
| 244 |
<p> |
| 245 |
These two directories will require approximately 50GB of space and you will be |
| 246 |
listed on our site as a distfiles-only mirror. |
| 247 |
</p> |
| 248 |
|
| 249 |
</body> |
| 250 |
</section> |
| 251 |
<section> |
| 252 |
<title> |
| 253 |
Q: Do I have to turn on Directory Indexing for directories served up via HTTP? |
| 254 |
</title> |
| 255 |
<body> |
| 256 |
|
| 257 |
<p> |
| 258 |
A: Directory Indexing is required for the /releases and /experimental |
| 259 |
directories, but can be turned off for all other directories (including |
| 260 |
/distfiles) if you wish. |
| 261 |
</p> |
| 262 |
|
| 263 |
</body> |
| 264 |
</section> |
| 265 |
|
| 266 |
<section> |
| 267 |
<title>Q: Do I have to mirror historical? I mean, it is old releases.</title> |
| 268 |
<body> |
| 269 |
|
| 270 |
<p> |
| 271 |
A: Of course not, it is quite a bit of data. In your rsync command, add |
| 272 |
<path>--exclude=/releases/historical</path> to your rsync options. This will |
| 273 |
exclude historical and save you quite a bit of space. |
| 274 |
</p> |
| 275 |
|
| 276 |
</body> |
| 277 |
</section> |
| 278 |
</chapter> |
| 279 |
</guide> |