ATutor 1.3.1-1.4.1 Installation

Looking for ATutor pre-1.3.1 or ATutor 1.4.2+ installation instructions?

The installation and upgrade processes are made up of six steps each. Each step must be completed successfully without any errors to be able to advance to the next. You will not be able to use ATutor if the last step is not reached successfully. Note that the usage of the terms directory on Unix and folder on Windows are interchangeable.

Before You Begin

Please review the requirements section before attempting to install ATutor.

Installing on a Unix machine requires knowledge and the ability to change file and directory permissions.

  • Changing Unix file permissions from shell prompt: chmod a+rwx filename or chmod a+rwx directoryname.
  • Changing Unix file permissions from an FTP client: Many FTP clients allow you to change a file's permissions. The option may be labled as "Unix Permissions", "CHMOD", or simply as "Properties" or "Attributes" and will display a window with Read, Write, and Execute checkboxes for Owner, Group, and World; checking the appropriate boxes will change that file's permissions.
  • Changing Windows file permissions: Right click on a file or folder, select Properties, then check or uncheck the Read-only box.

Fresh Installation

Download the latest version of ATutor and extract it into a web-enabled directory. On Windows you may use WinZip or WinRar, while on Unix you will have to use the command tar -zxvf ATutor-version_number.tar.gz. Once extracted, an ATutor directory will be created. Open a web browser and enter the address to your installation, http://your_server.com/path_to_atutor/ATutor/, then follow the step-by-step instructions.

The following six steps describe the installation process as they are presented:

  1. Terms of Use
    The usage of ATutor is restricted by the GNU General Public License (GPL). Your agreement with the GPL is required if you wish to use ATutor. See the Licensing section for more details including how to use ATutor without the GPL.
  2. Database
    ATutor requires a MySQL database to function. Enter the required details needed to connect to your database. The Table Prefix option allows ATutor to share an existing database with other applications and tables.
  3. Administrator Account & System Preferences
    The Administrator account is used for managing ATutor user accounts and courses. The System preferences affect hosted courses and the general operation of ATutor.
  4. Personal Account & Defaults
    The personal account can be used to enroll into or create courses, it does not have any special privileges. At this step you may also choose to create a personal instructor account along with the basic Welcome course.
  5. Directories
    ATutor requires certain permissions on some files and directories to be set correctly. On a Unix machine, you will have to manually change the permissions on the listed files and directories. Use one of the methods described above for changing file and directory permissions. No action will be required at this step on a Windows machine.
  6. Done!
    ATutor installation has been successfull and you may now log-in with your personal account created in Step 4, or the administrator account created in Step 3.

Upgrading an Existing Installation

Please note that Release Candidate (RC) and ATutor 1.0 upgrades are not supported using this method and that depending on the size of the old courses, some steps of the upgrade may require considerable time to complete (in particular steps 2 and 5).

It is recommended that you backup your old ATutor database, if possible.

Rename your old ATutor directory. Download the latest version of ATutor and extract it into the same directory that the old one is in. Example: If the old ATutor installation is in /htdocs/ATutor_old, then the new ATutor installation should be in /htdocs/ATutor, such that both installations are at the same directory level. On Windows you may use WinZip or WinRar, while on Unix you will have to use the command tar -zxvf ATutor-version_number.tar.gz. Once extracted, an ATutor directory will be created alongside your old ATutor directory. Open a web browser and enter the address to your installation, http://your_server.com/path_to_atutor/ATutor/, then follow the step-by-step instructions.

UTF-8 Conversion

Goes here...

The following 7 steps describe the upgrade process as they are presented:

  1. Locate Old Version
    Specify the directory name of the old ATutor installation you wish to upgrade. The new and old ATutor directories must be at the same level.
  2. UTF-8 Conversion (1.6+)
    You are strongly advised to backup you database before completing this step.
    If ATutor is being upgraded from a previous version that was not using UTF-8 language packs, options will be provided to convert the database to UTF-8 all-at-once, used for single lanugage ATutor installations, or to convert on a course-by-course basis, used if courses of different lanugages are present on the system. If the system is already setup with UTF-8, you'll skip this step. NOTE: This step can take a very long time for installations with many course
  3. Database
    The upgrade will use the old version's settings to connect to the database and then update the old database tables with any changes to bring it up to date with the new version. If any language packs have been previously installed, then you will be asked to continue, which will delete the old language or cancel the upgrade.
  4. Preferences
    In some cases, the newer version will introduce new configuration options and preferences that have to be set or confirmed.
  5. Directories
    ATutor requires certain permissions on some files and directories to be set correctly. On a Unix machine you will have to manually change the permissions on the listed files and directories. Use one of the methods described above for changing file and directory permissions. No action will be required at this step on a Windows machine.
  6. Content Files
    All the old course content files and chat messages will be copied over to the new installation. Depending on the size of your old installation, this process may take a few seconds to several minutes or more to complete.
  7. Done!
    ATutor upgrade has been successfull and you may now log-in with your personal account or your administrator account.