[BACK]Return to cvsync.html CVS log [TXT][DIR] Up to [local] / www

Annotation of www/cvsync.html, Revision 1.5

1.1       espie       1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
                      2: <html>
                      3: <head>
                      4: <title>OpenBSD CVSync</title>
                      5: <link rev="made" href="mailto:www@openbsd.org">
                      6: <meta name="resource-type" content="document">
                      7: <meta name="description" content="How to get OpenBSD updates via Internet using CVSync">
                      8: <meta name="keywords" content="openbsd,cvsync,updates">
                      9: <meta name="distribution" content="global">
                     10: <meta name="copyright" content="This document copyright 2001-2002 by OpenBSD.">
                     11: </head>
                     12:
                     13: <body bgcolor="#FFFFFF" text="#000000" link="#23238E">
                     14:
                     15: <a href="index.html"><img alt="[OpenBSD]" height="30" width="141" src="images/smalltitle.gif" border="0"></a>
                     16:
                     17: <h2><font color="#e00000">CVSync</font></h2>
                     18: <hr>
                     19:
                     20: <h3>Table of Contents</h3>
                     21: <ul>
                     22: <li><a href="#CVSync">What Is CVSync?</a></li>
                     23: <li><a href="#starting">Getting Started Using CVSync</a></li>
                     24: <li><a href="#using">Using CVS to Update Your Source Tree</a></li>
                     25: <li><a href="#CVSROOT">Available CVSync Servers</a></li>
                     26: </ul>
                     27:
                     28: <hr>
                     29:
                     30:
                     31: <h3><a name="CVSync"><font color="#0000e0">What Is CVSync?</font></a></h3>
                     32:
                     33: <p>
                     34: <b>CVSync</b> is a software package for distributing and updating source
                     35: trees from a master <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=cvs&amp;sektion=1">cvs(1)</a> repository on a remote server host. The OpenBSD
                     36: sources are maintained in a CVS repository on a central development machine
                     37: in Canada.  With CVSync, OpenBSD users can easily keep their own source trees
                     38: up to date.
                     39: </p>
                     40:
                     41: <p>
                     42: <b>CVSync</b> uses the so-called pull model of updating. Under the pull
                     43: model, each client asks the server for updates, if and when they are
                     44: wanted.  The server waits passively for update requests from its clients.
                     45: Thus all updates are instigated by the client.  The server never sends
                     46: unsolicited updates.  Users must either run the <b>CVSync</b> client
                     47: manually to get an update, or they must set up a <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=cron&amp;sektion=8">cron(8)</a> job to run it
                     48: automatically on a regular basis.
                     49: </p>
                     50:
                     51: <p>
                     52: The term <b>CVSync</b>, capitalized just so, refers to the entire software
                     53: package. Its main components are the client <tt>cvsync</tt> which runs on
                     54: each user's machine, and the server <tt>cvsyncd</tt> which runs at each of
                     55: the OpenBSD CVSync mirror sites.
                     56: </p>
                     57:
                     58: <p>
                     59: <b>CVSync</b> is intended to be both faster and flexible than
                     60: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=sup&amp;sektion=1&amp;format=html">sup(1)</a>, and more flexible than CVSup.
                     61: </p>
                     62:
                     63: <p>
                     64: The OpenBSD Project currently has five main source repositories:
                     65: </p>
                     66:
                     67: <ul>
                     68:   <li><b>src</b> - Houses all source code for the OpenBSD Operating System.</li>
                     69:   <li><b>ports</b> - Houses the <a href="./ports.html">OpenBSD Ports</a>.</li>
                     70:   <li><b>www</b> - Houses all OpenBSD web pages. (Including this one).</li>
                     71:   <li><b>x11</b> - Houses OpenBSD's adaptation of the
                     72:       <a href="http://www.XFree86.org/">XFree86-3</a> software project.</li>
                     73:   <li><b>xf4</b> - Houses OpenBSD's adaptation of the
                     74:       <a href="http://www.XFree86.org/">XFree86-4</a> software project.</li>
                     75: </ul>
                     76:
                     77: <h3><a name="CVS"><font color="#0000e0">What Is CVS?</font></a></h3>
                     78:
                     79: <p>
                     80: CVS is the source code control system used to manage the OpenBSD source
                     81: tree.  It is described in more detail <a href="anoncvs.html#CVS">here</a>.
                     82: Note that CVS and CVSync are entirely different programs.  Although
                     83: CVS can be used for remote file access, it is not optimized for
                     84: wholesale source tree distribution over the net, and CVSync can be
                     85: easily an order of magnitude more efficient for this task.
                     86: </p>
                     87:
                     88: <h3>
                     89: <a name="starting"><font color="#0000e0">Getting Started Using CVSync</font></a>
                     90: </h3>
                     91:
                     92: <p>
                     93: If you only care about running CVSync, it is recommended that you
                     94: download the cvsync package from the <a href="ftp.html">ftp mirror
                     95: sites</a> instead of building your own from the <tt>net/cvsync</tt>
                     96: port.
                     97: </p>
                     98:
                     99: <p>
                    100: For further information about CVSync, see the
                    101: <a href="http://www.cvsync.org/">project homepage</a>.
                    102: </p>
                    103:
                    104: <p>
                    105: In order to mirror the OpenBSD repository with CVSync,
                    106: the following configuration file might be used:
                    107: </p>
                    108:
                    109: <pre>
                    110:        config {
                    111:            hostname anoncvs.de.openbsd.org
1.5     ! naddy     112:            # If your network link is a T1 or faster, comment out the following line.
1.1       espie     113:            compress
1.4       espie     114:            collection {
1.5     ! naddy     115:                name openbsd release rcs
1.4       espie     116:                prefix /cvs
1.5     ! naddy     117:                umask 002
1.4       espie     118:            }
1.1       espie     119:        }
                    120: </pre>
                    121:
                    122: <p>
                    123: This directs cvsync to refresh all OpenBSD distributions from
                    124: <b>anoncvs.de.openbsd.org</b> with a <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=umask&amp;sektion=2">umask(2)</a> that permits group write
                    125: permission to the local repository.
                    126: </p>
                    127:
                    128: <p>
                    129: Assuming this file is saved as <tt>cvs-syncfile</tt>, the
                    130: following command would be used to invoke cvsync
                    131: </p>
                    132: <pre>
                    133:         cvsync -c cvs-syncfile
                    134: </pre>
                    135:
                    136: <h3><a name="using">
                    137: <font color="#0000e0">Using CVS to Update Your Source Tree</font>
                    138: </a></h3>
                    139:
                    140: <p>
                    141: It is now simple to check out any one of the CVSync'ed repositories.
                    142: For Korn/Bourne shells:
                    143: </p>
                    144: <pre>
                    145:         # cd /usr
                    146:         # CVSROOT=/cvs cvs checkout src
                    147: </pre>
                    148: <p>
                    149: For csh and its derivatives:
                    150: </p>
                    151: <pre>
                    152:         # cd /usr
                    153:         # setenv CVSROOT /cvs
                    154:         # cvs checkout src
                    155: </pre>
                    156:
                    157: <p>
                    158: The above will check out the most current sources. Many of you will only
                    159: want the release sources, especially if you are patching your system.  To
                    160: checkout release sources you must specify a tag along with your command.
                    161: For example:
                    162: </p>
                    163: <pre>
                    164:         # cd /usr
                    165:         # cvs checkout -rOPENBSD_2_9 src
                    166: </pre>
                    167: <p>
                    168: Or <tt>OPENBSD_2_8</tt> for 2.8, etc.
                    169: </p>
                    170:
                    171: <h3>
                    172: <a name="CVSROOT"><font color="#0000e0">Available CVSync Servers</font></a>
                    173: </h3>
                    174:
                    175: <p>The following CVSync servers are available:</p>
                    176:
                    177: <dl>
