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