aboutsummaryrefslogtreecommitdiff
blob: d3d6790c1b3f00b1f46851c980a22234585978cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title></title>
			<link rel="stylesheet" href="media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
						
<h1 align="center">README</h1>
<pre>
-----------------------
Mirror Project
Open Source Lab
Oregon State University
-----------------------
*Coding Standards

    http://pear.php.net/manual/en/standards.php

*PHP Documentation

	PHP documentation generated by PHP Documentor can be found in /docs.  View index.html using file://.

*Configuration

    Application configuration is done using define() calls.  The configuration script is located in:
    cfg/config-dist.php

    Copy this config file to cfg/config.php and the init script (cfg/init.php) will process it as intended.

    !! DO NOT store password information in config-dist.php and checkin !!

*Apache

    Don't forget to set up raw logs:
    ErrorLog &quot;|/usr/bin/cronolog /var/www/download/logs/%Y%m%d/error.log&quot;
    CustomLog &quot;|/usr/bin/cronolog /var/www/download/logs/%Y%m%d/access.log&quot;

	DB-based logging is configurable by enabling the LOGGING constant in config.php.	

*DB

    DB information is stored in:
    cfg/mirror.sql

    DB connections are persistent (msyql_pconnect()).  For more info view the PHP manual:
    http://php.oregonstate.edu/mysql_pconnect
    http://php.oregonstate.edu/manual/en/features.persistent-connections.php

	The DB server should optimally NOT be localhost (save cycles).

*Questions

    Send questions and rants to &lt;mike dot morgan at oregonstate dot edu&gt;

*Output Buffering

    This application uses output buffering.

    ob_start() is called in inc/header.php.
    ob_end_flush() is called in inc/footer.php.

    No browser output (echo, print, etc.) should _ever_ happen outside of these boundaries.

*Permissions

    The project directory should be readable by the web server.

*Benchmarking

	!! ALL benchmark referencing /index.php should be done using ?print=true.	!!
	!! This disables the actual redirects and avoids spamming mirrors.			!!

*Developers

	Scott Kveton &lt;scott at osuosl dot org&gt;
    Mike Morgan &lt;mike dot morgan at oregonstate dot edu&gt;
    Alex Polvi &lt;polvi at osuosl dot org&gt;
    Danny Robert &lt;robert at osuosl dot org&gt;

</pre>
	<p class="notes" id="credit">
		Documentation generated on Mon,  8 Nov 2004 13:43:03 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</body>
</html>