Attachment #21092 for bug #37037

View | Details | Raw Unified | Return to bug 37037
Collapse All | Expand All




        <firstname>Valentino</firstname>  
        <surname>Vaschetto</surname>
        <affiliation>
          <address><email>logo@FreeBSD.org</email></address>
        </affiliation>
      </author>
      <author>

        state (at 4.5-RELEASE). Further development and
        releases will only increase the required amount.
        Also make sure, to keep some (ca. 10-20%) extra space
        around, just to be sure. Here are some approximate figures:
        Here are some approximate figures:
      </para>
      <itemizedlist>
        <listitem><para>Full FTP Distribution: 60 GB</para></listitem>

        estimates here:
      </para>
      <itemizedlist>
         <listitem><para>Local site, no public access: basically no
		 minimum.</para></listitem>
         <listitem><para>Unofficial public site: 34 Mbps is a good
		 start.</para></listitem>
         <listitem><para>Official site: &gt; 100 Mbps is recommended, also
		 your host should be connected as close as possible to your border
		 router.</para></listitem>
      </itemizedlist>
    </sect2>
    <sect2 id="mirror-system">

        impact on CPU and memory requirements. Especially
        rsync is considered a memory hog, and CVSup does 
        indeed consume some CPU. For AnonCVS it can
        even be required to set up a Memory resident filesystem
		(MFS) of at least 300 MB, so you need to take this into
		account for your memory requirements.
      </para>
      <para>
        You also want to consider a fast disk subsystem.
        Operations on the CVS repository require a fast
        disk subsystem (RAID is greatly advised). A SCSI
		controller that has a cache of its own will also
		be of value since most of these services incur a
		very large number of small modifications to the disk.
      </para>
	  <para>You may also like to experiment with enlarging the portion
	  of system memory which is used for the filesystem buffer cache.
	  This will also help to reduce the quantity of disk access. This
	  can be done with the BUFCACHEPERCENT kernel option. The default is
	  to use 5% of system memory.</para>
    </sect2>
    <sect2 id="mirror-services">
      <title>Services to offer</title>
      <para>Every mirror site is required to have a set of core services
	  available. Optionally you can also add additional services. This
	  section explains which services you can provide and how to go
	  about implementing them.</para>
        can be used to provide this service.
      </para>
      <sect3 id="mirror-serv-ftp">
        <title>FTP (required for FTP fileset)</title>
        <para>
          This is one of the most basic services, and it is required for
		  each mirror, offering public FTP distributions. FTP access must
		  be anonymous, and no upload/download ratios are allowed (a
		  ridiculous thing anyway). Upload capability is not required (and
		  <emphasis>must</emphasis> never be allowed for the FreeBSD file
		  space). Also the FreeBSD archive should be available under the
		  path <filename>/pub/FreeBSD</filename>.
          Also the FreeBSD archive should be available under
          the path <filename>/pub/FreeBSD</filename>.
        </para>
        <para>
          There is lot of software available which can be set up to allow
		  anonymous FTP (in alphabetical order).
          (in alphabetical order).
          <itemizedlist>
            <listitem><para><filename>/usr/libexec/ftpd</filename>:
			FreeBSD's own <application>ftpd</application>, can be used. Be
			sure to read &man.ftpd.8;.</para></listitem>
            <listitem><para><filename role="package">ftp/ncftpd</filename>:
			A commercial application. Available free for educational
			purposes.</para></listitem>
            <listitem><para><filename role="package">ftp/oftpd</filename>:
			An ftpd designed with security as a main focus.</para></listitem>
            <listitem><para><filename role="package">ftp/proftpd</filename>:
			A modular and very flexible ftpd.</para></listitem>
            <listitem><para><filename role="package">ftp/pure-ftpd</filename>:
			Another ftpd developed with security in mind.</para></listitem>
            <listitem><para><filename role="package">ftp/twoftpd</filename>:
			As above.</para></listitem>
            <listitem><para><filename role="package">ftp/vsftpd</filename>:
			The <quote>very secure</quote> ftpd.</para></listitem>
            <listitem><para><filename role="package">ftp/wu-ftpd</filename>:
			The ftpd from Washington University. It has become infamous
			because of the huge number of security issues that have been
			found in it. If you do choose to use this software be sure to
			keep it up to date.</para></listitem>
              <para><filename role="package">ftp/wu-ftpd</filename>: The widely used ftpd from Washington
              University. It became sort of infamous, because of the huge
              amount of security issues that became obvious in wu-ftpd.
              It also around for a long time, which can be positive 
              (experience) or negative (lots of bloated code).</para>
            </listitem>
          </itemizedlist>
		  
          FreeBSD's ftpd, proftpd, wu-ftpd and ncftpd are among the most
		  commonly used. The others do not have a large userbase among
		  mirror sites.
        </para>
      </sect3>
      <sect3 id="mirror-serv-rsync">
        <title>rsync (optional for FTP fileset)</title>
        <para>
          rsync is often also offered for convenience, for the contents
		  of the FTP area of FreeBSD. The protocol is different from
		  FTP, specifically, it requires much less bandwidth, as only
		  transfers the differences between files. 
          rsync does require significant amount of memory for
          are transferred, not whole files. 
          Rsync does require significant amount of memory for
          each instance. The size depends on the size of
          the synced module in terms of number of directories and 
          files. rsync can use <command>rsh</command> and
          <command>ssh</command> (now default) as a transport,
          or use it's own protocol for stand-alone access
          (this is the preferred method for public rsync servers).
          Authentication, connection limits, and other restrictions
          may be applied. At the time of writing there is just one
		  software package available:
          <itemizedlist>
		    <listitem><para><filename role="package">net/rsync</filename>
			</para></listitem>
          </itemizedlist>
        </para>
      </sect3>
      <sect3 id="mirror-serv-http">
        <title>HTTP (required for webpages, optional for FTP fileset)</title>
        <para>
          If you want to offer the FreeBSD webpages, you need to
		  install a webserver. You may offer the FTP fileset via HTTP,
		  optionally. You may use your own choice of Webserver software.
          Some argue HTTP is more efficient for download, but
          I cannot tell. The most commonly
          used httpd is Apache, although there are others around,
          take a look at <filename>/usr/ports/www</filename>.
          <itemizedlist>
            <listitem><para><filename role="package">www/apache13</filename>:
			Apache is the most widely deployed Webserver on the Internet. It
			is used extensively by the FreeBSD Project. You may also
			wish to use the next generation of the Apache Webserver,
			available in the ports collection as <filename
			role="package">www/apache2</filename>.</para></listitem>
			<listitem><para><filename role="package">www/thttpd</filename>:
			If you are going to be serving a lot amount of static content
			you may find that using an application such as tHttpd is more
			efficent than Apache. It is optimized for excellent performance
			on FreeBSD.</para></listitem>
			<listitem><para><filename role="package">www/boa</filename>:
			Boa is another alternative to tHttpd and Apache. It should
			provide considerably better performance than Apache for purely
			static content. It does not, at the time of writing, contain the
			same set of optimizations for FreeBSD that are found in tHttpd.
			</para></listitem>
          </itemizedlist>
        </para>
      </sect3>

          the use with CVS repositories. If you want to offer the
          FreeBSD CVS repository, you really want to consider
          offering it via CVSup. Still it is possible to offer
          the CVS repository via AnonCVS, FTP, rsync or HTTP, but
          people would not benefit from CVSup access. 
          CVSup was developed by &a.jdp;.
          It is a bit tricky to install on non-FreeBSD platforms, 

          a Modula-3 environmen. John Polstra has built a 
          stripped down version of M3, that is sufficient to
          run CVSup, and can be installed much easier. 
          See <ulink
		  url="http://www.polstra.com/projects/freeware/ezm3/">Ezm3</ulink>
		  for details. Related ports are:

          <itemizedlist>
            <listitem>
              <para>
			    <filename role="package">net/cvsup</filename>
				: The native CVSup port (client and server) which
				requires <filename role="package">lang/ezm3</filename>
				now.
			  </para>
            </listitem>
            <listitem>
              <para>
			    <filename role="package">net/cvsup-mirror</filename>
				: The CVSup mirror kit, which requires
				<filename role="package">net/cvsup</filename>, and
				configures it for use as a mirror. Some site administrators
				may require a different setup.
              </para>
            </listitem>
          </itemizedlist>
		  Further information about <application>CVSup</application> can
		  be found its <ulink
		  url="http://polstra.com/projects/freeware/CVSup/">website</ulink>.
		  <!-- polstra.com works just as well as www.polstra.com and
		  makes the line wrapping less ugly  -->
          This page stil refers to the S1G bug, that was present
          in <application>CVSup</application>. Maybe
          John will setup a generic download-site to get
          static binaries for various platforms.
        </para>
        <para> 
          It is possible to use CVSup to offer any kind of fileset, not
		  just CVS repositories, but configuration can be complex.
		  <application>CVSup</application> is more intensive to run on
		  both the server and client than the other distribution
		  methods. However it is significantly faster and consumes a lot
		  less bandwidth than the FTP service.
        </para>
        <note>
          <para>
            Please have look at the <application>CVSup</application>
			documentation, for example &man.cvsup.1; and consider using the
			<option>-s</option> option, as it can reduce the workload
			considerably.
          </para>
        </note>
      </sect3>

          <emphasis>pserver</emphasis> or via <command>ssh</command>
          (we don't consider <command>rsh</command>).
          For anonymous access, <emphasis>pserver</emphasis> is
          very well suited, but it is possible to offer
		  <command>ssh</command> access as well. For the
		  <command>ssh</command> service you can use a login wrapper to
		  secure the anonymous account. It does a chroot, and therefore
          requires the CVS repository to be available under the
          anonymous user's homedirectory, which may not be possible
          for all sites. If you just offer <emphasis>pserver</emphasis>

          FreeBSD. You need to enable access via <command>inetd</command>,
          so add an entry into your <filename>/etc/inetd.conf</filename>
          like this:
          <programlisting>cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --allow-root=/home/ncvs pserver
cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --allow-root=/home/ncvs pserver
          </programlisting>
          See the manpage for details of the options. See also the cvs
		  <emphasis>info</emphasis> page, about how additional ways, to
		  make sure, access is read-only. It is advisable, that you create
		  an unprivileged account, preferrably called
		  <username>anoncvs</username>. Also you need to create a file
		  <filename>passwd</filename> in your mirror's
		  <filename>CVSROOT</filename> subdirectory and assign a CVS password
		  (empty or <literal>anoncvs</literal>) to that user. The
		  example directory <filename>/anoncvstmp</filename> is a special
		  purpose memory based filesystem. It is not required but advised,
		  since &man.cvs.1; creates a shadow directory structure in your
		  <filename>/tmp</filename> which is not used after the operation,
		  but slows things dramatically, if real disk operations are required.
          Here is an excerpt from <filename>/etc/fstab</filename>, how to set
		  up such a MFS:
          <programlisting>/dev/da0s1b /anoncvstmp mfs rw,-s=786432,-b=4096,-f=512,-i=560,-c=3,-m=0,nosuid,nodev 0 0
/dev/da0s1b /anoncvstmp mfs rw,-s=786432,-b=4096,-f=512,-i=560,-c=3,-m=0,nosuid,nodev 0 0
          </programlisting>
		  Enabling <emphasis>SoftUpdates</emphasis> on a conventional
		  <filename>/tmp</filename> location, or mounting it with the
		  <option>async</option> mode in <filename>/etc/fstab</filename>
		  should also help to improve performance marginally.
          This was suggested by &a.jdp;.
        </para>
      </sect3>
   </sect2>

  <sect1 id="mirror-howto">
    <title>How to mirror FreeBSD</title>
    <para>
      Ok now, you know the requirements, and how to offer the services,
	  but not how to get it. This section explains how to actually mirror
      the various parts of FreeBSD, what tools to use, and where to mirror
	  from.
      and where to mirror from.
    </para>
    <sect2 id="mirror-ftp">
    <title>FTP</title>
      <para>
        The FTP area is the largest amount of data, that needs to be
		mirrored. It includes the <emphasis>distributions sets</emphasis>,
		required for network installation, the
		<emphasis>branches</emphasis>, the <emphasis>ISO Images</emphasis>
		for making CD-Roms with the installation distribution, a live
		filesystem, and lots of packages, the ports tree, and distfiles.
		All of course for various FreeBSD versions, and
		<emphasis>i386</emphasis> and <emphasis>alpha</emphasis>
		architectures.
		<note>
		  <para>You can expect the amount of space required by the FTP
		  distribution to grow in size as the number of ports and
		  supported architectures grows.</para>
		</note>
      </para>
      <sect3 id="mirror-ftp-ftp">
        <title>With FTP mirror</title>
        <para>You can use a <application>FTP mirror</application>
		program, to get the files. There are a lot around, and widely
		used, like:
          widely used, like:
          <itemizedlist>
            <listitem>
			  <para>
			    <filename role="package">ftp/mirror</filename>
			  </para>
			</listitem>
            <listitem>
			  <para>
			    <filename role="package">ftp/ftpmirror</filename>
			  </para>
			</listitem>
            <listitem>
			  <para>
			    <filename role="package">ftp/emirror</filename>
			  </para>
			</listitem>
            <listitem>
			  <para>
			    <filename role="package">ftp/spegla</filename>
			  </para>
			</listitem>
            <listitem>
			  <para>
			    <filename role="package">ftp/omi</filename>
			  </para>
			</listitem>
            <listitem>
			  <para>
			    <filename role="package">ftp/wget</filename>
			  </para>
			</listitem>
          </itemizedlist>

          <filename role="package">ftp/mirror</filename> was very popular, but seemed
          to have some drawbacks, as its written in perl,
          and did have real problems on mirroring large
          directories like a FreeBSD site. There are rumours, that
          the current version has fixed this, by allowing
          to specify a different algorithm for comparing
          the directory structure.
        </para>
        <para>
          FTP is not good for mirroring, since it transfers each whole file,
		  if it has changed, and does not create a single data stream, that
		  will benefit from a large TCP congestion window. 
          a large TCP congestion window. 
        </para>
      </sect3>
      <sect3 id="mirror-ftp-rsync">
        <title>With rsync</title>
        <para>
          A better way, to mirror the FTP area is
		  <application>rsync</application>. You can install the port
		  <filename role="package">net/rsync</filename> and then use
		  rsync to sync with your upstream host. 
		  <application>rsync</application> is already mentioned in
		  <xref linkend="mirror-serv-rsync">. Since
		  <application>rsync</application> access is not required,
		  your preferred upstream site may not allow it. In this case
		  you can consider using an upstream server, that offers it,
		  for the benefits of rsync. 
          of rsync. 
          <note>
            <para>
              Since the number of <application>rsync</application> 

          Consult the documentation for <application>rsync</application>,
          which is also available at
          <ulink url="http://rsync.samba.org/">http://rsync.samba.org/</ulink>
          about the various options to be used with rsync. Also you might
          Also you might
          want to set up a script framework, that calls such a command
          via &man.cron.8;.
        </para>

      <sect3 id="mirror-ftp-cvsup">
        <title>With CVSup</title>
        <para>
          A few sites, including the one-and-only
		  <hostid role="fqdn">ftp-master.freebsd.org</hostid> even offer
		  <application>CVSup</application> to mirror the contents of the
		  FTP space. You need to install a <application>CVSup</application>
          client, preferrably from the port:
		  <filename role="package">net/cvsup-without-gui</filename>.
          (Also reread <xref linkend="mirror-serv-cvsup">.) A sample supfile,
		  suitable for <hostid role="fqdn">ftp-master.freebsd.org</hostid>
          looks like this:
          <programlisting>
          #

          FreeBSD-archive release=all preserve
          </programlisting>

          Distribution via <application>CVSup</application> is only
		  available from certain sites.
          it is only available from few sites. In fact I just know
          <hostid>ftp-master.freebsd.org</hostid> for sure.
        </para>
      </sect3>
    </sect2>
    <sect2 id="mirror-cvs">
      <title>Mirroring the CVS repository</title>
      <para>
        Again you have various possibilities, but using
		<link linkend="mirror-cvs-cvsup">CVSup</link> is reccomended.
      </para>
      <sect3 id="mirror-cvs-cvsup">
        <title>Using CVSup</title>
        <para>
          <application>CVSup</application> was already described to some
          detail in <xref linkend="mirror-serv-cvsup"> and
		  <xref linkend="mirror-ftp-cvsup">.
        </para>
        <para>
          Here we just describe an example to set up the
		  <filename>supfile</filename>:
          <programlisting>
          #
          # FreeBSD CVS supfile from master server

          cvs-all
          </programlisting>

          You should also have a look at the sample files available in
		  <filename>/usr/share/examples/cvsup/</filename>.
        </para>
      </sect3>
      <sect3 id="mirror-cvs-other">
        <title>Using other methods</title>
        <para>
          Using other methods than <application>CVSup</application> are
          generally not recommended. We describe them in short here 
          anyway. Since most sites offer the CVS repository as part of
		  the FTP fileset under the path
		  <filename>/pub/FreeBSD/development/FreeBSD-CVS</filename>, the
		  following methods can of course be used.
          <itemizedlist>
            <listitem>
			  <para>
			    <application>FTP</application>
			  </para>
			</listitem>
            <listitem>
			  <para>
			    <application>rsync</application>
			  </para>
			</listitem>
          </itemizedlist>

          If you find a site, that supports it, you could use
          <filename role="package">net/sup</filename>, but it is inferior
		  to <application>CVSup</application> and it's deficiencies
		  caused &a.jdp; to develop <application>CVSup</application> in the
		  first place, so it is clearly not recommended.

          <important>
            <para>
			  To mirror the AnonCVS repository you will need to use a
			  method other than CVS.
              you to access the repository itself, but only checked
              out versions of the modules.
            </para>
          </important>
        </para>

        on a regular basis, maybe just after your repository was updated.
        Of course, the files need to remain in a directory, available
        for public WWW access. The installation and configuration of a 
        webserver is not diskussed here.
      </para>
      <para>
        If you don't have a local repository, you can use 
        <application>CVSup</application> to maintain an <quote>up to date
		copy</quote> of the www pages. A sample supfile can be found in
        <filename>/usr/share/examples/cvsup/www-supfile</filename> and
        looks like this:
        <programlisting>
        #
        # WWW module supfile for FreeBSD

        </programlisting>
     </para>
     <para>
       Using <filename role="package">ftp/wget</filename> to index and
	   mirror the data using FTP or HTTP is <emphasis>not</emphasis>
	   reccomended.
     </para>
     <sect3 id="mirror-www-doc">
       <title>Mirroring the FreeBSD documentation</title>

         As the documentation is referenced a lot from the 
         webpages, it is recommended, that you mirror the 
         FreeBSD documentation as well. However, this is not
		 as easy to do.
       </para>
       <para>
         First of all, you should get the doc sources,

         </programlisting>
       </para>
       <para>
         Then you need to install a couple of ports. You are lucky, that
		 there is a meta-port:
		 <filename role="package">textproc/docproj</filename> to do the work
         for you. You need to setup some environment variables, like
         <literal>SGML_CATALOG_FILES</literal>, also have a look at your
		 <filename>/etc/make.conf</filename> (copy
		 <filename>/etc/defaults/make.conf</filename> if you do not have
		 a <filename>/etc/make.conf</filename>), and look at the
         <literal>DOC_LANG</literal> variable. Now you are probably ready
		 to run <command>make</command> in you doc directory
		 (<filename>/usr/share/doc</filename> by default) and build the
		 documentation. Again you need to make it accessible for your
		 webserver and make sure, the links point to the right location.
         Again you need to make it accessible for your webserver
         and make sure, the links point to the right location.
         <important>
           <para>
             The building of the documentation, as well as lots of side
			 issues is documented itself in: <ulink url="http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/">fdp-primer</ulink>.
             <ulink url="http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/">fdp-primer</ulink>.
             Please read this piece of documentation, especially if you
             have problems, building the documentation.
           </para>
         </important>
         <note>
           <para>
           XXX MAYBE THIS CAN BE LINKED FROM WITHIN - NOT USING AN ABSOLUTE URL XXX
           </para>
         </note>
       </para>
     </sect3>
   </sect2>

  <sect1 id="mirror-where">
    <title>Where to mirror from</title>
    <para>
      This is an important issue. So this section will spend some effort
	  to explain the issues you must consider.
    </para>
    <sect2 id="mirror-where-organisation">
      <title>A few words about the organisation</title>
      <para>
        Mirrors are organised by country. All
        official mirrors have a DNS entry of the form
        <hostid role="fqdn">ftpX.CC.freebsd.org</hostid>. Where 
        <emphasis>CC</emphasis> (i.e. country code) is the
        <emphasis>top level domain</emphasis>
        of the country, where this mirror is located;
        and <emphasis>X</emphasis> is a number,
        telling that the host would be the <emphasis>Xth</emphasis>
        mirror in that country.
        (Same applies to <hostid role="fqdn">cvsupX.CC.freebsd.org</hostid>,
        <hostid role="fqdn">wwwX.CC.freebsd.org</hostid>, etc.)
        There are mirrors with no <emphasis>CC</emphasis> part.
        These are usually located in the US, but it is not a requirement.
        <hostid role="fqdn">ftp.freebsd.org</hostid> is currently located
		in Denmark and is just another mirror (i.e. it is
		<emphasis>not</emphasis> the master site).
      </para>
      <para>
        Additionally there exists a hierarchy of mirrors, which

        The master sites are not referred to, but can be
        described as <emphasis>Tier-0</emphasis>. Mirrors
        that mirror from these sites can be considered
        <emphasis>Tier-1</emphasis>, mirrors of
		<emphasis>Tier-1</emphasis>-mirrors, are <emphasis>Tier-2</emphasis>,
		etc.  Official sites are encouraged to be of a low
		<emphasis>tier</emphasis>, but the lower the tier, the higher the
		requirements in terms as described in
		<xref linkend="mirror-requirements">.
        Also access to low-tier-mirrors may be restricted, and access to
		master sites is definetly restricted. The
		<emphasis>tier</emphasis>-hierarchy is not reflected by DNS and
		generally not documented anywhere, except for the master sites.
		However, official mirrors with low numbers, like 1-4, are usually
		<emphasis>Tier-1</emphasis> (this is just a rough hint, and there's
		no rule).
      </para>
    </sect2>
    <sect2 id="mirror-where-where">
      <title>Ok, but where should I get the stuff now?</title>
      <para>
        The short answer is: from the site, that is closest to you in
		internet terms, or that gives you the fastest access. 
        the fastest access. 
      </para>
      <sect3 id="mirror-where-simple">
        <title>I just want to mirror from somewhere!</title>
        <para>
          If you have no special intentions or requirements, the statement
		  in <xref linkend="mirror-where-where"> applies.  This means:
          applies.  This means:
        </para>
        <procedure>
          <step>
            <para>
              Look at available mirrors in your country.
              The
			  <ulink url="http://www.freebsdmirrors.org/FBSDsites.php3">FreeBSD
              Mirror Database</ulink> can help you with this.
            </para>
          </step>
          <step>
            <para>
              Check roughly those, which provide fastest access (number of
			  hops, round-trip-times) and offer the services you intend to
              use (like <application>rsync</application> or
			  <application>CVSup</application>).
              or <application>CVSup</application>).
            </para>
          </step>
          <step>
            <para>
              Contact the admins of your chosen site, stating your
              request, and asking about their terms and policies.
              policies.
            </para>
          </step>
          <step>

          In general the description in <xref linkend="mirror-where-simple">
          still applies. Of course you may want to put some
          weight on the fact, that your upstream should be of
          a low tier. There are some further considerations about
		  <emphasis>official</emphasis> mirrors, that are described in
		  <xref linkend="mirror-official">.
        </para>
      </sect3>
      <sect3 id="mirror-where-master">
        <title>I want to access the master sites!</title>
        <para>
          If you have good reasons, and good prerequesites, you may want
		  and get access to one of the  master sites. Access to these sites
		  is restriced, and there are special policies for access. If you are
		  already an <emphasis>official</emphasis> mirror, this certainly
		  helps you getting access. In any other case make sure your country
		  really needs another mirror. If it already has three or more, ask
          In any other case make sure your country really needs another mirror.
          If it already has three or more, ask
          the &a.hubs; first.
        </para>
        <para>
          There are just two master sites, for the FTP fileset and for the
		  CVS repository (the webpages and docs are obtained from CVS, so
		  there is no need for it).
        </para>
        <sect4 id="mirror-where-master-ftp">
          <title>ftp-master.freebsd.org</title>

            This is the master site for the FTP fileset. 
          </para>
          <para>
            <hostid role="fqdn">ftp-master.FreeBSD.org</hostid> provides
            <application>rsync</application> and
			<application>CVSup</application> access, rather in addition to
			ftp protocol. Refer to <xref linkend="mirror-ftp-rsync"> and
            <xref linkend="mirror-ftp-cvsup"> how to access via these
			protocols.
          </para>
          <para>
            Mirrors should be encouraged to also allow
			<application>rsync</application> access for the FTP contents,
			since they are <emphasis>Tier-1</emphasis>-mirrors.
          </para>
          <para>
            To get access to
			<hostid role="fqdn">ftp-master.FreeBSD.org</hostid>, you need
			to contact &a.peter;.
          </para>
          <para>
            Mirrors should be encouraged to also allow <application>rsync</application>
            access for the FTP contents, since they are
            <emphasis>Tier-1</emphasis>-mirrors.
          </para>
          <para>
            To get access to <hostid>ftp-master.FreeBSD.org</hostid>,
            you need to contact &a.peter;.
          </para>
        </sect4>
        <sect4 id="mirror-where-master-cvsup">
          <title>cvsup-master.freebsd.org</title>

            This is the master site for the CVS repository.
          </para>
          <para>
            <hostid role="fqdn">cvsup-master.FreeBSD.org</hostid> provides
            <application>CVSup</application> access only. See
			<xref linkend="mirror-cvs-cvsup"> for details.
          </para>
          <para>
            To get access, you need to contact &a.jdp;. Make sure you read
            <ulink url="http://people.freebsd.org/~jdp/cvsup-access/">
			FreeBSD CVSup Access Policy</ulink> first!
            first!
          </para>
          <para>
            Set up the required authentication by following
            <ulink url="http://people.freebsd.org/~jdp/cvpasswd/">these
            instructions</ulink>. Make sure you specify the server as
            <hostid role="fqdn">freefall.freebsd.org</hostid> on the
			cvpasswd command line, as described in this document, even
			when you are contacting
			<hostid role="fqdn">cvsup-master.freebsd.org</hostid>
          </para>
        </sect4>
      </sect3>

      <itemizedlist>
        <listitem>
          <para>
            Have a <hostid>freebsd.org</hostid> DNS entry (usually a
			CNAME).
          </para>
        </listitem>
        <listitem>
          <para>
            Are listed as an official mirror in the FreeBSD documentation
			(The Handbook).
          </para>
        </listitem>
      </itemizedlist>

    <sect2 id="mirror-official-requirements">
      <title>Special Requirements for official (tier-1) mirrors</title>
      <para>
        It is not so easy to state requirements for all official mirrors,
		since the project is more tolerant here. It is more easy to say,
        what <emphasis>official tier-1 mirrors</emphasis> are required to.
		All other official mirrors, can consider this a big
		<emphasis>should</emphasis>.
        can consider this a big <emphasis>should</emphasis>.
        <note>
          <para>
            The following applies mainly to the FTP fileset,

      <para>
        Tier-1 mirrors are required to:
        <itemizedlist>
          <listitem>
		    <para>To carry the complete fileset</para>
		  </listitem>
          <listitem>
		    <para>Allow access to other mirror sites</para>
		  </listitem>
          <listitem>
		    <para>Provide <application>FTP</application> and 
            <application>rsync</application> access</para>
		  </listitem>
        </itemizedlist>

        Furthermore, admins should be subscribed to the &a.hubs;.
        See <ulink url="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/eresources.html#ERESOURCES-MAIL">this link</ulink> for details, how
		to subscribe.
      </para>
      <important>
        <para>It is <emphasis>very</emphasis> important for a hub
		administrator, especially Tier-1 hub admins, to check the
		<ulink
		url="http://www.freebsd.org/releases/4.6R/schedule.html">release
		schedule</ulink> for the next FreeBSD release. This is important
		because after a release there is a large load spike on all mirrors.
		</para>
        <para>
          It is also eminent that hub administrators try to keep their
		  mirrors as up-to-date as possible (again, even more crucial for
		  Tier-1 mirrors). If Mirror1 doesn't update for a while, lower
		  tier mirrors will begin to mirror old data from Mirror1 and thus
		  begins a downward spiral... Keep your mirrors up to date!
        </para>
      </important>
    </sect2>
    <sect2 id="mirror-official-become">
      <title>How to become official then?</title>
      <para>
        An interesting questions, especially, since the state of beeing
		official comes with some benefits, like a much higher bill from
		your ISP, as more people will be using your site. Also it may be
		a key requirement, to get access to a master site.
        to a master site.
      </para>
      <para>
        Before applying, please consider (again) if another official mirror
		is really needed for your region. Ask on the &a.hubs;, if in doubt.
        your region. Ask on the &a.hubs;, if in doubt.
      </para>
      <para>Ok, here is how to do it:</para>
      <procedure>
        <step>
          <para>
            Get the mirror running in first place (maybe not using a
			master site, yet).
          </para>
        </step>
        <step>

            in <xref linkend="mirror-where-organisation">.
          </para>
          <para>
            If there is no subdomain delegated, yet, for your country, you
			probably need to contact <email>hostmaster@freebsd.org</email>,
            <email>hostmaster@freebsd.org</email>,
            however, you can try the &a.hubs; first.
          </para>
        </step>

      <itemizedlist>
        <listitem>
          <para>ftp2.FreeBSD.org - <email>grisha@ispol.com</email> -
            <ulink url="http://people.freebsd.org/~logo/ftp2/">
			Bandwidth</ulink>
          </para>
        </listitem>
        <listitem>
          <para>ftp.is.FreeBSD.org - <email>oli@isnic.is</email> - 
            <ulink url="http://www.rhnet.is/status/draupnir/draupnir.html">
			Bandwidth</ulink>
			<ulink url="http://www.rhnet.is/status/ftp/ftp-notendur.html">
			FTP sessions</ulink>
			<ulink url="http://www.rhnet.is/status/ftp/http-notendur.html">
			HTTP sessions
            </ulink>
          </para>
        </listitem>
        <listitem>
          <para>ftp.cz.FreeBSD.org - <email>cejkar@fit.vutbr.cz</email> -
            <ulink url="http://www.cz.FreeBSD.org/stats/mrtg/net.html">
			Bandwidth</ulink>
            <ulink url="http://www.freebsd.cz/stats/mrtg/ftpd.html">
			FTP sessions</ulink>
            <ulink url="http://www.freebsd.cz/stats/mrtg/rsyncd.html">
			rsync sessions</ulink>
          </para>
        </listitem>
        <listitem>
          <para>ftp4.de.FreeBSD.org - <email>dl@leo.org</email> -
            <ulink url="http://admin.leo.org/mrtg/ftpusers/ftpusers.html">
			FTP sessions</ulink>
            <ulink url="http://admin.leo.org/mrtg/rsync/rsync.html">
			rsync sessions</ulink>
            <ulink url="http://admin.leo.org/mrtg/traffic/atleo5/traffic_atleo5.html">Bandwidth</ulink>
          </para>
        </listitem>
      </itemizedlist>

      <title>CVSup site stats</title>
      <itemizedlist>
        <listitem>
          <para>
		    <hostid role="fqdn">cvsup5.FreeBSD.org</hostid> -
			<email>staff@blackened.com</email> -
			<ulink url="http://cvsup.freebsd.blackened.com/cvsup.freebsd.html">
			CVSup sessions</ulink>
		  </para>
        <listitem>
          <para>
		    <hostid role="fqdn">cvsup[23456].jp.FreeBSD.org</hostid> -
		    <email>kuriyama@FreeBSD.org</email> -
			<ulink url="http://home.jp.freebsd.org/stats/mrtg/cvsup/">
			CVSup sessions</ulink>
		  </para>
        </listitem>
        <listitem>
          <para>
		    <hostid role="fqdn">cvsup.cz.FreeBSD.org</hostid> -
		    <email>cejkar@fit.vutbr.cz</email> -
		    <ulink url="http://www.freebsd.cz/stats/mrtg/cvsupd.html">
			CVSup sessions</ulink>
		  </para>
        </listitem>
        <listitem>
          <para>
		    <hostid role="fqdn">[cvsup3|anoncvs].de.FreeBSD.org</hostid> -
			<email>dl@leo.org</email> -
            <ulink url="http://admin.leo.org/mrtg/cvsup/cvsup.html">
			CVSup sessions</ulink>
		  </para>
        </listitem>
      </itemizedlist>
    </sect2>

Return to bug 37037