os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

- Clean up wording about FTP servers and web servers.

Browse source 
- <application>ify.
- Add missing "this".
- Remove a few occurrences of "probably".
- Fix a link to the FDP Primer and remove some incorrect notes that should have been comments.
- Correct that public CVS mirrors should sync once an hour.
- Fix various grammar nits.
- Remove a note about needing to use make(1) to build the website.

Approved by:	ceri@
This commit is contained in:
Brad Davis 2006-04-19 08:27:23 +00:00
parent 48cc251fea
commit fcbded9e42
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=27586
1 changed files with 29 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

63
en_US.ISO8859-1/articles/hubs/article.sgml
View file

@ -203,7 +203,7 @@
</itemizedlist>
FreeBSD's <application>ftpd</application>, <application>proftpd</application>,
<application>wu-ftpd</application> and maybe <application>ncftpd</application>
are among the most commonly ones.
are among the most commonly used FTPds.
The others do not have a large userbase among mirror sites. One
thing to consider is that you may need flexibility in limiting
how many simultaneous connections are allowed, thus limiting how
@ -237,8 +237,8 @@
<sect3 id="mirror-serv-http">
<title>HTTP (required for web pages, optional for FTP fileset)</title>
<para>
If you want to offer the FreeBSD web pages, you need
to install a web server a.k.a. <application>httpd</application>.
If you want to offer the FreeBSD web pages, you will need
to install a web server.
You may optionally offer the FTP fileset via HTTP.
The choice of web server software is left up to the mirror administrator.
Some of the most popular choices are:
@ -246,10 +246,12 @@
<itemizedlist>
<listitem>
<para><filename role="package">www/apache13</filename>:
Apache is the most widely deployed web server on the Internet. It
is used extensively by the FreeBSD Project. You may also
wish to use the next generation of the Apache web server,
available in the ports collection as <filename
<application>Apache</application> is the most widely
deployed web server on the Internet. It is used
extensively by the FreeBSD Project. You may also wish to
use the next generation of the
<application>Apache</application> web server, available
in the ports collection as <filename
role="package">www/apache22</filename>.</para>
</listitem>
@ -257,17 +259,20 @@
<para><filename role="package">www/thttpd</filename>:
If you are going to be serving a large amount of static content
you may find that using an application such as thttpd is more
efficient than Apache. It is optimized for excellent performance
on FreeBSD.</para>
efficient than <application>Apache</application>. 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>
<application>Boa</application> is another alternative to
<application>thttpd</application> and
<application>Apache</application>. It should provide
considerably better performance than
<application>Apache</application> for purely static
content. It does not, at the time of this writing,
contain the same set of optimizations for FreeBSD that
are found in <application>thttpd</application>.</para>
</listitem>
</itemizedlist>
</para>
@ -299,7 +304,7 @@
</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 mirror-ready. Some
<filename role="package">net/cvsup-without-gui</filename>, and configures it mirror-ready. Some
site administrators may want a different setup though.
</para>
</listitem>
@ -586,7 +591,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<para>
The best way is to check out the <emphasis>www</emphasis>
distribution from CVS. If you have a local mirror of the
CVS repository, it is probably as easy as:
CVS repository, it is as easy as:
<screen>&prompt.user; <userinput>cvs -d /home/ncvs co www</userinput></screen>
and a <emphasis>cronjob</emphasis>, that calls <command>cvs up -d -P</command>
on a regular basis, maybe just after your repository was updated.
@ -595,12 +600,6 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
web server is not discussed here.
</para>
<note><para>For the website to be visible, users must execute the &man.make.1;
command in the main <filename>www</filename> directory. This command
will create the standard <filename>*.html</filename> files for web
viewing. For this to work however, the
<filename role="package">textproc/docproj</filename> port must be
installed.</para></note>
<para>
If you do not have a local repository, you can use
<application>CVSup</application> to maintain an <quote>up to date copy</quote>
@ -626,7 +625,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
</para>
<para>
Using <filename role="package">ftp/wget</filename> or other web-mirror tools is
probably not recommended.
not recommended.
</para>
<sect3 id="mirror-www-doc">
<title>Mirroring the FreeBSD documentation</title>
@ -678,16 +677,12 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<para>
The building of the documentation, as well as lots
of side issues, is documented itself in the
<ulink url="http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/fdp-primer/">fdp-primer</ulink>.
<ulink url="&url.books.fdp-primer;">&os; Documention
Project 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>
@ -738,7 +733,7 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
Here are some recommended schedules:
<itemizedlist>
<listitem><para>FTP fileset: daily</para></listitem>
<listitem><para>CVS repository: daily to hourly</para></listitem>
<listitem><para>CVS repository: hourly</para></listitem>
<listitem><para>WWW pages: daily</para></listitem>
</itemizedlist>
</para>
@ -888,13 +883,13 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
<para>
<hostid>ftp-master.FreeBSD.org</hostid> provides
<application>rsync</application> and <application>CVSup</application>
access, rather in addition to ftp protocol.
access, in addition to FTP.
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>
Mirrors are also encouraged to also allow <application>rsync</application>
access for the FTP contents, since they are
<emphasis>Tier-1</emphasis>-mirrors.
</para>
@ -910,8 +905,8 @@ cvspserver stream tcp nowait root /usr/bin/cvs cvs -f -l -R -T /anoncvstmp --all
See <xref linkend="mirror-cvs-cvsup"> for details.
</para>
<para>
To get access, you need to contact &a.cvsup-master;.
Make sure you read
To get access, you need to contact the &a.cvsup-master;.
Make sure you read the
<ulink url="http://people.FreeBSD.org/~jdp/cvsup-access/">FreeBSD CVSup Access Policy</ulink>
first!
</para>