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