[system] / trunk / webwork-modperl / conf / global.conf.dist Repository:
ViewVC logotype

Diff of /trunk/webwork-modperl/conf/global.conf.dist

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

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

Legend:
Removed from v.2724  
changed lines
  Added in v.4870

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9