FCI - Folding@Home Client Info
Subversion Repository

The fci-client runs on Linux, FreeBSD, OpenBSD, Mac OS X and Windows, 
the fci-server runs on Linux, and on FreeBSD & OpenBSD using Linux emulation.

The fci-client sends data from a client to the fci-server, among which are the
output of Dick Howells qd, Operating System and Hardware information and the
most interesting files in the Folding@Home client directory.

The server does almost all processing, and uses various tools to do it.

The tools uses by the FCI server are:
- xyz2pdb
- rasmol
- convert  (from ImageMagick)
- htpasswd (from Apache)

convert and htpasswd should be installed before FCI is.

xyz2pdb is shipped with FCI, just like Dick Howells qd is. xyz2pdb is used to 
convert the current.xyz to a .pdb which is fed to rasmol.

A 32 bit Linux binary of rasmol is also shipped, but many Linux distros and
FreeBSD have native packages of rasmol. FreeBSD has a rasmol package, so the
rasmol binary shipped with FCI will not be installed. Rasmol is used to 
generate an image and/or animation of the projects in the current.xyz which 
the clients upload.

convert is part of ImageMagick, it's used to compile animations out of multiple 
rasmol generated images.

Installing on FreeBSD

The installation process described in this document assume that you're running
a FreeBSD 8.2-RELEASE system.

The fci-client has very few dependencies, the fci-server has a bit more:

  Perl Module           | Package     
Installer:              |
- XML::Simple           | textproc/p5-XML-Simple
- Getopt::Mixed         | devel/p5-Getopt-Mixed
- Date::Calc            | devel/p5-Date-Calc
Client:                 |
- LWP::UserAgent	| www/p5-libwww
- HTTP::Request::Common | www/p5-libwww
- Date::Calc            | devel/p5-Date-Calc
- XML::Simple           | textproc/p5-XML-Simple
- Getopt::Mixed         | devel/p5-Getopt-Mixed

  Application           | Package
Server:                 |
- convert               | graphics/ImageMagick
- rasmol                | biology/rasmol
- bunzip2               | archivers/bzip2
- Apache 2.x webserver  | www/apache22
- Apache2 mod_perl      | www/ap20-mod_perl2

  Perl Module           | Package
Server:                 |
- LWP::UserAgent        | www/p5-libwww
- Date::Calc            | devel/p5-Date-Calc
- Date::Manip           | devel/p5-Date-Manip
- Date::Format          | devel/p5-TimeDate
- XML::Simple           | textproc/p5-XML-Simple
- Data::Dumper          | devel/p5-Data-Dumper
- Apache::Htpasswd      | CPAN
- Getopt::Mixed         | devel/p5-Getopt-Mixed
- MIME::Lite            | mail/p5-MIME-Lite
- GD::Graph             | graphics/p5-GD-Graph
- Image::Magick         | graphics/ImageMagick
- Mail::RFC822::Address | mail/p5-Mail-RFC822-Address
- HTML::Entities        | www/p5-libwww
- RRDs                  | databases/rrdtool
- Math::Round           | math/p5-Math-Round
Server with Apache 2.x: |
- Apache2::Request      | www/p5-libapreq2
- Apache2::Upload       | www/p5-libapreq2

Before you can use install.pl to install the FCI client and/or server, first
install the dependencies:

# FCI Installer only:
pkg_add -r p5-Date-Calc p5-Getopt-Mixed p5-XML-Simple

# FCI Client only:
pkg_add -r p5-Date-Calc p5-Getopt-Mixed p5-XML-Simple p5-libwww

# FCI Server only:
pkg_add -r rasmol rrdtool p5-Data-Dumper p5-Date-Calc p5-Date-Manip \
	p5-Getopt-Mixed p5-TimeDate ImageMagick- \
	p5-GD-Graph p5-MIME-Lite p5-Mail-RFC822-Address p5-XML-Simple \
	apache22 ap20-mod_perl2 p5-libapreq2 p5-libwww p5-Math-Round

There is no package for Apache::Htpasswd used by the FCI server, but you can get
it from CPAN:

cpan Apache::Htpasswd

After the dependencies have been installed, run the installer to install the
FCI client and/or server:

# FCI client only
./install.pl --client

# FCI server only
./install.pl --server --owner <user> --group www

# FCI client & server
./install.pl --client --server --owner <user> --group www

The owner of the FCI server files should be your regular user account, you
being the FCI server administrator. You shouldn't need root privileges to
run the FCI server scripts, it's enough to have your regular user account
be a member of the http group.

