Automatic Installation Script Guide

From WeBWorK_wiki
Revision as of 11:11, 22 December 2015 by Geoff Goehle (talk | contribs)
Jump to navigation Jump to search

WeBWorK Installation Script(s)

The github repository at [1] contains a perl script `ww_install.pl`, along with some supporting bash scripts, config files, and perl modules designed to work together install the open source online homework system [WeBWorK](https://github.com/openwebwork).

The script has been updated to install WeBWorK 2.11 as of 12/22/2015.

It has been tested and supported on

  • Debian 7, 8
  • Fedora 22
  • Ubuntu 14.04, 15.04, 15.10
  • CentOS 6, 7

On these systems it did install WeBWorK.

Gotchas

- Fedora 23 uses Perl 5.22 which is incompatible with mod_perl. Since WeBWorK uses mod_perl this will prevent installation of WeBWorK on Fedora 23.

Usage

To install [WeBWorK](https://github.com/openwebwork):

1. Get the `install_webwork.sh` script: 

 `wget --no-check-certificate https://raw.github.com/openwebwork/ww_install/master/install_webwork.sh`
 
 or if you prefer
 
 `curl -ksSO https://raw.github.com/openwebwork/ww_install/master/install_webwork.sh`

2. As root (or with sudo) do 

 `bash install_webwork.sh`

Note that if you use sudo, then you must be a sudoer with sufficient administrative rights (probably `ALL=(ALL) ALL`) for `install_webwork.sh` to work properly. If not, run this command as root.

For more control over the process you can clone this repository with

`git clone https://github.com/openwebwork/ww_install.git`

and then run the scripts individually as needed.

Contents

      1. install_webwork.sh

This script is the 'controller' that ties together the other scripts. It opens an install log, downloads this repo and opens it in (typically) `/tmp`. Then it installs any files needed to run `ww_install.pl` and then runs `ww_install.pl`. When `ww_install.pl` exits, it attempts to open webwork in the system's default web browser, copies webwork_install.log to your top level webwork directory (e.g. `/opt/webwork`) and then deletes the downloaded installation package.

      1. bin/ww_install.pl

The goal of `ww_install.pl` is to install WeBWorK on any system with a properly set up distribution file in the `distros` folder.

It is an interactive script based on the core perl module [Term::UI](http://perldoc.perl.org/Term/UI.html), and is written with the goal of being cross-platform. It does use some linux built-ins, and work is needed to ensure that this script will work as well on unix machines. Again, contributions of work in this direction would be welcome.

      1. distros

This folder contains distribution files which `ww_install.pl` uses to install WeBWorK on various systems. For example the file `distros/centos/7.pm` is used to install WeBWorK on CentOS version 7. If you are interested in getting the installer working on your favorite distribution you would create the appropriate file in this folder and submit a pull request. You can base your distro file off of `blankdistro.pm`. In general you will need to set the following:

  • The array of versions which you have tested the installer on.
  • The list of packages which provide the binaries described by the hash keys
  • The list of packages which provide the perl modules described by the hash keys. Use 'CPAN' if you intend to get the package from CPAN
  • The `apacheLayout` array which defines where various folders and configuration files are for your apache setup.
  • The command for updating package sources.
  • The command for updating packages.
  • The command for installing packages.
  • The command for installing packages from CPAN.
  • The command for checking and configuring services post install.
  • You can add code in various "hooks" which will be run at various stages of the installation. This is an opportunity to perform any hacky fixes necessary for your distro.
      1. Other files

The `extra/` subdirectory contains scripts which help with optional post install tasks. These are not currently hooked into the other scripts, so you'll need to run them separately. Currently contains

  • `iptables_rules.sh`
 Sets up an iptables firewall which only allows network services necessary for running WeBWorK.
  • `generate_ssl_cert.sh`
 Steps user through generating an ssl cert.  Under construction.
  • `install_chromatic.pl`
 Standalone script to compile `pg/lib/chromatic/color.c` so the NAU library graph theory problems work. This
 functionality has been incorporated into `ww_install.pl`, so it should not be necessary to run this script. However,
 if you find the NAU graph theory problems are complaining that `pg/lib/chromatic/color` doesn't exist, then you 
 can run this script to compile it for you.

The `lib/` subdirectory contains copies of any perl modules the script uses but which don't need to be installed on your system for webwork to run.

The `conf/` subdirectory contains copies of config files or snippets of config files that this installation package will ask to modify.

Other Resources

Please report any problems on the [issues page](https://github.com/aubreyja/ww_install/issues?state=open) for this repository.

Questions and comments about this installer can be directed to me on the [webwork-devel](http://webwork.maa.org/mailman/listinfo/webwork-devel) mailing list. For a recent discussion see 1(http://webwork.maa.org/pipermail/webwork-devel/2013-June/001089.html).

Information and documentation about WeBWorK itself can be found at http://webwork.maa.org/wiki

Author

Jason Aubrey <aubreyja@gmail.com>

If you use the script, please email me to let me know what OS you installed it on so I can add a notation to the list of tested distributions above and address any problems you run into. I'd also be happy to hear suggestions for improvement. Seriously, though. Send all yoru complaints to this guy.

Retrieved from "https://webwork.maa.org/mediawiki_new/index.php?title=Automatic_Installation_Script_Guide&oldid=16823"