doc/en/source_mirrors.xml

<?xml version='1.0' encoding="UTF-8"?>
<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/source_mirrors.xml,v 1.21 2004/10/26 14:04:53 jforman Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">

<guide link="/doc/en/source_mirrors.xml">
<title>Gentoo Linux Source Mirrors Policy</title>
<author title="Author">
  <mail link="klieber@gentoo.org">Kurt Lieber</mail>
</author>
<author title="Editor">
  <mail link="cshields@gentoo.org">Corey Shields</mail>
</author>
<author title="Editor">
  <mail link="bennyc@gentoo.org">Benny Chuang</mail>
</author>
<author title="Editor">
  <mail link="jforman@gentoo.org">Jeffrey Forman</mail>
</author>

<abstract>
This document explains the requirements for source mirrors.
</abstract>

<license/>
<version>1.3</version>
<date>June 28, 2004</date>

<chapter>
<title>Requirements</title>
<section>
<title>Minimum Bandwidth</title>
<body>

<p>
To properly host a source mirror, you should have a minimum of 5Mbps upstream
bandwidth.  ADSL and cable connections do not generally make adequate
connections for distfile hosts due to their limited upstream performance.
</p>

</body>
</section>
<section>
<title>Minimum Disk Space</title>
<body>

<p>
The space requirements depend on whether you choose to run a "Full" mirror or a
"Distfiles only" mirror. Full mirrors require 90 gigabytes of disk space.
Distfiles only mirrors require 40 gigabytes of space.
</p>

</body>
</section>
<section>
<title>Minimum User Count</title>
<body>

<p>
We ask that you support a minimum of 15 and preferrably 30 concurrent user
connections.
</p>

</body>
</section>
<section>
<title>Update Frequency</title>
<body>

<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>
</body>
</section>
</chapter>

<chapter>
<title>Implementation details</title>
<section>
<body>

<p>
For new source mirror requests, the procedure will be as follows:
</p>

<p>
Set up your server to rsync with ftp.ussg.iu.edu::gentoo-distfiles.  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>

<p>
Full mirrors must carry the following directories (plus any directories that
get added in the future):
</p>

<ul>
        <li>/releases</li>
        <li>/experimental</li>
        <li>/distfiles</li>
        <li>/snapshots</li>
        <li>/grp</li>
</ul>

<p>
Distfiles only mirrors need to carry the following directories:
</p>

<ul>
        <li>/distfiles</li>
        <li>/snapshots</li>
</ul>

<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>

<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> 

<p>
Additionally, you, the mirror admin, will be requested to subscribe to the
gentoo-mirrors mailing list (low traffic) so that you can follow all issues
associated with source mirrors.
</p>

<note>
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>.
</note>

<warn>
Do NOT email mirror-admin@gentoo.org for mirror requests, please file a bug. It makes mirror tracking easier on us.
</warn>

</body>
</section>
</chapter>

<chapter>
<title>Short FAQ</title>
<section>
<title>Q: Who should I contact regarding new mirrors or to get my mirror added to the Gentoo web site?</title>
<body>

<p>
A: Please file a bug on bugs.gentoo.org under the rsync category.
</p>

</body>
</section>
<section>
<title>Q: Who should I contact regarding mirror issues and maintenance?</title>
<body>

<p>
A: Please file a bug on bugs.gentoo.org under the rsync category.
</p> 

</body>
</section>
<section>
<title>Q: I run a private source mirror for my company.  Can I still access the private master source mirror?</title>
<body>

<p>
A: Because our resources are limited, we need to ensure we allocate them in
such a way to provide the maximum amount of benefit to our users.  As such, we
limit connections 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.
</p>

</body>
</section>

<section>
<title>Q: How do I find the mirror nearest to me?</title>
<body>

<p>
A: mirrorselect was designed to do this for you. If you haven't already run
<c>emerge mirrorselect</c>, then please do so.  Then run: <c>mirrorselect</c>.
An ncurses-based menu will display allowing you to select a mirror close to
you.
</p>

</body>
</section>
<section>
<title>Q: I don't have that much disk space.  Can I mirror part of the sources?</title>
<body>

<p>
A: Yes, if you are unable to mirror our full sources, you can elect to mirror
the following two directories only:
</p>

<ul>
        <li>/distfiles</li>
        <li>/snapshots</li>
</ul>

<p>
These two directories will require approximately 40GB of space and you will be
listed on our site as a distfiles-only mirror.
</p>

</body>
</section>
<section>
<title>Q: Do I have to turn on Directory Indexing for directories served up via HTTP?</title>
<body>

<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. 
</p>

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