/[gentoo]/xml/htdocs/doc/en/source_mirrors.xml
Gentoo

Diff of /xml/htdocs/doc/en/source_mirrors.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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