The installer does require root privileges, and has several options which
you can use to customize the installation, overriding the built-in defaults:

./install.pl --help
 Folding@Home Client Info Installer v1.0

 Usage: install.pl [--client|--server] [OPTIONS]

 -c, --client           Install the client component
 -s, --server           Install the server component

 -b, --bin-dir <PATH>   Path of executable files          (/usr/local/bin/)
 -o, --conf-dir <PATH>  Path of configuration files       (/usr/local/etc/fci/)
 -d, --data-dir <PATH>  Path of the data files            (/usr/local/share/fci/)
 -w, --www-dir <PATH>   Path of the website files         (/var/www/fci/)

 -o, --owner <NAME>     Username to own the website files (root)
 -g, --group <NAME>     Username to own the website files (www-data)

 -f, --force            Install files & directories even if they already exist
 -v, --verbose          Enable verbose output
 -h, --help             Print this usage information

Installing the FCI client using ./install --client comes down to the following:
 copy client/qd            -> /usr/local/bin/qd
 copy client/qdinfo.dat    -> /usr/local/share/fci/qdinfo.dat
 copy client/fci-client.pl -> /usr/local/bin/fci-client.pl

It installs the fci-client Perl script, and a copy of qd and its data file
qdinfo.dat for inital use by fci-client.pl. The FCI client will automatically
download the latest qdinfo.dat from the FCI server before every upload, it's
stored in its own per-user cache: ~/.fci/. A more recent revision of the qd
binary is only downloaded if the client is run with --update-qd. New revisions
of qd may contain bugfixes or new features you may want to have available to
your FCI client, but automatic download of the most recent qd binary from the
FCI server might overwrite a custom compiled binary in ~/.fci/, which is not

The FCI client should now be ready to perform uploads to the server. It is
recommended to use the --verbose argument to fci-client.pl the first time the
FCI client command is tested for use. By default fci-client.pl doesn't display
any output unless it encounters an error, but the verbose output contains all
the information you need to verify its correct operation.

The fci-client.pl script needs to be scheduled to run periodically. To spread
the load on the server, it's recommended to use slightly different times for
the client uploads if there are many clients on a single server and/or the
server doesn't have many resources in terms of bandwidth, RAM or CPU power.

Add a rule like the one below to the crontab of the user who also runs the
Folding@Home client:

### crontab rules for FCI client ###
10 * * * * /usr/local/bin/fci-client.pl --dir /home/folding/ --url http://example.com/fci/index.pl
### crontab rules for FCI client ###