1.3       naddy     178: <dt><strong>anoncvs.usa.openbsd.org</strong></a></dt>
                    179: <dd>
                    180: <p>
                    181: located at the University of Colorado, Boulder, western USA.<br>
                    182: maintained by <a href="mailto:millert@openbsd.org">Todd Miller</a>.<br>
                    183: Updated every 3 hours.
                    184: </p>
                    185: </dd>
                    186:
1.2       naddy     187: <dt><a href="http://anoncvs.de.openbsd.org/"><strong>anoncvs.de.openbsd.org</strong></a></dt>
                    188: <dd>
                    189: <p>
1.3       naddy     190: also known as <strong>grappa.unix-ag.uni-kl.de</strong>,<br>
1.2       naddy     191: located at the University of Kaiserslautern, Germany;<br>
1.1       espie     192: maintained by <a href="mailto:naddy@openbsd.org">Christian Weisgerber</a>.<br>
1.2       naddy     193: Updated every 6 hours from anoncvs.usa.openbsd.org.
1.1       espie     194: </p>
1.2       naddy     195: </dd>
1.3       naddy     196:
1.2       naddy     197: <dt><a href="http://www.allbsd.org/"><strong>cvsync.allbsd.org</strong></a></dt>
                    198: <dd>
                    199: <p>
                    200: located in Tokyo, Japan;<br>
                    201: maintained by <a href="mailto:hrs@allbsd.org">Hiroki Sato</a>.
                    202: </p>
                    203: </dd>
1.3       naddy     204:
1.2       naddy     205: <dt><a href="http://csociety.org/cvsup.html"><strong>cvsync.csociety.org</strong></a></dt>
                    206: <dd>
1.1       espie     207: <p>
1.2       naddy     208: located at Purdue University, Indiana, USA;<br>
                    209: maintained by <a href="mailto:will@csociety.purdue.edu">Will Andrews</a>.
1.1       espie     210: </p>
                    211: </dd>
1.3       naddy     212:
                    213: <dt>
                    214: <a href="http://mirror.osn.de/"><strong>mirror.osn.de</strong></a></dt>
                    215: <dd>
                    216: <p>
                    217: located in N&uuml;rnberg, Germany;<br>
                    218: maintained by <a href="mailto:aw@osn.de">Armin Wolfermann</a>.<br>
                    219: Updated every 4 hours from cvsup.uk.openbsd.org.
                    220: </p>
                    221: </dd>
