[system] / trunk / webwork2 / conf / global.conf.dist Repository:
ViewVC logotype

Diff of /trunk/webwork2/conf/global.conf.dist

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1696 Revision 4741
1#!perl 1#!perl
2################################################################################ 2################################################################################
3# WeBWorK Online Homework Delivery System 3# WeBWorK Online Homework Delivery System
4# Copyright © 2000-2003 The WeBWorK Project, http://openwebwork.sf.net/ 4# Copyright © 2000-2006 The WeBWorK Project, http://openwebwork.sf.net/
5# $CVSHeader: webwork-modperl/conf/global.conf.dist,v 1.44 2003/12/09 01:12:28 sh002i Exp $ 5# $CVSHeader: webwork2/conf/global.conf.dist,v 1.181 2007/01/08 20:35:54 sh002i Exp $
6# 6#
7# This program is free software; you can redistribute it and/or modify it under 7# This program is free software; you can redistribute it and/or modify it under
8# the terms of either: (a) the GNU General Public License as published by the 8# the terms of either: (a) the GNU General Public License as published by the
9# Free Software Foundation; either version 2, or (at your option) any later 9# Free Software Foundation; either version 2, or (at your option) any later
10# version, or (b) the "Artistic License" which comes with this package. 10# version, or (b) the "Artistic License" which comes with this package.
… …
17 17
18# This file is used to set up the default WeBWorK course environment for all 18# This file is used to set up the default WeBWorK course environment for all
19# requests. Values may be overwritten by the course.conf for a specific course. 19# requests. Values may be overwritten by the course.conf for a specific course.
20# All package variables set in this file are added to the course environment. 20# All package variables set in this file are added to the course environment.
21# If you wish to set a variable here but omit it from the course environment, 21# If you wish to set a variable here but omit it from the course environment,
22# use the "my" keyword. The following variables are available to this file: 22# use the "my" keyword. The $webwork_dir variable is set in the WeBWorK Apache
23# 23# configuration file (webwork.apache-config) and is available for use here. In
24# $webworkRoot directory that contains the WeBWorK distribution 24# addition, the $courseName variable holds the name of the current course.
25# $webworkURL base URL handled by Apache::WeBWorK
26# $pgRoot directory that contains the PG distribution
27# $courseName name of the course being used
28 25
29################################################################################ 26################################################################################
30# WeBWorK settings 27# Seed variables
31################################################################################ 28################################################################################
32 29
33%webworkDirs = ( 30# Set these variables to correspond to your configuration and preferences. You
34 root => "$webworkRoot", 31# will need to restart the webserver to reset the variables in this section.
35 DATA => "$webworkRoot/DATA", 32
36 uploadCache => "$webworkRoot/DATA/uploads", 33# URL of WeBWorK handler.
37 bin => "$webworkRoot/bin", 34$webwork_url = "/webwork2";
38 conf => "$webworkRoot/conf", 35
39 courses => "$webworkRoot/courses", 36# Root directory of PG.
40 htdocs => "$webworkRoot/htdocs", 37$pg_dir = "/opt/webwork/pg";
41 htdocs_temp => "$webworkRoot/htdocs/tmp", 38
39# URL and path to htdocs directory.
40$webwork_htdocs_url = "/webwork2_files";
41$webwork_htdocs_dir = "$webwork_dir/htdocs";
42
43# URL and path to courses directory.
44$webwork_courses_url = "/webwork2_course_files";
45$webwork_courses_dir = "/opt/webwork/courses";
46
47################################################################################
48# Paths to external programs
49################################################################################
50
51# system utilties
52$externalPrograms{mkdir} = "/bin/mkdir";
53$externalPrograms{mv} = "/bin/mv";
54$externalPrograms{mysql} = "/usr/bin/mysql";
55$externalPrograms{tar} = "/usr/bin/tar";
56
57# equation rendering/hardcopy utiltiies
58$externalPrograms{latex} = "/usr/bin/latex";
59$externalPrograms{pdflatex} = "/usr/bin/pdflatex --shell-escape";
60$externalPrograms{dvipng} = "/usr/bin/dvipng";
61$externalPrograms{tth} = "/usr/bin/tth";
62
63# NetPBM - basic image manipulation utilities
64# most sites only need to configure $netpbm_prefix.
65my $netpbm_prefix = "/usr/bin";
66$externalPrograms{giftopnm} = "$netpbm_prefix/giftopnm";
67$externalPrograms{ppmtopgm} = "$netpbm_prefix/ppmtopgm";
68$externalPrograms{pnmtops} = "$netpbm_prefix/pnmtops";
69$externalPrograms{pnmtopng} = "$netpbm_prefix/pnmtopng";
70$externalPrograms{pngtopnm} = "$netpbm_prefix/pngtopnm";
71
72# url checker
73$externalPrograms{checkurl} = "/usr/local/bin/lwp-request -mHEAD "; # or "/usr/local/bin/w3c -head "
74
75# image conversions utiltiies
76# the source file is given on stdin, and the output expected on stdout.
77#
78# Note on conversions pipelines:
79# we used to use `pnmdepth 1' instead of ppmtopgm as it creates a
80# monochrome image (1 bit) rather than a greyscale image (8 bits).
81# However, this was causing improper display of some sort in PDFs.
82$externalPrograms{gif2eps} = "$externalPrograms{giftopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null";
83$externalPrograms{png2eps} = "$externalPrograms{pngtopnm} | $externalPrograms{ppmtopgm} | $externalPrograms{pnmtops} -noturn 2>/dev/null";
84$externalPrograms{gif2png} = "$externalPrograms{giftopnm} | $externalPrograms{pnmtopng}";
85
86################################################################################
87# Mail settings
88################################################################################
89
90# Mail sent by the PG system and the mail merge and feedback modules will be
91# sent via this SMTP server.
92$mail{smtpServer} = 'mail.yourschool.edu';
93
94# When connecting to the above server, WeBWorK will send this address in the
95# MAIL FROM command. This has nothing to do with the "From" address on the mail
96# message. It can really be anything, but some mail servers require it contain
97# a valid mail domain, or at least be well-formed.
98$mail{smtpSender} = 'webwork@yourserver.yourschool.edu';
99
100# AllowedRecipients defines addresses that the PG system is allowed to send mail
101# to. this prevents subtle PG exploits. This should be set in course.conf to the
102# addresses of professors of each course. Sending mail from the PG system (i.e.
103# questionaires, essay questions) will fail if this is not set somewhere (either
104# here or in course.conf).
105$mail{allowedRecipients} = [
106 #'prof1@yourserver.yourdomain.edu',
107 #'prof2@yourserver.yourdomain.edu',
108];
109
110# By default, feeback is sent to all users who have permission to
111# receive_feedback. If this list is non-empty, feedback is also sent to the
112# addresses specified here.
113#
114# * If you want to disable feedback altogether, leave this empty and set
115# submit_feeback => $nobody in %permissionLevels below. This will cause the
116# feedback button to go away as well.
117#
118# * If you want to send email ONLY to addresses in this list, set
119# receive_feedback => $nobody in %permissionLevels below.
120#
121# It's often useful to set this in the course.conf to change the behavior of
122# feedback for a specific course.
123#
124# Items in this list may be bare addresses, or RFC822 mailboxes, like:
125# 'Joe User <joe.user@example.com>'
126# The advantage of this form is that the resulting email will include the name
127# of the recipient in the "To" field of the email.
128#
129$mail{feedbackRecipients} = [
130 #'prof1@yourserver.yourdomain.edu',
131 #'prof2@yourserver.yourdomain.edu',
132];
133
134# Feedback subject line -- the following escape sequences are recognized:
135#
136# %c = course ID
137# %u = user ID
138# %s = set ID
139# %p = problem ID
140# %x = section
141# %r = recitation
142# %% = literal percent sign
143#
144$mail{feedbackSubjectFormat} = "[WWfeedback] course:%c user:%u set:%s prob:%p sec:%x rec:%r";
145
146# feedbackVerbosity:
147# 0: send only the feedback comment and context link
148# 1: as in 0, plus user, set, problem, and PG data
149# 2: as in 1, plus the problem environment (debugging data)
150$mail{feedbackVerbosity} = 1;
151
152# Defines the size of the Mail Merge editor window
153# FIXME: should this be here? it's UI, not mail
154# FIXME: replace this with the auto-size method that TWiki uses
155$mail{editor_window_rows} = 15;
156$mail{editor_window_columns} = 100;
157
158# Use this to customize the text of the feedback button.
159$feedback_button_name = "Email instructor";
160
161################################################################################
162# System-wide locations (directories and URLs)
163################################################################################
164
165# The root directory, set by webwork_root variable in Apache configuration.
166$webworkDirs{root} = "$webwork_dir";
167
168# Location of system-wide data files.
169$webworkDirs{DATA} = "$webworkDirs{root}/DATA";
170
171# Used for temporary storage of uploaded files.
172$webworkDirs{uploadCache} = "$webworkDirs{DATA}/uploads";
173
174# Location of utility programs.
175$webworkDirs{bin} = "$webworkDirs{root}/bin";
176
177# Location of configuration files, templates, snippets, etc.
178$webworkDirs{conf} = "$webworkDirs{root}/conf";
179
180# Location of theme templates.
181$webworkDirs{templates} = "$webworkDirs{conf}/templates";
182
183# Location of course directories.
184$webworkDirs{courses} = "$webwork_courses_dir" || "$webworkDirs{root}/courses";
185
186# Contains log files.
187$webworkDirs{logs} = "$webworkDirs{root}/logs";
188
189# Contains non-web-accessible temporary files, such as TeX working directories.
190$webworkDirs{tmp} = "$webworkDirs{root}/tmp";
191
192# The (absolute) destinations of symbolic links that are OK for the FileManager to follow.
193# (any subdirectory of these is a valid target for a symbolic link.)
194# For example:
195# $webworkDirs{valid_symlinks} = ["$webworkDirs{courses}/modelCourse/templates","/ww2/common/sets"];
196$webworkDirs{valid_symlinks} = [];
197
198##### The following locations are web-accessible.
199
200# The root URL (usually /webwork2), set by <Location> in Apache configuration.
201$webworkURLs{root} = "$webwork_url";
202
203# Location of system-wide web-accessible files, such as equation images, and
204# help files.
205$webworkDirs{htdocs} = "$webwork_htdocs_dir" || "$webworkDirs{root}/htdocs";
206$webworkURLs{htdocs} = "$webwork_htdocs_url";
207
208# Location of web-accessible temporary files, such as equation images.
209$webworkDirs{htdocs_temp} = "$webworkDirs{htdocs}/tmp";
210$webworkURLs{htdocs_temp} = "$webworkURLs{htdocs}/tmp";
211
212# Location of cached equation images.
213$webworkDirs{equationCache} = "$webworkDirs{htdocs_temp}/equations";
42 equationCache => "$webworkRoot/htdocs/tmp/equations", 214$webworkURLs{equationCache} = "$webworkURLs{htdocs_temp}/equations";
43 lib => "$webworkRoot/lib", 215
44 logs => "$webworkRoot/logs", 216# Contains context-sensitive help files.
45 macros => "$pgRoot/macros", 217$webworkDirs{local_help} = "$webworkDirs{htdocs}/helpFiles";
46 tmp => "$webworkRoot/tmp", 218$webworkURLs{local_help} = "$webworkURLs{htdocs}/helpFiles";
219
220# URL of general WeBWorK documentation.
221$webworkURLs{docs} = "http://webhost.math.rochester.edu/webworkdocs/docs";
222
223# URL of WeBWorK Bugzilla database.
224$webworkURLs{bugReporter} = "http://bugs.webwork.rochester.edu/";
225
226# Location of CSS
227$webworkURLs{stylesheet} = "$webworkURLs{htdocs}/css/ur.css";
228
229# Location of jsMath script, used for the jsMath display mode.
230$webworkURLs{jsMath} = "$webworkURLs{htdocs}/jsMath/jsMath-ww.js";
231
232# Location of ASCIIMathML script, used for the asciimath display mode.
233$webworkURLs{asciimath} = "$webworkURLs{htdocs}/ASCIIMathML/ASCIIMathML.js";
234
235# Location of LaTeXMathML script, used for the LaTeXMathML display mode.
236$webworkURLs{LaTeXMathML} = "$webworkURLs{htdocs}/LaTeXMathML/LaTeXMathML.js";
237
238################################################################################
239# Defaults for course-specific locations (directories and URLs)
240################################################################################
241
242# The root directory of the current course. (The ID of the current course is
243# available in $courseName.)
244$courseDirs{root} = "$webworkDirs{courses}/$courseName";
245
246# Location of course-specific data files.
247$courseDirs{DATA} = "$courseDirs{root}/DATA";
248
249# Location of course HTML files, passed to PG.
250$courseDirs{html} = "$courseDirs{root}/html";
251$courseURLs{html} = "$webwork_courses_url/$courseName";
252
253# Location of course image files, passed to PG.
254$courseDirs{html_images} = "$courseDirs{html}/images";
255
256# Location of web-accessible, course-specific temporary files, like static and
257# dynamically-generated PG graphics.
258$courseDirs{html_temp} = "$courseDirs{html}/tmp";
259$courseURLs{html_temp} = "$courseURLs{html}/tmp";
260
261# Location of course-specific logs, like the transaction log.
262$courseDirs{logs} = "$courseDirs{root}/logs";
263
264# Location of scoring files.
265$courseDirs{scoring} = "$courseDirs{root}/scoring";
266
267# Location of PG templates and set definition files.
268$courseDirs{templates} = "$courseDirs{root}/templates";
269
270# Location of course-specific macro files.
271$courseDirs{macros} = "$courseDirs{templates}/macros";
272
273# Location of mail-merge templates.
274$courseDirs{email} = "$courseDirs{templates}/email";
275
276# Location of temporary editing files.
277$courseDirs{tmpEditFileDir} = "$courseDirs{templates}/tmpEdit";
278
279# If this is set to a non-empty value (i.e. in course.conf), WeBWorK's usual
280# email feedback mechanism will be replaced with a link to the given URL.
281# See also $feedback_button_name, above.
282$courseURLs{feedbackURL} = "";
283# mail merge status directory
284$courseDirs{mailmerge} = "$courseDirs{DATA}/mailmerge";
285
286################################################################################
287# System-wide files
288################################################################################
289
290# Location of this file.
291$webworkFiles{environment} = "$webworkDirs{conf}/global.conf";
292
293# Flat-file database used to protect against MD5 hash collisions. TeX equations
294# are hashed to determine the name of the image file. There is a tiny chance of
295# a collision between two TeX strings. This file allows for that. However, this
296# is slow, so most people chose not to worry about it. Set this to "" if you
297# don't want to use the equation cache file.
298$webworkFiles{equationCacheDB} = ""; # "$webworkDirs{DATA}/equationcache";
299
300##### Hardcopy snippets are used in constructing a TeX file for hardcopy output.
301##### They should contain TeX code unless otherwise noted.
302
303# The preamble is the first thing in the TeX file.
304$webworkFiles{hardcopySnippets}{preamble} = "$webworkDirs{conf}/snippets/hardcopyPreamble.tex";
305
306# The setHeader preceeds each set. It is a PG file.
307$webworkFiles{hardcopySnippets}{setHeader} = "$webworkDirs{conf}/snippets/setHeader.pg"; # hardcopySetHeader.pg",
308
309# The problem divider goes between problems.
310$webworkFiles{hardcopySnippets}{problemDivider} = "$webworkDirs{conf}/snippets/hardcopyProblemDivider.tex";
311
312# The set footer goes after each set. Is is a PG file.
313$webworkFiles{hardcopySnippets}{setFooter} = "$webworkDirs{conf}/snippets/hardcopySetFooter.pg";
314
315# The set divider goes between sets (in multiset output).
316$webworkFiles{hardcopySnippets}{setDivider} = "$webworkDirs{conf}/snippets/hardcopySetDivider.tex";
317
318# The user divider does between users (in multiuser output).
319$webworkFiles{hardcopySnippets}{userDivider} = "$webworkDirs{conf}/snippets/hardcopyUserDivider.tex";
320
321# The postabmle is the last thing in the TeX file.
322$webworkFiles{hardcopySnippets}{postamble} = "$webworkDirs{conf}/snippets/hardcopyPostamble.tex";
323
324##### Screen snippets are used when displaying problem sets on the screen.
325
326# The set header is displayed on the problem set page. It is a PG file.
327$webworkFiles{screenSnippets}{setHeader} = "$webworkDirs{conf}/snippets/setHeader.pg"; # screenSetHeader.pg"
328
329# A PG template for creation of new problems.
330$webworkFiles{screenSnippets}{blankProblem} = "$webworkDirs{conf}/snippets/blankProblem.pg"; # screenSetHeader.pg"
331
332# A site info "message of the day" file
333$webworkFiles{site_info} = "$webworkDirs{htdocs}/site_info.txt";
334
335################################################################################
336# Course-specific files
337################################################################################
338
339# The course configuration file.
340$courseFiles{environment} = "$courseDirs{root}/course.conf";
341
342# The course simple configuration file (holds web-based configuratoin).
343$courseFiles{simpleConfig} = "$courseDirs{root}/simple.conf";
344
345# File contents are displayed after login, on the problem sets page. Path given
346# here is relative to the templates directory.
347$courseFiles{course_info} = "course_info.txt";
348
349# File contents are displayed on the login page. Path given here is relative to
350# the templates directory.
351$courseFiles{login_info} = "login_info.txt";
352
353# Additional library buttons can be added to the Library Browser (SetMaker.pm)
354# by adding the libraries you want to the following line. For each key=>value
355# in the list, if a directory (or link to a directory) with name 'key' appears
356# in the templates directory, then a button with name 'value' will be placed at
357# the top of the problem browser. (No button will appear if there is no
358# directory or link with the given name in the templates directory.) For
359# example,
360#
361# $courseFiles{problibs} = {rochester => "Rochester", asu => "ASU"};
362#
363# would add two buttons, one for the Rochester library and one for the ASU
364# library, provided templates/rochester and templates/asu exists either as
365# subdirectories or links to other directories.
366#
367$courseFiles{problibs} = {
368# rochesterLibrary => "Rochester",
369# asuLibrary => "Arizona State",
370# dcdsLibrary => "Detroit CDS",
371# dartmouthLibrary => "Dartmouth",
372# indianaLibrary => "Indiana",
373# osuLibrary => "Ohio State",
374# capaLibrary => "CAPA",
375};
376
377################################################################################
378# Status system
379################################################################################
380
381# This is the default status given to new students and students with invalid
382# or missing statuses.
383$default_status = "Enrolled";
384
385# The first abbreviation in the abbreviations list is the canonical
386# abbreviation, and will be used when setting the status value in a user record
387# or an exported classlist file.
388#
389# Results are undefined if more than one status has the same abbreviation.
390#
391# The four behaviors that are controlled by status are:
392# allow_course_access => is this user allowed to log in?
393# include_in_assignment => is this user included when assigning as set to "all" users?
394# include_in_stats => is this user included in statistical reports?
395# include_in_email => is this user included in emails sent to the class?
396# include_in_scoring => is this user included in score reports?
397
398%statuses = (
399 Enrolled => {
400 abbrevs => [qw/ C c current enrolled /],
401 behaviors => [qw/ allow_course_access include_in_assignment include_in_stats include_in_email include_in_scoring /],
402 },
403 Audit => {
404 abbrevs => [qw/ A a audit /],
405 behaviors => [qw/ allow_course_access include_in_assignment include_in_stats include_in_email /],
406 },
407 Drop => {
408 abbrevs => [qw/ D d drop withdraw /],
409 behaviors => [qw/ /],
410 },
47); 411);
48 412
49%webworkFiles = (
50 environment => "$webworkDirs{conf}/global.conf",
51 hardcopySnippets => {
52 preamble => "$webworkDirs{conf}/snippets/hardcopyPreamble.tex",
53 setHeader => "$webworkDirs{conf}/snippets/hardcopySetHeader.pg",
54 problemDivider => "$webworkDirs{conf}/snippets/hardcopyProblemDivider.tex",
55 setFooter => "$webworkDirs{conf}/snippets/hardcopySetFooter.pg",
56 setDivider => "$webworkDirs{conf}/snippets/hardcopySetDivider.tex",
57 userDivider => "$webworkDirs{conf}/snippets/hardcopyUserDivider.tex",
58 postamble => "$webworkDirs{conf}/snippets/hardcopyPostamble.tex",
59 },
60 screenSnippets => {
61 setHeader => "$webworkDirs{conf}/snippets/setHeader.pg",
62 },
63 logs => {
64 timing => "$webworkDirs{logs}/timing.log",
65 },
66 equationCacheDB => "$webworkDirs{DATA}/equationcache",
67);
68
69%webworkURLs = (
70 root => "$webworkURLRoot",
71 home => "/webwork2_files/index.html",
72 htdocs => "/webwork2_files",
73 htdocs_temp => "/webwork2_files/tmp",
74 equationCache => "/webwork2_files/tmp/equations",
75 docs => "http://webhost.math.rochester.edu/webworkdocs/docs",
76 oldProf => "/webwork-old/profLogin.pl",
77);
78
79################################################################################
80# Default course-specific settings
81################################################################################
82
83my $courseRoot = "$webworkDirs{courses}/$courseName";
84%courseDirs = (
85 root => "$courseRoot",
86 DATA => "$courseRoot/DATA",
87 auth_DATA => "$courseRoot/DATA/.auth",
88 html => "$courseRoot/html",
89 html_images => "$courseRoot/html/images",
90 html_temp => "$courseRoot/html/tmp",
91 logs => "$courseRoot/logs",
92 scoring => "$courseRoot/scoring",
93 templates => "$courseRoot/templates",
94 macros => "$courseRoot/templates/macros",
95 email => "$courseRoot/templates/email",
96);
97
98%courseFiles = (
99 environment => "$courseDirs{root}/course.conf",
100 motd => "$courseDirs{root}/motd.txt",
101 logs => {
102 answer_log => "$courseDirs{logs}/answer_log",
103 },
104 course_info => "$courseDirs{root}/course_info.txt",
105 login_info => "$courseDirs{root}/login_info.txt",
106);
107
108# quick hack to fix transaction logging. blah.
109$webworkFiles{logs}->{transaction} = "$courseDirs{logs}/transaction.log";
110$webworkFiles{logs}->{pastAnswerList} = "$courseDirs{logs}/past_answers.log";
111
112my $courseURLRoot = "$webworkURLs{htdocs}/courses/$courseName";
113%courseURLs = (
114 root => "$courseURLRoot",
115 html => "$courseURLRoot",
116 html_temp => "$courseURLRoot/tmp",
117);
118
119################################################################################
120# Other site-specific options
121################################################################################
122
123%mail = (
124 smtpServer => "mail.math.rochester.edu",
125 smtpSender => "webwork\@math.rochester.edu",
126 # allowedRecipients defines addresses that the PG system is allowed to
127 # send mail to. this prevents subtle PG exploits. This should be set
128 # in course.conf to the addresses of professors of each course. Sending
129 # mail from the PG system (i.e. questionaires, essay questions) will
130 # fail if this is not set somewhere (either here or in course.conf).
131 #allowedRecipients => [
132 # "yourname\@host.yourdomain.edu",
133 #],
134 # if defined, feedbackRecipients overrides the list of recipients for
135 # feedback email. It's appropriate to set this in the course.conf for
136 # specific courses, but probably not in global.conf. if not defined,
137 # mail is sent to all professors and TAs for a given course
138 #feedbackRecipients => [
139 # "prof1\@host.yourdomain.edu",
140 # "prof2\@host.yourdomain.edu",
141 #],
142 # feedbackVerbosity:
143 # 0: send only the feedback comment and context link
144 # 1: as in 0, plus user, set, problem, and PG data
145 # 2: as in 1, plus the problem environment (debugging data)
146 feedbackVerbosity => 1,
147 editor_window_rows => 15,
148 editor_window_columns => 100,
149);
150
151%externalPrograms = (
152 mkdir => "/bin/mkdir",
153 tth => "/usr/local/bin/tth",
154 pdflatex => "/usr/local/bin/pdflatex",
155 latex => "/usr/local/bin/latex",
156 #dvipng => "/usr/local/bin/dvipng -mode ljfivemp -D600 -Q6 -x1000.5 -bgTransparent",
157 dvipng => "/usr/local/bin/dvipng",
158 gif2eps => "$webworkDirs{bin}/gif2eps",
159 png2eps => "$webworkDirs{bin}/png2eps",
160 gif2png => "$webworkDirs{bin}/gif2png",
161);
162
163################################################################################
164# Frontend options
165################################################################################
166
167%templates = (
168 system => "$webworkDirs{conf}/templates/ur.template",
169);
170
171################################################################################ 413################################################################################
172# Database options 414# Database options
173################################################################################ 415################################################################################
416
417# these variables are used by database.conf. we define them here so that editing
418# database.conf isn't necessary.
419$database_dsn = "dbi:mysql:webwork";
420$database_username = "webworkWrite";
421$database_password = "";
422$database_debug = 0;
423
424# Variables for sql_moodle database layout.
425$moodle_dsn = "dbi:mysql:moodle";
426$moodle_username = $database_username;
427$moodle_password = $database_password;
428$moodle_table_prefix = "mdl_";
429$moodle17 = 0;
174 430
175# Several database are defined in the file conf/database.conf and stored in the 431# Several database are defined in the file conf/database.conf and stored in the
176# hash %dbLayouts. 432# hash %dbLayouts.
177include "conf/database.conf"; 433include "conf/database.conf";
178 434
179# Select the default database layout. This can be overridden in the course.conf 435# Select the default database layout. This can be overridden in the course.conf
180# file of a particular course. 436# file of a particular course. The only database layout supported in WW 2.1.4
181*dbLayout = $dbLayouts{sql}; 437# and up is "sql_single".
438$dbLayoutName = "sql_single";
439
440# This sets the symbol "dbLayout" as an alias for the selected database layout.
441*dbLayout = $dbLayouts{$dbLayoutName};
442
443################################################################################
444# Problem library options
445################################################################################
446
447# For configuration instructions, see:
448# http://devel.webwork.rochester.edu/twiki/bin/view/Webwork/DatabaseProblemLibrary
449
450# The directory containing the problem library files. Set to "" if no problem
451# library is installed.
452$problemLibrary{root} = "";
453
454# Problem Library version
455# Version 1 is in use. Version 2 will be released soon.
456$problemLibrary{version} = "2";
457
458# The name of the SQL database containing problem metadata
459$problemLibrary{sourceSQL} = "ProblemLibrary";
460
461# The user name to use when connecting to the problem library database
462$problemLibrary{userSQL} = $database_username;
463
464# The password to use when connecting to the problem library database
465$problemLibrary{passwordSQL} = $database_password;
466
467################################################################################
468# Logs
469################################################################################
470
471# FIXME: take logs out of %webworkFiles/%courseFiles and give them their own
472# top-level hash.
473
474# Logs data about how long it takes to process problems. (Do not confuse this
475# with the /other/ timing log which can be set by WeBWorK::Timing and is used
476# for benchmarking system performance in general. At some point, this timing
477# mechanism will be deprecated in favor of the WeBWorK::Timing mechanism.)
478$webworkFiles{logs}{timing} = "$webworkDirs{logs}/timing.log";
479
480# Logs courses created via the web-based Course Administration module.
481$webworkFiles{logs}{hosted_courses} = "$webworkDirs{logs}/hosted_courses.log";
482
483# The transaction log contains data from each recorded answer submission. This
484# is useful if the database becomes corrupted.
485$webworkFiles{logs}{transaction} = "$courseDirs{logs}/transaction.log";
486
487# The answer log stores a history of all users' submitted answers.
488$courseFiles{logs}{answer_log} = "$courseDirs{logs}/answer_log";
489
490# Log logins.
491$courseFiles{logs}{login_log} = "$courseDirs{logs}/login.log";
492
493# Log for almost every click. By default it is the empty string, which
494# turns this log off. If you want it turned on, we suggest
495# "$courseDirs{logs}/activity.log"
496# When turned on, this log can get quite large.
497$courseFiles{logs}{activity_log} = '';
498
499################################################################################
500# Site defaults (FIXME: what other things could be "site defaults"?)
501################################################################################
502
503# Set the default timezone of courses on this server. To get a list of valid
504# timezones, run:
505#
506# perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::all_names'
507#
508# To get a list of valid timezone "links" (deprecated names), run:
509#
510# perl -MDateTime::TimeZone -e 'print join "\n", DateTime::TimeZone::links'
511#
512# If left blank, the system timezone will be used. This is usually what you
513# want. You might want to set this if your server is NOT in the same timezone as
514# your school. If just a few courses are in a different timezone, set this in
515# course.conf for the affected courses instead.
516#
517$siteDefaults{timezone} = "";
518
519# The default_templates_course is used by default to create a new course.
520# The contents of the templates directory are copied from this course
521# to the new course being created.
522$siteDefaults{default_templates_course} ="modelCourse";
523
524################################################################################
525# Theme
526################################################################################
527
528$defaultTheme = "math";
529$defaultThemeTemplate = "system";
530
531################################################################################
532# Authentication system
533################################################################################
534
535# FIXME This mechanism is a little awkward and probably should be merged with
536# the dblayout selection system somehow.
537
538# Select the authentication module to use for normal logins.
539#
540# If this value is a string, the given authentication module will be used
541# regardless of the database layout. If it is a hash, the database layout name
542# will be looked up in the hash and the resulting value will be used as the
543# authentication module. The special hash key "*" is used if no entry for the
544# current database layout is found.
545#
546$authen{user_module} = {
547 sql_moodle => "WeBWorK::Authen::Moodle",
548 "*" => "WeBWorK::Authen",
549};
550
551# Select the authentication module to use for proctor logins.
552#
553# A string or a hash is accepted, as above.
554#
555$authen{proctor_module} = "WeBWorK::Authen::Proctor";
556
557# Options for particular authentication modules
558
559$authen{moodle_options} = {
560 dsn => $moodle_dsn,
561 username => $moodle_username,
562 password => $moodle_password,
563 table_prefix => $moodle_table_prefix,
564 moodle17 => $moodle17,
565};
566
567$authen{ldap_options} = {
568 # hosts to attempt to connect to, in order. for example:
569 # auth.myschool.edu -- uses LDAP scheme and port 389
570 # ldap://auth.myschool.edu:666 -- non-standard port
571 # ldaps://auth.myschool.edu -- uses LDAPS scheme and port 636
572 # ldaps://auth.myschool.edu:389 -- SSL on non-SSL port
573 net_ldap_hosts => [
574 "ldaps://corona-dmc.its.rochester.edu",
575 "ldaps://corona-dmb.acs.rochester.edu",
576 ],
577 # connection options
578 net_ldap_options => {
579 timeout => 30,
580 version => 3,
581 },
582 # base to use when searching for user's DN
583 net_ldap_base => "ou=people,dc=rochester,dc=edu",
584 # If LDAP rejects password, check it against the WeBWorK password database
585 failover => 1,
586};
182 587
183################################################################################ 588################################################################################
184# Authorization system 589# Authorization system
185################################################################################ 590################################################################################
186 591
187# This lets you specify a minimum permission level needed to perform certain 592# this section lets you define which groups of users can perform which actions.
188# actions. In the current system, >=10 will allow a professor to perform the 593
189# action, >=5 will allow a TA to, and >=0 will allow a student to perform an 594# this hash maps a numeric permission level to the name of a role. the number
190# action (almost never what you want). 595# assigned to a role is significant -- roles with higher numbers are considered
191my $ta = 5; 596# "more privileged", and are included when that role is listed for a privilege
597# below.
598#
599%userRoles = (
600 guest => -5,
601 student => 0,
602 proctor => 2,
603 ta => 5,
192my $professor = 10; 604 professor => 10,
605);
606
607# this hash maps operations to the roles that are allowed to perform those
608# operations. the role listed and any role with a higher permission level (in
609# the %userRoles hash) will be allowed to perform the operation. If the role
610# is undefined, no users will be allowed to perform the operation.
611#
193%permissionLevels = ( 612%permissionLevels = (
613 login => "guest",
614 report_bugs => "student",
615 submit_feedback => "student",
616 change_password => "student",
617 change_email_address => "student",
618
619 proctor_quiz => "proctor",
620 view_proctored_tests => "ta",
621
622 view_multiple_sets => "ta",
623 view_unopened_sets => "ta",
624 view_unpublished_sets => "ta",
625 view_answers => "ta",
626
194 become_student => $professor, 627 become_student => "professor",
195 access_instructor_tools => $ta, 628 access_instructor_tools => "ta",
196 create_and_delete_problem_sets => $professor,
197 modify_problem_sets => $professor,
198 assign_problem_sets => $professor,
199 modify_student_data => $professor,
200 score_sets => $professor, 629 score_sets => "professor",
201 send_mail => $professor, 630 send_mail => "professor",
631 receive_feedback => "ta",
632
633 create_and_delete_problem_sets => "professor",
634 assign_problem_sets => "professor",
635 modify_problem_sets => "professor",
636 modify_student_data => "professor",
202 modify_classlist_files => $professor, 637 modify_classlist_files => "professor",
203 modify_set_def_files => $professor, 638 modify_set_def_files => "professor",
639 modify_scoring_files => "professor",
640 modify_problem_template_files => "professor",
641 manage_course_files => "professor",
642
643 create_and_delete_courses => "professor",
644 fix_course_databases => "professor",
645
646 ##### Behavior of the interactive problem processor #####
647
648 show_correct_answers_before_answer_date => "ta",
649 show_solutions_before_answer_date => "ta",
650 avoid_recording_answers => "ta",
651 # Below this level, old answers are never initially shown
652 can_show_old_answers_by_default => "student",
653 # at this level, we look at showOldAnswers for default value
654 # even after the due date
655 can_always_use_show_old_answers_default => "professor",
656 check_answers_before_open_date => "ta",
657 check_answers_after_open_date_with_attempts => "ta",
658 check_answers_after_open_date_without_attempts => "guest",
659 check_answers_after_due_date => "guest",
660 check_answers_after_answer_date => "guest",
661 record_answers_when_acting_as_student => undef,
662 # "record_answers_when_acting_as_student" takes precedence
663 # over the following for professors acting as students:
664 record_answers_before_open_date => undef,
665 record_answers_after_open_date_with_attempts => "student",
666 record_answers_after_open_date_without_attempts => undef,
667 record_answers_after_due_date => undef,
668 record_answers_after_answer_date => undef,
669 dont_log_past_answers => "professor",
670 # does the user get to see a dump of the problem?
671 view_problem_debugging_info => "ta",
672
673 ##### Behavior of the Hardcopy Processor #####
674
675 download_hardcopy_multiuser => "ta",
676 download_hardcopy_multiset => "ta",
677 download_hardcopy_format_pdf => "guest",
678 download_hardcopy_format_tex => "ta",
204); 679);
680
681# This is the default permission level given to new students and students with
682# invalid or missing permission levels.
683$default_permission_level = $userRoles{student};
205 684
206################################################################################ 685################################################################################
207# Session options 686# Session options
208################################################################################ 687################################################################################
209 688
210# $sessionKeyTimeout defines seconds of inactivity before a key expires 689# $sessionKeyTimeout defines seconds of inactivity before a key expires
211$sessionKeyTimeout = 60*30; 690$sessionKeyTimeout = 60*30;
212 691
213# $sessionKeyLength defines the length (in characters) of the session key 692# $sessionKeyLength defines the length (in characters) of the session key
214$sessionKeyLength = 40; 693$sessionKeyLength = 32;
215 694
216# @sessionKeyChars lists the legal session key characters 695# @sessionKeyChars lists the legal session key characters
217@sessionKeyChars = ('A'..'Z', 'a'..'z', '0'..'9', '.', '^', '/', '!', '*'); 696@sessionKeyChars = ('A'..'Z', 'a'..'z', '0'..'9');
218 697
219# Practice users are users who's names start with $practiceUser 698# Practice users are users who's names start with $practiceUser
220# (you can comment this out to remove practice user support) 699# (you can comment this out to remove practice user support)
221$practiceUserPrefix = "practice"; 700$practiceUserPrefix = "practice";
222 701
… …
224# commented out by default, though, so you don't hurt yourself. It is 703# commented out by default, though, so you don't hurt yourself. It is
225# kindof a backdoor to the practice user system, since he doesn't have a 704# kindof a backdoor to the practice user system, since he doesn't have a
226# password. Come to think of it, why do we even have this?! 705# password. Come to think of it, why do we even have this?!
227#$debugPracticeUser = "practice666"; 706#$debugPracticeUser = "practice666";
228 707
229################################################################################ 708# Option for gateway tests; $gatewayGracePeriod is the time in seconds
230# PG translation options 709# after the official due date during which we'll still grade the test
231################################################################################ 710$gatewayGracePeriod = 120;
232 711
233%pg = ( 712################################################################################
234 # options for various renderers 713# PG subsystem options
235 renderers => { 714################################################################################
236 "WeBWorK::PG::Remote" => { 715
716# List of enabled display modes. Comment out any modes you don't wish to make
717# available for use.
718$pg{displayModes} = [
719 "plainText", # display raw TeX for math expressions
720 "formattedText", # format math expressions using TtH
721 "images", # display math expressions as images generated by dvipng
722 "jsMath", # render TeX math expressions on the client side using jsMath
723 "asciimath", # render TeX math expressions on the client side using ASCIIMathML
724 "LaTeXMathML", # render TeX math expressions on the client side using LaTeXMathML
725];
726
727#### Default settings for the PG translator
728
729# Default display mode. Should be listed above.
730$pg{options}{displayMode} = "images";
731
732# The default grader to use, if a problem doesn't specify.
733$pg{options}{grader} = "avg_problem_grader";
734
735# Fill in answer blanks with the student's last answer by default?
736$pg{options}{showOldAnswers} = 1;
737
738# Show correct answers (when allowed) by default?
739$pg{options}{showCorrectAnswers} = 0;
740
741# Show hints (when allowed) by default?
742$pg{options}{showHints} = 0;
743
744# Show solutions (when allowed) by default?
745$pg{options}{showSolutions} = 0;
746
747# Catch translation warnings internally by default? (We no longer need to do
748# this, since there is a global warnings handler. So this should be off.)
749$pg{options}{catchWarnings} = 0;
750
751##### Currently-selected renderer
752
753# Only the local renderer is supported in this version.
754$pg{renderer} = "WeBWorK::PG::Local";
755
756# The remote renderer connects to an XML-RPC PG rendering server.
757#$pg{renderer} = "WeBWorK::PG::Remote";
758
759##### Renderer-dependent options
760
761# The remote renderer has one option:
762$pg{renderers}{"WeBWorK::PG::Remote"} = {
763 # The "proxy" server to connect to for remote rendering.
237 proxy => "http://localhost:21000/RenderD" 764 proxy => "http://localhost:21000/RenderD",
238 } 765};
766
767##### Settings for various display modes
768
769# "images" mode has several settings:
770$pg{displayModeOptions}{images} = {
771 # Determines the method used to align images in output. Can be
772 # "baseline", "absmiddle", or "mysql".
773 dvipng_align => 'mysql',
774
775 # If mysql is chosen, this information indicates which database contains the
776 # 'depths' table. Since 2.3.0, the depths table is kept in the main webwork
777 # database. (If you are upgrading from an earlier version of webwork, and
778 # used the mysql method in the past, you should move your existing 'depths'
779 # table to the main database.)
780 dvipng_depth_db => {
781 dbsource => $database_dsn,
782 user => $database_username,
783 passwd => $database_password,
239 }, 784 },
240 # currently selected renderer 785};
241 renderer => "WeBWorK::PG::Local", 786
242 #renderer => "WeBWorK::PG::Remote", 787$pg{displayModeOptions}{jsMath} = {
788 reportMissingFonts => 0, # set to 1 to allow the missing font message
789 missingFontMessage => undef, # set to an HTML string to replace the missing font message
790 noImageFonts => 0, # set to 1 if you didn't install the jsMath image fonts
791 processDoubleClicks => 1, # set to 0 to disable double-click on math to get TeX source
792};
793
243 # directories used by PG 794##### Directories used by PG
244 directories => { 795
245 # directories used only by PG 796# The root of the PG directory tree (from pg_root in Apache config).
246 lib => "$pgRoot/lib", 797$pg{directories}{root} = "$pg_dir";
247 macros => "$pgRoot/macros", 798$pg{directories}{lib} = "$pg{directories}{root}/lib";
248 }, 799$pg{directories}{macros} = "$pg{directories}{root}/macros";
249 options => { 800
250 # default translation options 801#
251 displayMode => "images", 802# The macro file search path. Each directory in this list is seached
252 showOldAnswers => 1, 803# (in this order) by loadMacros() when it looks for a .pl file.
253 showCorrectAnswers => 0, 804#
254 showHints => 0, 805$pg{directories}{macrosPath} = [
255 showSolutions => 0, 806 ".", # search the problem file's directory
256 catchWarnings => 0, # there's a global warning catcher now 807 $courseDirs{macros},
257 # default grader 808 $pg{directories}{macros},
258 grader => "avg_problem_grader", 809];
259 }, 810
260 # this will be customized in the course.conf file 811# The applet search path. If a full URL is given, it is used unmodified. If an
261 specialPGEnvironmentVars => { 812# absolute path is given, the URL of the local server is prepended to it.
262 PRINT_FILE_NAMES_FOR => [ qw(gage apizer voloshin lr003k professor) ], 813#
814# For example, if an item is "/math/applets",
815# and the local server is "https://math.yourschool.edu",
816# then the URL "https://math.yourschool.edu/math/applets" will be used.
817#
818$pg{directories}{appletPath} = [ # paths to search for applets (requires full url)
819 "$webworkURLs{htdocs}/applets",
820 "$courseURLs{html}/applets",
821];
822
823##### "Special" PG environment variables. (Stuff that doesn't fit in anywhere else.)
824
825# Users for whom to print the file name of the PG file being processed.
826$pg{specialPGEnvironmentVars}{PRINT_FILE_NAMES_FOR} = [ "professor", ];
827
828# Locations of CAPA resources. (Only necessary if you need to use converted CAPA
829# problems.)
263 CAPA_Tools => "$courseDirs{macros}/CAPA_Tools/", 830$pg{specialPGEnvironmentVars}{CAPA_Tools} = "$courseDirs{macros}/CAPA_Tools/",
264 CAPA_MCTools => "$courseDirs{macros}/CAPA_MCTools/", 831$pg{specialPGEnvironmentVars}{CAPA_MCTools} = "$courseDirs{macros}/CAPA_MCTools/",
265 CAPA_Graphics_URL => "$courseDirs{html}/CAPA_Graphics/",
266 CAPA_GraphicsDirectory => "$courseDirs{html}CAPA_Graphics/", 832$pg{specialPGEnvironmentVars}{CAPA_GraphicsDirectory} = "$courseDirs{html}/CAPA_Graphics/",
267 }, 833$pg{specialPGEnvironmentVars}{CAPA_Graphics_URL} = "$courseURLs{html}/CAPA_Graphics/",
268 # modules lists module names and the packages each contains 834
269 modules => [ 835# Size in pixels of dynamically-generated images, i.e. graphs.
836$pg{specialPGEnvironmentVars}{onTheFlyImageSize} = 400,
837
838# To disable the Parser-based versions of num_cmp and fun_cmp, and use the
839# original versions instead, set this value to 1.
840$pg{specialPGEnvironmentVars}{useOldAnswerMacros} = 0;
841
842# Strings to insert at the start and end of the body of a problem
843# (at beginproblem() and ENDDOCUMENT) in various modes. More display modes
844# can be added if different behaviours are desired (e.g., HTML_dpng,
845# HTML_asciimath, etc.). These parts are not used in the Library browser.
846
847$pg{specialPGEnvironmentVars}{problemPreamble} = { TeX => '', HTML=> '' };
848$pg{specialPGEnvironmentVars}{problemPostamble} = { TeX => '', HTML=>'' };
849
850# To have the problem body indented and boxed, uncomment:
851
852# $pg{specialPGEnvironmentVars}{problemPreamble}{HTML} = '<BLOCKQUOTE>
853# <TABLE BORDER=1 CELLSPACING=1 CELLPADDING=15 BGCOLOR=#E8E8E8><TR><TD>';
854# $pg{specialPGEnvironmentVars}{problemPostamble}{HTML} = '</TD></TR></TABLE>
855# </BLOCKQUOTE>';
856
857##### PG modules to load
858
859# The first item of each list is the module to load. The remaining items are
860# additional packages to import.
861
862${pg}{modules} = [
270 [qw(DynaLoader)], 863 [qw(DynaLoader)],
271 [qw(Exporter)], 864 [qw(Exporter)],
272 [qw(GD)], 865 [qw(GD)],
273 866
274 [qw(AlgParser AlgParserWithImplicitExpand Expr ExprWithImplicitExpand)], 867 [qw(AlgParser AlgParserWithImplicitExpand Expr ExprWithImplicitExpand utf8)],
275 [qw(AnswerHash AnswerEvaluator)], 868 [qw(AnswerHash AnswerEvaluator)],
276 [qw(WWPlot)], # required by Circle (and others) 869 [qw(WWPlot)], # required by Circle (and others)
277 [qw(Circle)], 870 [qw(Circle)],
278 [qw(Complex)], 871 [qw(Complex)],
279 [qw(Complex1)], 872 [qw(Complex1)],
280 [qw(Distributions)], 873 [qw(Distributions)],
281 [qw(Fraction)], 874 [qw(Fraction)],
282 [qw(Fun)], 875 [qw(Fun)],
283 [qw(Hermite)], 876 [qw(Hermite)],
284 [qw(Label)], 877 [qw(Label)],
285 [qw(List)], 878 [qw(List)],
286 [qw(Match)], 879 [qw(Match)],
287 [qw(MatrixReal1)], # required by Matrix 880 [qw(MatrixReal1)], # required by Matrix
288 [qw(Matrix)], 881 [qw(Matrix)],
289 [qw(Multiple)], 882 [qw(Multiple)],
290 [qw(PGrandom)], 883 [qw(PGrandom)],
291 [qw(Regression)], 884 [qw(Regression)],
292 [qw(Select)], 885 [qw(Select)],
293 [qw(Units)], 886 [qw(Units)],
294 [qw(VectorField)], 887 [qw(VectorField)],
295 ], 888 [qw(Parser Value)],
296 # defaults used by answer evaluators 889 [qw(Parser::Legacy)],
890];
891
892##### Answer evaluatior defaults
893
297 ansEvalDefaults => { 894$pg{ansEvalDefaults} = {
298 functAbsTolDefault => .001, 895 functAbsTolDefault => .001,
299 functLLimitDefault => .0000001, 896 functLLimitDefault => .0000001,
300 functMaxConstantOfIntegration => 1E8, 897 functMaxConstantOfIntegration => 1E8,
301 functNumOfPoints => 3, 898 functNumOfPoints => 3,
302 functRelPercentTolDefault => .1, 899 functRelPercentTolDefault => .1,
303 functULimitDefault => .9999999, 900 functULimitDefault => .9999999,
304 functVarDefault => "x", 901 functVarDefault => "x",
305 functZeroLevelDefault => 1E-14, 902 functZeroLevelDefault => 1E-14,
306 functZeroLevelTolDefault => 1E-12, 903 functZeroLevelTolDefault => 1E-12,
307 numAbsTolDefault => .001, 904 numAbsTolDefault => .001,
308 numFormatDefault => "", 905 numFormatDefault => "",
309 numRelPercentTolDefault => .1, 906 numRelPercentTolDefault => .1,
310 numZeroLevelDefault => 1E-14, 907 numZeroLevelDefault => 1E-14,
311 numZeroLevelTolDefault => 1E-12, 908 numZeroLevelTolDefault => 1E-12,
312 }, 909 useBaseTenLog => 0,
313); 910 defaultDisplayMatrixStyle => "[s]",
911};
912
913################################################################################
914# Compatibility
915################################################################################
916
917# Define the old names for the various "root" variables.
918$webworkRoot = $webworkDirs{root};
919$webworkURLRoot = $webworkURLs{root};
920$pgRoot = $pg{directories}{root};
Legend:
Removed from v.1696  
changed lines
  Added in v.4741
aubreyja at gmail dot com
 ViewVC Help
Powered by ViewVC 1.0.9