View source for Installation Manual for 2.4

== Installation Methods and Instructions==
* Installing WeBWorK from the WeBWorK Live DVD (see [[Installing from WW2.4_Ubuntu9.04_LiveDVD]]) is the fastest method but offers very few choices (after installation you can make whatever changes you want). You can also run WeBWorK directly off the LiveDVD without installing any software on your system. Finally you can use the .iso image to install WeBWorK as a virtual machine under most modern operating systems (windows, linux, unix, solaris, etc)

* The instructions listed in [[Installation_Manual_for_2.4#Installation instructions for specific operating systems]] offer command-by-command procedures (and fewer choices) than the general instructions. They are targeted at UNIX beginners

* The general instructions on this page offer the most information and choices but are targeted at UNIX experts

* [[Installing_WeBWorK_on_Live_USB]] explains how to download and install a disk image of a fully functioning WeBWorK 2.4 system onto a 2 GB USB flash memory drive. This is suitable for testing WeBWorK and is very convenient if you want to carry your server around on a pen drive

== Installation instructions for specific operating systems ==

These manuals offer command-by-command procedures (and fewer choices) than the general instructions. They are targeted at UNIX beginners.

* [[Installation Manual for 2.4 on Ubuntu 9.04]]
* [[Installation Manual for 2.4 on Fedora 9]]

[[:Category:Installation_Manuals|More installation manuals...]]

== Dependencies ==

=== Apache ===

WeBWorK supports Apache 1.3 and 2.0. Apache 2.2 is supported experimentally. WeBWorK requires that the <code>mod_alias</code> module be available. Most vendors compile their Apache packages with the necessary features enabled.

==== Apache 1.3 ====

* Source: http://httpd.apache.org/
* Debian/Ubuntu: <code>apache</code> 
* Red Hat/Fedora: build from source

==== Apache 2.0 or 2.2 ====

Apache must be using the <code>prefork</code> MPM. This is because the <code>Safe</code> module, which WeBWorK makes extensive use of, is not threadsafe. This is set at compile time with the <code>--with-mpm=prefork</code> switch to the <code>configure</code> script.

* Source: http://httpd.apache.org/
* Debian/Ubuntu: <code>apache2</code> with <code>apache2-mpm-prefork</code>
* Fedora: check if the <code>httpd</code> package provides the right MPM by running <code>/usr/sbin/httpd -l</code>. Build from source, if not.
* Red Hat EL/CentOS/Scientific Linux: in versions 4 and 5, <code>httpd</code> uses the <code>prefork</code> MPM. For other versions, see the Fedora instructions above.

=== Perl ===

WeBWorK requires Perl 5.6.1 or higher.

* Source: http://perl.org/
* Debian/Ubuntu: <code>perl</code> (in the default install)
* Red Hat/Fedora: <code>perl</code> (in the default install)

=== Perl modules ===

The following Perl modules are required. All are available from [http://cpan.org/ CPAN], and many vendors provide packages of these modules. To see if a module is already installed on your system, use the following command. Replace <code>Module</code> with the name of the module.

 $ perl -MModule -e 'print "installed!\n"'

<span style="color:red">To determine which of the modules used by WeBWorK are already installed</span>  run the script:
 webwork2/bin/check_modules.pl [apache1|apache2]  
 or
 perl webwork2/bin/check_modules.pl [apache1|apache2]
which checks for the modules needed for either an apache1 or apache2 installation of WeBWorK respectively. Many of the modules are already installed on most systems. 
 
A nearly comprehensive
list  of the CPAN modules needed are listed in the table below, but <code>check_modules.pl</code> will
be more up to date. For the most part these modules are either already present or can be easily installed using CPAN.  Those using compiled binaries for a particular platform may be more quickly and easily installed using packages. Depending on the operating system, packages may also be more easily updated (via OS-specific software upgrade mechanisms) than CPAN modules.

To install a missing module from CPAN, use the following command as root. Replace <code>Module</code> with the name of the module.

 # perl -MCPAN -e "install Module"

For more information about using CPAN, consult the [http://cpan.org/misc/cpan-faq.html CPAN FAQ].

{| border="1"
|-
| '''module'''
| '''Debian/Ubuntu package'''
| '''Gentoo package'''
| '''Fedora Core 7 package'''
| '''Red Hat EL/CentOS 5 package'''
| '''FreeBSD port/package'''
|-
| Apache::Constants
|
|
|
|
| <code>www/mod_perl</code>
|-
| Apache::Cookie/Apache2::Cookie
|
|
|
| <code>perl-libapreq2</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>www/p5-libapreq</code>
|-
| Apache::Log
|
|
|
|
| <code>www/mod_perl</code>
|-
| Apache2::ServerRec
|
|
|
| <code>mod_perl</code>
|-
| Apache2::ServerUtil
|
|
|
| <code>mod_perl</code>
|-
| Apache::Request<br/><small>(only if using Apache 1.3.x)
| <code>libapache-request-perl</code>
| 
| 
|-
| Apache2::Request<br/><small>(only if using Apache 2.0.x)
| <code>libapache2-request-perl</code>
| <code>libapreq</code>
| <code>perl-libapreq2</code>
| <code>perl-libapreq2</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>www/p5-libapreq</code>
|-
| Data::Dumper
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| Data::UUID
| <code>libdata-uuid-perl</code> <br><small>(virtual package, provided by <code>libossp-uuid-perl</code>)</small>
| <code>Data-UUID</code>
| <code>perl-uuid</code>
| <code>uuid-perl</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>devel/p5-Data-UUID</code>
|-
| Date::Format and Date::Parse
| <code>libtimedate-perl</code>
| <code>TimeDate</code>
| <code>perl-TimeDate</code>
| <code>perl-TimeDate</code>
| <code>devel/p5-DateTime</code> and <code>devel/p5-DateTime-Format-DateParse</code>
|-
| DateTime
| <code>libdatetime-perl</code>
| <code>DateTime</code>
| <code>perl-DateTime</code>
| <code>perl-DateTime</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>devel/p5-DateTime</code>
|-
| DBD::mysql
| <code>libdbd-mysql-perl</code>
| <code>DBD-mysql</code>
| <code>perl-DBD-MySQL</code>
| <code>perl-DBD-MySQL</code>
| <code>databases/p5-DBD-mysql</code>
|-
| DBI
|
|
|
| <code>perl-DBI</code>
| <code>databases/p5-DBI</code>
|-
| Digest::MD5
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| Email::Address
| <code>libemail-address-perl</code>
| <code>Email-Address</code>
| <code>perl-Email-Address</code>
| <code>perl-Email-Address</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>mail/p5-Email-Address</code>
|-
| Errno
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| Exception::Class
|
|
|
| <code>perl-Exception-Class</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>devel/p5-Exception-Class</code>
|-
| File::Copy
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| File::Find
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| File::Path
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| File::Spec
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|- 
| File::stat
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| File::Temp
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| GD
| <code>libgd-gd2-perl</code>
| <code>GD</code>
| <code>perl-GD</code>
| <code>perl-GD</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>graphics/p5-GD</code>
|-
| Getopt::Long
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| Getop::Std
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| HTML::Entities
|
|
|
| <code>perl-HTML-Parser</code>
| <code>www/p5-HTML-Parser</code>
|-
| HTML::Tagset
|
|
|
| <code>perl-HTML-Tagset</code>
| <code>www/p5-HTML-Tagset</code>
|-
| IO::File
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| Iterator
| not packaged
| not packaged
| not packaged
| <code>perl-Iterator</code> from [[Aleksey Nogin's repository|Nogin]]
| <code>devel/p5-Iterator</code>
|-
| Iterator::Util
| not packaged
| not packaged
| not packaged
| <code>perl-Iterator-Util</code> from [[Aleksey Nogin's repository|Nogin]]
| <code>devel/p5-Iterator-Util</code>
|-
| Mail::Sender
| <code>libmail-sender-perl</code>
| <code>Mail-Sender</code>
| <code>perl-Mail-Sender</code>
| <code>perl-Mail-Sender</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>mail/p5-Mail-Sender</code>
|-
| MIME::Parser
|
|
|
| <code>perl-MIME-tools</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>mail/p5-MIME-Tools</code>
|-
| MIME::Base64
|
|
|
| included in <code>perl</code> package
| <code>converters/p5-MIME-Base64</code>
|-
| Net::IP
|
|
|
| <code>perl-Net-IP</code>
| <code>net-mgmt/p5-Net-IP</code>
|-
| Net::LDAPS
|
|
|
| <code>perl-LDAP</code>
|-
| Net::SMTP
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| Opcode
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| PHP::Serialization
|
|
|
| <code>perl-PHP-Serialization</code> from [[Aleksey Nogin's repository|Nogin]] 
| <code>devel/devel/p5-PHP-Serialization</code>
|-
| Pod::Usage
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| Safe
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| SOAP::Lite
|
|
|
| <code>perl-SOAP-Lite</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>net/p5-SOAP-Lite</code>
|-
| Socket
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| SQL::Abstract
| <code>libsql-abstract-perl</code>
| unknown
| <code>perl-SQL-Abstract</code> 
| <code>perl-SQL-Abstract</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>databases/p5-SQL-Abstract</code>
|-
| String::ShellQuote
| <code>libstring-shellquote-perl</code>
| <code>String-ShellQuote</code>
| <code>perl-String-ShellQuote</code>
| <code>perl-String-ShellQuote</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>textproc/p5-String-ShellQuote</code>
|-
| Text::Wrap
|
|
|
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| Time::HiRes<br><small>(included in Perl 5.8 and higher)</small>
| included in <code>perl</code> package
| unknown
| included in <code>perl</code> package 
| included in <code>perl</code> package
| <code>lang/perl</code>
|-
| Time::Zone
|
|
|
| <code>perl-TimeDate</code>
| <code>devel/p5-DateTime-TimeZone</code>
|-
| URI::Escape
| 
|
|
| <code>perl-URI</code>
| <code>net/p5-URI</code>
|-
| XML::Parser
| <code>libxml-parser-perl</code>
| <code>libxml-perl</code>
| <code>perl-XML-Parser</code>
| <code>perl-XML-Parser</code>
| <code>textproc/p5-XML-Parser</code>
|-
| XML::Parser::EasyTree
| not packaged
| unknown
| not packaged 
| <code>perl-XML-Parser-EasyTree</code> from [[Aleksey Nogin's repository|Nogin]]
| <code>textproc/p5-XML-Parser-EasyTree</code>
|-
| XML::Writer
| <code>libxml-writer-perl</code>
| <code>XML-Writer</code>
| <code>perl-XML-Writer</code>
| <code>perl-XML-Writer</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>textproc/p5-XML-Writer</code>
|-
| XMLRPC::Lite 
|
|
|
| <code>perl-SOAP-Lite</code> from [http://fedoraproject.org/wiki/EPEL EPEL]
| <code>net/p5-SOAP-Lite</code>
|}

==== DateTime::TimeZone: use version 0.34 or later ====

Versions of DateTime::TimeZone (a component of DateTime) below 0.34 suffer from a problem with displaying some time zones. Make sure you have version 0.34 or later.

==== Problems building Time::HiRes ====

Some users have reported problems building Time::HiRes through CPAN. If this is your experience, try downloading the Time::HiRes tarball from http://search.cpan.org/~jhi/Time-HiRes/ and building it manually (<code>perl Makefile.PL && make && make test && make install</code>).

==== Problems building Apache::Request or Apache2::Request ====

Apache::Request is one component of the libapreq library. If you run into problems building it through CPAN, try downloading the libapreq tarball from http://httpd.apache.org/apreq/.

Apache 2.0.x users should use libapreq2.

=== mod_perl ===

WeBWorK uses mod_perl to interface with the Apache server. If compiling mod_perl from source, use the <code>EVERYTHING=1</code> flag to enable all mod_perl features. Most vendors compile their mod_perl packages with this setting enabled.

==== Apache 1.3 ====

* Source: http://perl.apache.org/download/
* Debian/Ubuntu: <code>libapache-mod-perl</code> 
* Red Hat/Fedora: build from source; see below.
* Gentoo: <code>mod_perl </code>

==== Apache 2.0 ====

* Source: http://perl.apache.org/download/ 
* Debian/Ubuntu: <code>libapache2-mod-perl</code> 
* Red Hat/Fedora: build from source 

==== RHEL4/Fedora build notes ====

''I had to use the flags below to get the compile to work correctly:''

 perl Makefile.PL EVERYTHING=1 DO_HTTPD=1 USE_APACI=1 APACHE_PREFIX=/usr/local/apache

-- Main.MarkHamrick

=== MySQL ===

MySQL 4.0.x or later is required. If you are going to be using the experimental Moodle Integration, MySQL 4.1.x or later is required.

* Source: http://dev.mysql.com/downloads/ 
* Debian/Ubuntu: 4.0.x: <code>mysql-server</code>; 4.1.x: <code>mysql-server-4.1</code>
* Red Hat EL/Fedora/CentOS: <code>mysql-sever</code> and depending on distro release, either <code>mysql-client</code> or <code>mysql</code>
* Gentoo: <code>mysql </code>

=== LaTeX ===

WeBWorK requires LaTeX for generating hardcopy output and displaying mathematics graphically. Any standard LaTeX distribution that provides the commands <code>latex</code> and <code>pdflatex</code> should work. We use TeTeX.

* Source: http://tug.org/tetex/ 
* Debian/Ubuntu: <code>tetex-bin</code>, <code>tetex-extra</code> 
* Red Hat/Fedora: <code>tetex</code>, <code>tetex-latex</code> 
* Gentoo: <code>tetex</code>

=== Netpbm ===

WeBWorK requires Netpbm to convert images among the GIF, PNG, and EPS formats.

* Source: http://netpbm.sf.net/ 
* Debian/Ubuntu: <code>netpbm</code> 
* Red Hat/Fedora/CentOS: <code>netpbm-progs</code>
* Gentoo: <code>netpbm </code>

=== dvipng ===

WeBWorK uses dvipng to display mathematics graphically. It is only required if you wish to use the <code>images</code> display mode. dvipng requires the <code>preview.sty</code> file from the [http://preview-latex.sf.net/ preview-latex] package.

* Source: http://dvipng.sf.net/ 
* Debian: <code>dvipng</code>, <code>preview-latex-style</code> 
* Red Hat/Fedora/CentOS: <code>tetex</code>, <code>[http://sourceforge.net/projects/preview-latex/files/ preview-latex-common]</code>
* Gentoo: <code>dvipng</code> 

WeBWorK is initially configured to work with dvipng 1.0 or greater, but can be reconfigured to work with dvipng 0.8 or 0.9. See <code>webwork2/lib/WeBWorK/Constants.pm</code> for details.

=== TtH ===

WeBWorK uses TtH to display mathematics as formatted HTML. It is only required if you wish to use the <code>formatted-text</code> display mode.

* Source: http://hutchinson.belmont.ma.us/tth/ 
* Debian: <code>tth</code>
* Red Hat/Fedora/CentOS: <code>tth</code> from [[Aleksey Nogin's repository|Nogin]], or build from source 
* Gentoo: <code>tth</code>

== Installing the WeBWorK files ==

WeBWorK is typically installed using CVS. We provide version tags that correspond to each released version of WeBWorK. This ensures that you can maintain a stable system, and experimental upgrades will not be applied to your installation.

We also provide tarballs for each release. They contain the necessary CVS data to update from CVS at a later date. Choose a tarball if for some reason you do not want to use CVS. Keep in mind that because of the layout of files within the <code>webwork2</code> directory tree, upgrading an existing installation is harder using a tarball than using CVS.

=== Creating the base directory directory ===

Before you begin installing files, create a base directory to hold them. We prefer <code>/opt/webwork</code>:

 # mkdir -p /opt/webwork

To make things easier during the installation, you can give yourself write permission to this directory. That way, you won't have to become root to install the WeBWorK files:

 # chown yourNameHere /opt/webwork

=== Installing from CVS ===

Installing from CVS allows you more flexibility in selecting versions of the WeBWorK code between or ahead of releases. You have several options, depending on which release tag you select when accessing the CVS repository.

==== CVS tags ====

'''''Released version:''''' By specifying the '''rel-2-4-1''' tag, you get the same version of the code that you would by downloading the WeBWorK 2.4.1 tarball. This is the most conservative option. Updating will have no effect -- this code will never change.

'''''Released version with patches:''''' By specifying the '''rel-2-4-patches''' tag, you can stay up to date with the latest bug fixes against the released version of WeBWorK 2.4. Few, if any, new features are introduced on a patch branch. We recommend that you choose this option.

'''''Latest code:''''' If you do not specify a release tag, you will get the latest code. Since this code is a work in progress, it is sometimes unstable or broken. If you require features that are not in a stable release, and are willing to devote more time to keeping your installation running smoothly, this may be the option for you.

No matter what tag you chose, you can change later by specifying a new tag when running <code>cvs upgrade</code>.

==== New installation from CVS ====

If you do not have an existing WeBWorK installation, use the following commands to check out copies of the <code>webwork2</code> and <code>pg</code> modules. If you are prompted for a password, press enter.

'''''Released version:'''''

<code>$ cvs -d :pserver:anoncvs@cvs.webwork.rochester.edu:/webwork/cvs/system checkout -r rel-2-4-1 webwork2</code><br/>
<code>$ cvs -d :pserver:anoncvs@cvs.webwork.rochester.edu:/webwork/cvs/system checkout -r rel-2-4-0 pg</code>

'''''Released version with patches:'''''

<code>$ cvs -d :pserver:anoncvs@cvs.webwork.rochester.edu:/webwork/cvs/system checkout -r rel-2-4-patches webwork2 pg</code>

'''''Latest development code:'''''

<code>$ cvs -d :pserver:anoncvs@cvs.webwork.rochester.edu:/webwork/cvs/system checkout webwork2 pg</code>

The message <code>warning: cannot open /webwork/cvs/system/CVSROOT/val-tags read/write: Permission denied</code> is harmless and should be ignored.

After checkout finishes, become root and move the directories to the your installation directory. I prefer <code>/opt/webwork</code>:

 # cp -r webwork2 /opt/webwork/webwork2
 # cp -r pg /opt/webwork/pg

==== Upgrading using CVS ====

If you already have an existing WeBWorK installation, use the following commands to update your exsting files to version 2.4. You may need to become root to run these commands (depending on your permissions situation).

Take note of the messages that CVS gives during the update. If you have modified files, you may see the message <code>Merging differences between ''version1'' and ''version2'' into _filename_</code>. This indicates that the file in question is updated in WeBWorK 2.4, and since you also made local modifications to it, CVS is attempting to merge the two changed versions.

If this process fails, because the same parts of the file were modified in both versions, you will see the message <code>rcsmerge: warning: conflicts during merge</code>. If you end up in this situation, you will need to resolve the conflict by editing the file in question. Consult this [http://ximbiot.com/cvs/manual/cvs-1.11.22/cvs_10.html#SEC85 conflicts example] from the CVS manual.

The message <code>warning: cannot open /webwork/cvs/system/CVSROOT/val-tags read/write: Permission denied</code> is harmless and should be ignored.

'''''Released version:'''''

 cd /opt/webwork/webwork2
 cvs  -q update -dP -r rel-2-4-1
 cd /opt/webwork/pg
 cvs  -q update -dP -r rel-2-4-0

'''''Released version with patches:'''''

 cd /opt/webwork/webwork2
 cvs -q update -dP -r rel-2-4-patches
 cd /opt/webwork/pg
 cvs  -q update -dP -r rel-2-4-patches

'''''Latest development code:'''''

 cd /opt/webwork/webwork2
 cvs  -q update -dPA
 cd /opt/webwork/pg
 cvs  -q update -dPA

=== Installing from a tarball ===

Tarballs of WeBWorK releases are available from our [http://sf.net/project/showfiles.php?group_id=93112 SourceForge file release] page. You will need to download both a <code>webwork</code> tarball and a <code>pg</code> tarball. Make sure that the versions of the tarballs match. You can choose either a GZip or BZip2 archive.

After downloading the tarballs, untar them somewhere (like your home directory):

 $ tar -xjf webwork-2.4.1.tar.bz2
 $ tar -xjf pg-2.4.0.tar.bz2

If you have an existing WeBWorK installation, move your existing <code>webwork2</code> and <code>pg</code> directories to <code>webwork2.OLD</code> and <code>pg.OLD</code>, respectively. (You will move your existing courses and configuration over to the new directories later.)

Then, become root and move the directories to the your installation directory. The installation directory should '''not''' be web-accessible. I prefer <code>/opt/webwork</code>:

 # cp -r webwork-2.4.1 /opt/webwork/webwork2
 # cp -r pg-2.4.0 /opt/webwork/pg

From now on, we will assume that WeBWorK 2 is installed in <code>/opt/webwork/webwork2</code> and PG is installed in <code>/opt/webwork/pg</code>.

=== Installing fonts for jsMath ===

jsMath is a display mode that renders math expressions using a JavaScript implementation of the TeX math layout engine. For more information about jsMath, see http://www.math.union.edu/~dpvc/jsmath/.

Version 2.0 of jsMath introduced a new fallback method for when the TeX fonts are not available on the student's computer.  This uses images of the individual TeX characters in place of the TeX fonts, but this requires a large number of individual character images in a wide range of sizes.  These are distributed in <code>webwork2/htdocs/jsMath/jsMath-fonts.tar.gz</code>, and you need to unpack this tarball before jsMath will work properly.  Use the command

 $ cd /opt/webwork/webwork2/htdocs/jsMath
 $ tar -xzvf jsMath-fonts.tar.gz

This will unpack the archive.  Since there are 20,000 tiny files, it can take a long time, so the =v= option is used to show you the names as they are unpacked so that you know the command is actually doing something.  Once the images are unpacked, jsMath's image mode fallback (the default fallback method) will work properly, and most students will have results as good as they would with the TeX fonts installed.

If you do not wish to install the jsMath image fonts (to save space, for example), you should change the value of <code>noImageFonts</code> in the <code>$pg{displayModeOptions}{jsMath}</code> hash in <code>global.conf</code> to 1.  This will prevent jsMath from using the image fallback methods.

See also: [[#jsMath_settings|jsMath settings]]

=== Creating the courses directory ===

The courses directory should be located at <code>/opt/webwork/courses</code>. Placing the courses directory outside the <code>webwork2</code> directory makes updates easier.

You can create your courses directory from the <code>courses.dist</code> directory distributed with WeBWorK. This directory contains the skeleton of a course called <code>modelCourse</code>, which contains the template files for three demo sets. You can opt to copy templates from this set when creating new courses.

 $ cd /opt/webwork/webwork2
 $ cp -RPp courses.dist ../courses

If you prefer not to use <code>modelCourse</code>, you can create an empty courses directory instead:

 $ cd /opt/webwork
 $ mkdir courses

If you are upgrading from WeBWorK 2.2.x, move your existing courses into the new <code>/opt/webwork/courses</code> directory.

=== Making copies of distribution configuration files ===

Some files are distributed with the <code>.dist</code> suffix. You must make copies lacking the <code>.dist</code> suffix for WeBWorK to be able to find them. This is done to ease updating with CVS. The <code>.dist</code> files may be updated during a CVS update, but your local versions will be left untouched.

Before configuring the system, you must make local copies of the <code>global.conf</code> and <code>database.conf</code> configuration files, located in <code>/opt/webwork/webwork2/conf/</code>:

 $ cd /opt/webwork/webwork2/conf
 $ cp global.conf.dist global.conf
 $ cp database.conf.dist database.conf

=== Setting permissions ===

The PG installation directory and files should be owned by root and not writable by other users:

 # cd /opt/webwork/pg
 # chown -R root:root .
 # chmod -R u+rwX,go+rX .

Most WeBWorK directories and files should also be owned by root and not writable by other users:

 # cd /opt/webwork/webwork2
 # chown -R root:root .
 # chmod -R u+rwX,go+rX .

Certain data directories need to be writable by the web server. These are <code>DATA</code>, <code>courses</code>, <code>htdocs/tmp</code>, <code>logs</code>, and <code>tmp</code>. It is convenient to give WeBWorK administrators access to these directories as well, so they can perform administrative tasks such as removing temporary files, creating and editing courses from the command line, managing logs, and so on.

The simplest way to set this up assumes that all WeBWorK administrators have root access. In this case, directories that must be writable by the web server should be given the ''group'' of the web server. In the following examples, it is assumed that the web server's group is <code>www-data</code>.

If you wish to perform administrative tasks without becoming root, you can either add the WeBWorK administrators to the web server's group, or create a new group called <code>wwdata</code>, containing both the WeBWorK administrators and the web server.

If you chose not to create the <code>wwdata</code> group, the WeBWorK data directories should have the group of the web server:

 # cd /opt/webwork/webwork2
 # chgrp -R www-data DATA ../courses htdocs/tmp logs tmp
 # chmod -R g+w DATA ../courses htdocs/tmp logs tmp
 # find DATA/ ../courses/ htdocs/tmp/ logs/ tmp/ -type d -a ! -name CVS -exec chmod g+s {} \;

If you chose to create the <code>wwdata</code> group, the WeBWorK directories that must be writable by the web server should have that group:

 # cd /opt/webwork/webwork2
 # chgrp -R wwdata DATA ../courses htdocs/tmp logs tmp
 # chmod -R g+w DATA ../courses htdocs/tmp logs tmp
 # find DATA/ ../courses/ htdocs/tmp/ logs/ tmp/ -type d -a ! -name CVS -exec chmod g+s {} \;

==== CVS updates and permissions ====

In the instructions above, you set most WeBWorK and PG files to be owned and only writable by root. If you are planning to do in-place updates of the system with CVS, you may want to set those files to be owned by a regular user instead. That will let you avoid running CVS as root, which could be a security risk. One option is to create a user account that cannot be logged into directly and use it only for WeBWorK files.

== Configuring your shell ==

To make working with WeBWorK easier, there are a couple of changes you can make to your shell environment.

Add the WeBWorK <code>bin</code> directory to your path. This will allow you to run WeBWorK command-line utilities without typing the full path to the utility. If you installed WeBWorK in the default location of <code>/opt/webwork/webwork2</code>, add the directory <code>/opt/webwork/webwork2/bin</code> to your path.

{| border="1"
|-
| '''if your shell is''' || '''put this line''' || '''in this file''' 
|-
| <code>bash</code> || <tt>export PATH=$PATH:/opt/webwork/webwork2/bin</tt> || <code>~/.bashrc</code> 
|-
| <code>tcsh</code> || <tt>setenv PATH $PATH:/opt/webwork/webwork2/bin</tt> || <code>~/.cshrc</code> 

|}

Set the <code>WEBWORK_ROOT</code> environment variable. Some command-line scripts rely on this variable to find other WeBWorK files.

{| border="1"
|-
| '''if your shell is''' || '''put this line''' || '''in this file''' 
|-
| <code>bash</code> || <tt>export WEBWORK_ROOT=/opt/webwork/webwork2</tt> || <code>~/.bashrc</code> 
|-
| <code>tcsh</code> || <tt>setenv WEBWORK_ROOT /opt/webwork/webwork2</tt> || <code>~/.cshrc</code> 

|}

== Configuring WeBWorK ==

Most WW configuration is done in the file <code>/opt/webwork/webwork2/conf/global.conf</code>. This file provides system-wide configuration settings, and defaults for course settings. Any setting in this file can be overridden in the <code>course.conf</code> file for a particular course.

There are several options that must be set for WW to work with your system. The rest of the file consists of customization options.

=== Seed variables ===

These are the main configuration variables of WeBWorK. The are used by the Apache configuration and by the system itself. Many other settings rely on these variables:

{| border="1"
|-
| '''variable''' || '''description''' 
|-
| <code>$webwork_url</code> || The URL associated with the WeBWorK handler. Usually <code>/webwork2</code>. 
|-
| <code>$pg_root</code> || The path to the PG directory. Usually <code>/opt/webwork/pg</code>. 
|-
| <code>$webwork_htdocs_url</code> || The URL of static WeBWorK hypertext files. Usually <code>/webwork2_files</code>. 
|-
| <code>$webwork_htdocs_dir</code> || The path to the static WeBWorK hypertext files. Usually <code>$webwork_dir/htdocs</code>. 
|-
| <code>$webwork_courses_url</code> || The URL of the courses directory. Usually <code>/webwork2_course_files</code>. 
|-
| <code>$webwork_courses_dir</code> || The path to the courses directory. Usually <code>$webwork_dir/courses</code>. 

|}

=== Paths to external programs ===

To avoid executing malicious code, WW calls external programs using full path names.

{| border="1"
|-
| '''variable''' || '''description''' 
|-
| <code>$externalPrograms{mkdir}</code> || Path to <code>mkdir</code> binary. Usually <code>/bin/mkdir</code>. 
|-
| <code>$externalPrograms{mysql}</code> || Path to <code>mysql</code> binary. Usually <code>/usr/bin/mysql</code> or <code>/usr/local/bin/mysql</code>. 
|-
| <code>$externalPrograms{tar}</code> || Path to <code>tar</code> binary. Usually <code>/usr/bin/tar</code>. 
|-
| <code>$externalPrograms{latex}</code> || Path to <code>latex</code> binary. Usually <code>/usr/bin/latex</code> or <code>/usr/local/bin/latex</code>. 
|-
| <code>$externalPrograms{pdflatex}</code> || Path to <code>pdflatex</code> binary. Usually <code>/usr/bin/pdflatex</code> or <code>/usr/local/bin/pdflatex</code>. 
|-
| <code>$externalPrograms{dvipng}</code> || Path to <code>dvipng</code> binary. Usually <code>/usr/bin/dvipng</code> or <code>/usr/local/bin/dvipng</code>. 
|-
| <code>$externalPrograms{tth}</code> || Path to <code>tth</code> binary. Usually <code>/usr/bin/tth</code> or <code>/usr/local/bin/tth</code>. 
|-
| <code>$externalPrograms{giftopnm}</code> || Path to <code>giftopnm</code> binary. Usually <code>/usr/bin/giftopnm</code> or <code>/usr/local/bin/giftopnm</code>. 
|-
| <code>$externalPrograms{ppmtopgm}</code> || Path to <code>ppmtopgm</code> binary. Usually <code>/usr/bin/ppmtopgm</code> or <code>/usr/local/bin/ppmtopgm</code>. 
|-
| <code>$externalPrograms{pnmtops}</code> || Path to <code>pnmtops</code> binary. Usually <code>/usr/bin/pnmtops</code> or <code>/usr/local/bin/pnmtops</code>. 
|-
| <code>$externalPrograms{pnmtopng}</code> || Path to <code>pnmtopng</code> binary. Usually <code>/usr/bin/pnmtopng</code> or <code>/usr/local/bin/pnmtopng</code>. 
|-
| <code>$externalPrograms{pngtopnm}</code> || Path to <code>pngtopnm</code> binary. Usually <code>/usr/bin/pngtopnm</code> or <code>/usr/local/bin/pngtopnm</code>. 

|}

=== Mail settings ===

WW sends mail in three instances. The PG system sends mail to report answers to questionnaires and free-response problems. The mail merge module is used to send mail to course participants, i.e. to report scores. The feedback module allows participants to send mail to course instructors.

To send mail, WW needs the address of an SMTP server. When connecting to the SMTP server, it must also send an email address representing the sender of the email.

{| border="1"
|-
| '''variable''' || '''description''' 
|-
| <code>$mail{smtpServer}</code> || The address of an SMTP server. If the local machine is running an SMTP server (as is likely), use <code>localhost</code>. 
|-
| <code>$mail{smtpSender}</code> || The address to send when connecting to the SMTP server. This has nothing to do with the <code>From</code> address on the mail message. 

|}

=== Database settings ===

The following settings are used in connecting to the MySQL database.

{| border="1"
|-
| '''variable''' || '''description''' 
|-
| <code>$database_dsn</code> || The location of the WeBWorK database. Usually <code>dbi.mysql.webwork</code>. See the Perl DBI documentation for more information about DSNs. 
|-
| <code>$database_username</code> || The username to use when connecting to the database. Usually <code>webworkWrite</code>. 
|-
| <code>$database_password</code> || The password to use when connecting to the database. Use a secure, random password of sufficient length. 

|}

The <code>$dbLayoutName</code> variable controls the default database layout that will be used for new courses. If you plan to use MoodleIntegration on all new courses, set this to "sql_moodle". Otherwise, leave it set to the default, "sql_single".

You can override the default when creating a new course.

=== Timezone setting ===

You can set the local timezone to use when displaying times using the <code>$siteDefaults{timezone}</code> setting. To get a list of timezone names, run:

 $ perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::all_names'

To get a list of valid timezone "links" (deprecated names), run:

 $ perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::links'

Links can be shorter and more familiar, but they may be ambiguous.

=== Display modes ===

WeBWorK has several techniques for displaying homework problems. Which of these modes is available is controlled by the <code>$pg{displayModes}</code> list. To disable a display mode, comment out its line from the list by inserting a <code>#</code> character at the beginning of the line.

The supported display modes are as follows:

{| border="1"
|-
| '''display mode''' || '''status''' || '''description''' 
|-
| <code>plainText</code> || STABLE || This mode shows the raw TeX source of mathematics. It is useful for debugging. 
|-
| <code>formattedText</code> || DEPRECATED || This mode uses the <code>tth</code> program to represent mathematics as HTML table structures. Output quality depends on the browser. There are typically font problems on the Mac platform. 
|-
| <code>images</code> || STABLE || This mode uses the <code>dvipng</code> program to represent mathematics as PNG images. This gives excellent output on all browsers, but uses more bandwidth, as the images must be sent to the client. 
|-
| <code>jsMath</code> || STABLE || This mode uses jsMath to display mathematics. The raw TeX is sent to the client, where a JavaScript program displays it. This requires the client to have a decent JavaScript implementation, and can be slow on older machines. 
|-
| <code>asciimath</code> || DEPRECATED || This mode converts mathematics to ASCIIMath on the server and uses a <nobpo>JavaScript to convert them to MathML on the client. Requires a Mozilla-based browser or MSIE with the MathPlater plugin. 
|-
| <code>LaTeXMathML</code> || EXPERIMENTAL || This mode is a modification of the <code>asciimath</code> mode that skips the intermediate ASCIIMath form. Requires a Mozilla-based browser or MSIE with the MathPlater plugin. 

|}

=== jsMath settings ===

When a student doesn't have the TeX fonts installed, jsMath can display a warning message pointing to the jsMath font download site.  Since the image-mode fallback method is of high enough quality, most students will not feel the need to download and install the fonts, so this warning message is disabled by default.  (It tended to worry the students, and there is a link to the download page on the control panel that is new in version 2.0 of jsMath).

jsMath settings are stored in the <code>$pg{displayModeOptions}{jsMath}</code> hash:

{| border="1"
|-
| '''variable''' || '''description''' 
|-
| <code>reportMissingFonts</code> || Set to 1 if you want to have a message displayed for students who don't have the TeX fonts installed. The warning will only be shown on the first page they view that used jsMath (and there is a "hide" button that they can use to hide it even on that page). They can use the control panel to disable the warning messages permanently for their computer, if they want, so even if you turn on the warning message, it is not too intrusive. 
|-
| <code>missingFontMessage</code> || An HTML string that will be used for the missing font message (when <code>reportMissingFonts</code> is non-zero). This string will replace the default warning message, and can be used to point to your own page of instructions for getting the fonts, for example, or for using the control panel to disable the warning. 
|-
| <code>noImageFonts</code> || Set to 1 to prevent jsMath from using the image fallback method. This can be useful if you elected not to unpack the <code>jsMath-fonts.tar.gz</code> archive. 
|-
| <code>processDoubleClicks</code> || By default, double-clicking on the math expression will display the TeX source that generated it. If you wish to disable this behavior, set this to 0. (Note that the raw TeX is still available in the page's HTML source.) 

|}

== Configuring the database ==

WeBWorK uses a single MySQL database to store course data. By default, this database is named <code>webwork</code> and is accessed by a MySQL user named <code>webworkWrite</code>.

=== Creating a new database ===

If this is a new installation, you must create the <code>webwork</code> database:

 $ mysql -u root -p mysql
 Password: '''***'''
 > CREATE DATABASE webwork;
 > GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, LOCK TABLES
 ON webwork.* TO webworkWrite@localhost IDENTIFIED BY 'password';
 > exit
 Bye
 $ 

(Replace <code>password</code> with the password you set for <code>$database_password</code> in <code>global.conf</code>.)

=== Using an existing database ===

If you already have a <code>webwork</code> database from WeBWorK 2.1.x or 2.2.x, you must run the utility <code>wwdb_check</code> to make sure that it is up-to-date for use with 2.4.x. You should '''not''' use this utility if you are upgrading from 2.3.x or an earlier version of 2.4.x. (For example, from 2.4.1 to 2.4.2.)

To run the utility:

 $ /opt/webwork/webwork2/bin/wwdb_check

The script will look at the structure of your <code>webwork</code> database, and alert you to missing tables, missing fields, and incorrect field types. You will have the option to fix these problems.

WeBWorK 2.4 requires permision to <code>LOCK TABLES</code> in the <code>webwork</code> database. Use the <code>mysql</code> console to add it:

 $ mysql -u root mysql
 Password: '''***'''
 > GRANT LOCK TABLES ON webwork.* TO webworkWrite@localhost;
 > exit;
 $

=== Automated database initialization and upgrade ===

WeBWorK 2.3.0 introduces an automatic database upgrade system. Rather than manually issuing SQL commands to make changes to the database, or using ad-hoc scripts like <code>wwdb_addgw</code>, there is a single script called <code>wwdb_upgrade</code> that applies any necessary updates. It should be run when creating a new database, and any time you upgrade WeBWorK.

 $ /opt/webwork/webwork2/bin/wwdb_upgrade

Add the <code>-v</code> switch to get more information about what the script is doing.

=== Image depths database ===

The "images" display mode has the capability to store depth information in a <code>depths</code> table when equation images are generated. The information allows better alignment of images with surrounding text. In previous versions of WeBWorK, the <code>depths</code> table was stored in a separate database, named <code>DvipngDepths</code>. Starting with WeBWorK 2.3.0, it is stored in the <code>webwork</code> database itself.

If you are upgrading an existing installation, and you had set <code>$pg{displayModeOptions}{images}{dvipng_align}</code> to <code>mysql</code> in the old version, you have depths information stranded in your old <code>DvipngDepths</code> database, and existing images will lose access to this information.

The easiest way to solve this is to delete the existing images. This is probably a good idea anyway when upgrading since existing images won't take advantage of rendering improvements, dvipng improvements, etc. To delete the images:

 $ /opt/webwork/webwork2/bin/remove_stale_images --days=0 --delete

== Configuring Apache ==

=== Testing mod_perl ===

To verify that mod_perl is installed, you can use mod_info to list the installed modules. If mod_info itself is disabled or not installed, you can either install/enable it, or skip this test and check using Apache::Status instead. The process for installing and enabling modules varies by distribution. To configure mod_perl, uncomment the location block <code>&lt;Location /server-info&gt;</code> in your Apache config file (usually <code>httpd.conf</code> or <code>apache.conf</code>). It should look something like this:

 <Location /server-info>
    SetHandler server-info
    Order deny,allow
    Deny from all
    Allow from localhost
    Allow from .yourschool.edu
 </Location>

You may have to add the <code>Order</code>, <code>Deny</code>, and <code>Allow</code> lines yourself, or there may already be lines there you can customize. Restart Apache (<code>apachectl graceful</code>) and visit <code>http://yourserver.yourschool.edu/server-info</code>. You should see an entry in the list of active modules for mod_perl.

To further test mod_perl, you can install the Perl module Apache::Status. After installing, add the following section to your Apache config file:

 <Location /perl-status>
    SetHandler perl-script
    PerlHandler Apache::Status
    Order deny,allow
    Deny from all
    Allow from localhost
    Allow from .yourschool.edu
 </Location>

Restart Apache (<code>apachectl graceful</code>) and visit <code>http://yourserver.yourschool.edu/perl-status</code>. You should see a page listing various information about mod_perl.

=== Enabling WeBWorK ===

Once mod_perl is working, Apache must be configured to handle requests for WeBWorK. Apache provides access to WeBWorK through three URL locations:

* The location that is handled by the <code>Apache::WeBWorK</code> module, usually <code>/webwork2</code>.
* The location of system-wide resources, usually <code>/webwork2_files</code>.
* The location of course-specific resources, usually <code>/webwork2_course_files</code>.

WeBWorK ships with an Apache config file that you can include in your main Apache config file. The file is named <code>webwork.apache-config.dist</code> and located in the <code>conf</code> directory. First, copy the file to <code>webwork.apache-config</code>:

 $ cd /opt/webwork/webwork2/conf
 $ cp webwork.apache-config.dist webwork.apache-config

Then, edit the copy to set the <code>$webwork_dir</code> variable to the path of the directory containing the WeBWorK installation. This is usually <code>/opt/webwork/webwork2</code>. This value is used to read the WeBWorK configuration file and get the rest of the configuration data.

Further down in the file, you may want to customize the directives used to define the association between Apache and WeBWorK. Specifically, you may need to add the following to the <code>&lt;Location&gt;</code> and <code>&lt;Directory&gt;</code> stanzas, to permit access:

 Order allow,deny
 Allow from all

After editing <code>webwork.apache-config</code>, append the following line to your Apache configuration file:

 Include /opt/webwork/webwork2/conf/webwork.apache-config

If you are upgrading from a previous version of WeBWorK which did not use the <code>webwork.apache-config</code> file, you will need to remove the WeBWorK-related directives from your Apache configuration.

Then restart Apache and test your configuration:

* Test the <code>/webwork2</code> location by visiting <code>http://yourserver.yourschool.edu/webwork2</code>. You should see the WeBWorK home page, with no courses listed.
* Test the <code>/webwork2_files</code> location by visiting <code>http://yourserver.yourschool.edu/webwork2_files</code>. You should see the "WeBWorK Placeholder Page".
* You cannot test the <code>/webwork2_course_files</code> location until you have created a course.

=== Experimental support for Apache 2.0.x ===

If you are using Apache 2.0.x, follow the directions above, with these changes:

Enable the libapreq module by adding the following line to your Apache2 configuration file. Place this line with the other <code>LoadModule</code> lines.

 LoadModule apreq_module modules/mod_apreq.so

Use the module Apache2::Status in place of Apache::Status.

Use the file <code>webwork.apache2-config</code> in place of <code>webwork.apache-config</code>.

== Creating the admin course ==

WeBWorK includes web-based course management tools. Access to these tools is controlled by a special course named <code>admin</code>. The instructors in this course are permittied to perform administrative functions. If the admin course exists, a '''Course Administration''' link will appear on the WeBWorK home page.

If you created a <code>wwadmin</code> group, create the admin course as follows:

 $ cd /opt/webwork/courses
 $ newgrp wwadmin
 $ umask 2
 $ addcourse
 $ addcourse admin --db-layout=sql_single --users=adminClasslist.lst --professors=admin
 $ exit

If you did not create a <code>wwadmin</code> group, create the admin course as follows:

 $ sudo -u www-data addcourse admin --db-layout=sql_single --users=adminClasslist.lst --professors=admin

Replace <code>www-data</code> with the user your webserver runs as.

See CourseAdministrationManual#Permissions_issues for more about getting the permission right when using the command-line tools.

If you get an error about WEBWORK_ROOT not being found in the environment (and it is set in your ~/.bashrc), try this instead:

 $ sudo -u www-data env WEBWORK_ROOT=/opt/webwork/webwork2 addcourse admin --db-layout=sql_single --users=adminClasslist.lst --professors=admin

After you create the course, visit the WeBWorK home page on your server, usually located at <code>http://yourserver.yourschool.edu/webwork2</code>. Click on the '''Course Administration''' link. You can also access the admin course directly, at <code>http://yourserver.yourschool.edu/webwork2/admin</code>.

To log in, enter <code>admin</code> for your username and <code>admin</code> for your password. Once logged into the admin course, the first thing you should do is change the password for the admin account. You can do this by clicking the '''Password/Email''' link on the links menu. After you do this, you may add accounts for any additional people who should have administrative access using the '''Class List Editor''' link.

== Where to go from here ==

Read [[Course Administration]] for more information about managing courses.

Read [[Problem Libraries]] for information on installing libraries of pre-written WeBWorK problems.

Read [[Moodle Integration]] for information on including WeBWorK problem sets in Moodle courses. (Experimental)

Read [[LDAP Authentication]] for information about LDAP authentication. (Experimental)

Consult [[:Category:Administrators]] for other WeBWorK documentation for system administrators.

[[Category:Installation Manuals]]