diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 69 |
1 files changed, 69 insertions, 0 deletions
@@ -0,0 +1,69 @@ +----------------------- +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 "|/usr/bin/cronolog /var/www/download/logs/%Y%m%d/error.log" + CustomLog "|/usr/bin/cronolog /var/www/download/logs/%Y%m%d/access.log" + + 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 <mike dot morgan at oregonstate dot edu> + +*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 <scott at osuosl dot org> + Mike Morgan <mike dot morgan at oregonstate dot edu> + Alex Polvi <polvi at osuosl dot org> + Danny Robert <robert at osuosl dot org> |