Pre 1.5.2 Configuration

Prior to ATutor 1.5.2 all configurable settings are stored in ./include/config.inc.php.

  • DB_USER
    • Type: String
    • Default Value: None
    • Version: 1.0+
    • Description: The MySQL user name that will be used to connect to the ATutor database.
  • DB_PASSWORD
    • Type: String
    • Default Value: None
    • Version: 1.0+
    • Description: The MySQL user name password that will be used to connect to the ATutor database.
  • DB_HOST
    • Type: String
    • Default Value: localhost
    • Version: 1.0+
    • Description: The MySQL host name that will be used to connect to the ATutor database.
  • DB_PORT
    • Type: Integer
    • Default Value: 3306
    • Version: 1.2+
    • Description: The MySQL database port that will be used to make the connection.
  • DB_NAME
    • Type: String
    • Default Value: atutor
    • Version: 1.0+
    • Description: The MySQL database name that will be used to store the ATutor tables.
  • TABLE_PREFIX
    • Type: String
    • Default Value: AT_
    • Version: 1.3.1+
    • Description: The prefix to attach to the name of every ATutor table. Use the table prefix to avoid conflicts between table names when ATutor is installed into an existing database.
  • EMAIL
    • Type: String
    • Default Value: None
    • Version: 1.5
    • Description: The contact email address provided for help, and other notifications sent from the system.
  • EMAIL_NOTIFY
    • Type: Boolean
    • Default Value: TRUE
    • Version: 1.0+
    • Description: Do you (the admin) want to be emailed when users request upgrades to Instructor accounts.
  • ALLOW_INSTRUCTOR_REQUESTS
    • Type: Boolean
    • Default Value: TRUE
    • Version: 1.0+
    • Description: Allow regular users to request that their account be upgraded to instructor status.
  • AUTO_APPROVE_INSTRUCTORS
    • Type: Boolean
    • Default Value: FALSE
    • Version: 1.0+
    • Description: If ALLOW_INSTRUCTOR_REQUESTS is TRUE then you can have the requests approved instantly/automatically, otherwise each request will have to be approved manually by the admin.
  • ADMIN_EMAIL
    • Type: String
    • Default Value: None
    • Version: 1.0 to 1.4.3
    • Description: (Deprecated in 1.5)The email that will be used as the return email when needed and when instructor account requests are made.
  • ADMIN_USERNAME
    • Type: String
    • Default Value: None
    • Version: 1.3.1 to 1.4.3
    • Description: (Deprecated in 1.5) The username to the administration section.
  • ADMIN_PASSWORD
    • Type: String
    • Default Value: None
    • Version: 1.0+
    • Description: (Deprecated in 1.5) The password to the administration section.
  • $MaxFileSize
    • Type: Integer
    • Default Value: 1048576
    • Version: 1.1+
    • Description: Maximum allowable file size in Bytes to upload. This does not override the value set for upload_max_filesize in php.ini
  • $MaxCourseSize
    • Type: Integer
    • Default Value: 10485760
    • Version: 1.1+
    • Description: Total maximum allowable course size in Bytes. The total of all the uploaded files.
  • $MaxCourseFloat
    • Type: Integer
    • Default Value: 2097152
    • Version: 1.3+
    • Description: How much a course can be over its limit while still allowing the file or import to continue. Makes the actual course limit to be $MaxCourseSize + $MaxCourseFloat, but when $MaxCourseFloat is reached no more uploads will be allowed for that course.
  • $IllegalExtentions
    • Type: Array
    • Default Value: ('exe', 'asp', 'php', 'bat', 'cgi', 'pl', 'com', 'vbs', 'reg', 'pcd', 'pif', 'scr', 'bas', 'inf', 'vb', 'vbe', 'wsc', 'wsf', 'wsh')
    • Version: 1.1+
    • Description: Illegal file types, by extension. Any extensions to disallow for uploading. (Just the extention without the leading dot.)
  • SITE_NAME
    • Type: String
    • Default Value: Course Server
    • Version: 1.1+
    • Description: The name of your course server website.
  • HOME_URL
    • Type: String
    • Default Value: None
    • Version: 1.3.2+
    • Description: The URL back to your website. If the URL is empty then the "Home" link will not appear.
  • HEADER_IMAGE
    • Type: String
    • Default Value: images/pub_default.jpg
    • Version: 1.3.2 to 1.4.3
    • Description: (Deprecated in 1.5) The top left header image before loging in. Approximately w:230 x h:90.
  • HEADER_LOGO
    • Type: String
    • Default Value: images/at-logo.gif
    • Version: 1.3.2 to 1.4.3
    • Description: (Deprecated in 1.5) The top right header image before loging in.
  • DEFAULT_LANGUAGE
    • Type: String
    • Default Value: en
    • Version: 1.2+
    • Description: The default language to use if it can't be detected. Must be one that is available on the system. Value is the official ISO 639-1 language code. Begin with English (en), then modify when additional languages have been installed.
  • CACHE_DIR
    • Type: String
    • Default Value: /tmp/
    • Version: 1.2+
    • Description: Where the cache directory should be created. On a Windows machine the path should look like C:\Windows\temp\. If used on a Unix or Linux machines that support RAM partitions (such as /dev/shm/ on RedHat or mfs on FreeBSD) and you have a lot of RAM available it would be a good idea to use that partition. Path must end in a slash. The directory must already exist (create a writable directory if one does not exist). Make empty or comment out to disable cacheing.
  • BACKWARDS_COMPATIBILITY
    • Type: Boolean
    • Default Value: false
    • Version: 1.3 - 1.4.1
    • Description: (Deprecated in 1.4.2) If you are upgrading from a version less than 1.3 and have content originally created in 1.0 you may want to keep backwards compatibility on to keep the usage of CONTENT_DIR and paths relative to the base ATutor installation directory, which is no longer required in versions greater than 1.3. BACKWARDS_COMPATIBILITY is deprecated in versions greater than 1.4.1.
  • AVAILABLE_THEMES
    • Type: String
    • Default Value: default
    • Version: 1.4 to 1.4.3
    • Description: (Deprecated in 1.4.3) A comma separated list of themes directories. The default theme directory can be found in path_to_atutor/templates/themes. See the themes_readme.txt file in the themes directory for more information about creating and configuring themes.
  • AT_CONTENT_DIR
    • Type: String
    • Default Value: None
    • Version: 1.4.2+
    • Description: The full path to the content directory. Must not contain symbolic links or shortcuts.
  • MAIL_USE_SMTP
    • Type: Boolean
    • Default Value: None
    • Version: 1.4+
    • Description: Whether or not to use the default php.ini SMTP settings. If false then mail will try to be sent using sendmail.
  • AT_ENABLE_CATEGORY_THEMES
    • Type: Boolean
    • Default Value: false
    • Version: 1.4.2+
    • Description: Whether or not to enable theme specific categories and disable the personal theme preference.
  • AT_COURSE_BACKUPS
    • Type: Integer
    • Default Value: 5
    • Version: 1.4.3+
    • Description: How many backup files can be stored per course.
  • EMAIL_CONFIRMATION
    • Type: Boolean
    • Default Value: FALSE
    • Version: 1.5+
    • Description: Set to TRUE to require newly registered accounts to conifm their account via an email confirmation message sent to them, before they can login.
  • AT_SHOW_TEST_BOX
    • Type: Boolean
    • Default Value: true
    • Version: 1.4.3
    • Description: (Deprecated in 1.5)Whether or not to show the "Ongoing Tests" box on the home page.

ACollab Add-on Configuration

  • AC_PATH
    • Type: String
    • Default Value:None
    • Version: 1.4+
    • Description: The relative or absolute path to an ACollab installation that will run as an add-on for this installation of ATutor. Leave empty if ACollab is not installed, or is available as a standalone application only. Path must include the trailing slash.
  • AC_TABLE_PREFIX
    • Type: String
    • Default Value: None
    • Version: 1.4+
    • Description: The prefix that was attached to all ACollab tables at install time. The default prefix suggested during install is AC_. Leave empty if ACollab is not installed, or is available as a standalone application only.