Installing the FCI server using ./install --server comes down to the following:
 mkdir /var/www/fci
 copy www/*     -> /var/www/fci/
 copy scripts/* -> /usr/local/bin/
 copy bin/*     -> /usr/local/bin/
 chmod -R <user>:www-data /var/www/fci/

It creates a directory where the server files are stored, this includes the
mod_perl scripts, XML and qd files, etc. The scripts and programs which comprise
the FCI server are installed, and the paths of these tools are updated in the
FCI server configuration: /var/www/fci/settings/site-data/config.xml

If /usr/bin/rasmol or /usr/local/bin/rasmol already exist the rasmol binary
shipped with FCI is not copied, and the existing rasmol will be used. When
rasmol in not found, the rasmol binary shipped with FCI will be copied to

The xyz2pdb binary shipped with FCI will be copied to /usr/local/bin/ only if
it doens't exist yet (unless --force is used).

The installer will look for the convert and htpasswd binaries in /usr/bin/, 
/usr/sbin/, /usr/local/bin/ and /usr/local/sbin/. If convert of htpasswd are
not found the installer will quit. You can create a symlink to the convert or
htpasswd binary in another location and rerun the installer, or you can create
empty file instead of a symlink. It's recommended to set the path to the real
convert or htpasswd binary using the Settings web interface after the install
has completed.

The Apache webserver still needs to be configured for FCI, before it can accept
uploads from an FCI client.

You can create the file /usr/local/etc/apache22/Includes/fci.conf using the
below configuration:

### /usr/local/etc/apache22/Includes/fci.conf ###
# FCI apache configuration

Alias /fci /usr/local/www/apache22/data/fci

<Directory /usr/local/www/apache22/data/fci/>
  DirectoryIndex index.pl

  <FilesMatch "^index\.pl$">
    SetHandler perl-script
    PerlHandler ModPerl::Registry
    Options +ExecCGI
    PerlOptions +GlobalRequest

  AllowOverride AuthConfig

  # Disallow access to the Perl components
  <FilesMatch "\.plc$">
    deny from all

  Options -Indexes +FollowSymLinks

  Order allow,deny
  Allow from all
### /usr/local/etc/apache22/Includes/fci.conf ###

Also make sure the mod_perl and libapreq2 modules are loaded, add the lines
like the following to /usr/local/etc/apache22/httpd.conf:
# mod_perl
LoadModule perl_module libexec/apache22/mod_perl.so
# libapreq2
LoadModule apreq_module libexec/apache22/mod_apreq2.so

The configuration can then be activated with:
/usr/local/sbin/apachectl restart

The rasmol binary shipped with FreeBSD in /usr/local/bin/rasmol is actually
a wrapper script, use the FCI Settings web interface to update the path of
rasmol to:

It is strongly advised to use the Settings webinterface to configure HTTP
authentication for client uploads, the client data files and the Settings
webinterface itself.

Now the FCI server should be readly to accept uploads from FCI clients.

The collection of scripts which were installed as part of the FCI server,
need to be scheduled to run periodically. And the order in which they run is
significant. Each script acquires and/or processes a specific subset of the
Folding@Home data, this data is processed into the XML files used by the FCI

Add rules like the ones below to the crontab of the user who owns the FCI
server files:

### crontab rules for FCI server ###
0 * * * * /usr/local/bin/fci-update-stanford-files.pl --dir /usr/local/www/apache22/data/fci/
5 * * * * /usr/local/bin/fci-update-qd-files.pl --dir /usr/local/www/apache22/data/fci/
15 * * * * /usr/local/bin/fci-update-fahstats.pl --dir /usr/local/www/apache22/data/fci/
#15 * * * * /usr/local/bin/fci-jmol-missing-projects.pl --dir /usr/local/www/apache22/data/fci/
30 * * * * /usr/local/bin/fci-update-xml-files.pl --dir /usr/local/www/apache22/data/fci/
35 * * * * /usr/local/bin/fci-generate-queue-graphs.pl --dir /usr/local/www/apache22/data/fci/
35 * * * * /usr/local/bin/fci-update-jmol-projects.pl --dir /usr/local/www/apache22/data/fci/
40 2,5,8,11,14,17,20,23 * * * /usr/local/bin/fci-update-eoc-stats.pl --dir /usr/local/www/apache22/data/fci/
45 * * * * /usr/local/bin/fci-update-project-images.pl --dir /usr/local/www/apache22/data/fci/
### crontab rules for FCI server ###

What each individual script does and how it relates to the other scripts is
described in more dept below:

 It can be run independently, it doesn't share files with other scripts which
 need to be considered. It downloads the HTML and text files from Stanfords
 webserver, which are parsed by fci-update-xml-files.pl. Empty copies of these
 files (except the team<N>.txt files) are shipped with FCI, but these need to
 be updated with the lastest copy from Stanford first.

 It can be run independently, it doesn't share files with other scripts which
 need to be considered. It download the latest qd binaries and qdinfo.dat
 which the server will make available to the clients.

 It needs to run after fci-update-xml-files.pl has run, because it uses the
 username-list.xml file which fci-update-xml-files.pl updates. It retrieves
 the UserID for each username listed in the fahstats.com database.

 It needs to run after fci-update-xml-files.pl has run, because it uses the
 known-projects.xml file which fci-update-xml-files.pl updates. It checks for
 projects Jmol is missing the current.xyz file for, the file is emailed if a
 missing project is found in the known-projects.xml file.

 It's the main update script. It processes the uploaded data of the clients,
 the downloaded data from Stanford, EXTREME Overclocking, fahstats.com and
 Jmol. It updates the XML files which are used by the web interface and some
 of the other FCI scripts.

 It needs to be run closely after fci-update-xml-files.pl is finished. It
 generates graphs of the average PPD of the Work Units in the queue. It uses
 the client-list.xml file which fci-update-xml-files.pl updates.

 It needs to run after fci-update-stanford-files.pl has run, because it uses
 the project-summary.xml which fci-update-stanford-files.pl updates. It
 downloads the latest fah-projects.xml from Jmol, its data is used to link
 to the Jmol webpage from a project page and to add projects which Jmol knows
 about to the project-summary.xml if we don't known about it from
 fci-update-stanford-file.pl yet (which uses Stanfords psummary.html to update

 It needs to run after fci-update-xml-files.pl has run, because it uses the
 username-list.xml file which fci-update-xml-files.pl updates. It downloads
 the XML stats for each username listed.

 It needs to run after fci-update-xml-files.pl has run, because it uses the
 known-projects.xml file which fci-update-xml-files.pl updates. It generates
 the missing image types for each known project.