1.1       espie     222: </dl>
                    223:
                    224:
                    225: <p>
1.2       naddy     226: <em>Note:</em> If your server is listed on here with inaccurate or
1.1       espie     227: unknown information, please contact <a
                    228: href="mailto:beck@openbsd.org"><tt>beck@openbsd.org</tt></a>
                    229: or <a href="mailto:naddy@openbsd.org"><tt>naddy@openbsd.org</tt></a>
                    230: </p>
                    231: <p>
                    232: You may want to use <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=traceroute&amp;sektion=8">traceroute(8)</a>
                    233: to find out which server is nearest you.
                    234: Problems with a server should be reported to the <b>maintainer</b> of the
                    235: server in question.
                    236: </p>
                    237: <p>
                    238: Currently (as of December 17, 2003), the CVS repository sizes are
                    239: </p>
                    240: <table>
                    241: <tr><td width="20"></td>
                    242:     <td><strong>openbsd-ports</strong></td>
                    243:     <td>- <b>140</b>MB</td></tr>
                    244: <tr><td></td>
                    245:     <td><strong>openbsd-src</strong></td>
                    246:     <td>- <b>1140</b>MB</td></tr>
                    247: <tr><td></td>
                    248:     <td><strong>openbsd-www</strong></td>
                    249:     <td>- <b>104</b>MB</td></tr>
                    250: <tr><td></td>
                    251:     <td><strong>openbsd-x11</strong></td>
                    252:     <td>- <b>200</b>MB</td></tr>
                    253: <tr><td></td>
                    254:     <td><strong>openbsd-xf4</strong></td>
                    255:     <td>- <b>442</b>MB</td></tr>
                    256: <tr><td></td>
                    257:     <td><strong>openbsd-cvsroot</strong></td>
                    258:     <td>- <b>257</b>MB</td></tr>
                    259: </table>
                    260: <p>
                    261: The overall repository size currently increases at a rate
                    262: of about <b>225</b>MB per annum.
                    263: </p>
                    264: <p>
                    265: <strong>IMPORTANT NOTE:</strong>
                    266: There are a few issues relating to cryptographic software that everyone
                    267: should be aware of:
                    268: </p>
                    269: <ul>
                    270:   <li>
                    271:     <p>
                    272:     The OpenBSD sources are from Canada. As
                    273:     <a href="http://www.efc.ca/pages/doc/crypto-export.html">
                    274:     researched by a Canadian individual</a> and as
                    275:     <a href="http://axion.physics.ubc.ca/ECL.html">
                    276:     described in the Export Control list of Canada</a>,
                    277:     it is legal to export crypto software from Canada to the world.
                    278:     </p>
                    279:   </li>
                    280:   <li>
                    281:     <p>
                    282:     However, if you are outside the USA or Canada, you should not
                    283:     fetch the cryptographic sections of the OpenBSD sources from an
                    284:     AnonCVS server located in the USA. The files in question are...
                    285:     </p>
                    286:     <ul>
                    287:       <li><tt>src/kerberosIV/*</tt></li>
                    288:       <li><tt>src/kerberosV/*</tt></li>
                    289:       <li><tt>src/lib/libdes/*</tt></li>
                    290:       <li><tt>src/lib/libc/crypt/crypt.c</tt></li>
                    291:       <li><tt>src/lib/libc/crypt/morecrypt.c</tt></li>
                    292:       <li><tt>src/sys/crypto</tt></li>
                    293:       <li><tt>src/sys/netinet</tt></li>
                    294:       <li><tt>src/usr.sbin/afs/src/rxkad/*</tt></li>
                    295:       <li><tt>XF4/xc-mit/lib/Xdmcp/Wraphelp.c</tt></li>
                    296:       <li><tt>XF4/xc-old/lib/Xdmcp/Wraphelp.c</tt></li>
                    297:       <li><tt>XF4/xc/lib/Xdmcp/Wraphelp.c</tt></li>
                    298:     </ul>
                    299:     <p>
                    300:     Because of the USA ITAR munitions list,
                    301:     crypto software may only be exported to Canada from the USA.
                    302:     </p>
                    303:   </li>
                    304: </ul>
                    305:
                    306: <p>
                    307: The OpenBSD project is looking for more CVSync servers -- if you are
                    308: interested, please contact <a href="mailto:naddy@openbsd.org">Christian Weisgerber</a>
                    309: for configuration details.
                    310: </p>
                    311:
                    312: <hr>
                    313: <a href="index.html"><img height="24" width="24" src="back.gif" border="0" alt="OpenBSD"></a>
                    314: <a href="mailto:www@openbsd.org">www@openbsd.org</a>
1.5     ! naddy     315: <br><small>$OpenBSD: cvsync.html,v 1.4 2003/12/17 18:14:37 espie Exp $</small>
1.1       espie     316:
                    317: </body>
                    318: </html>