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

Legend:
Removed from v.2516  
changed lines
  Added in v.4923

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9