remove old readme

[atutor.git] / docs / documentation / admin / new_installation.php

<?php require('../common/body_header.inc.php'); $lm = '$LastChangedDate$'; ?>

<h2>New Installation</h2>
        <p>Please review the <a href="requirements_recommendations.php">requirements</a> section <em>before</em> attempting to install ATutor. The latest version of ATutor can always be found on the <a href="http://atutor.ca/atutor/download.php" target="_new">atutor.ca downloads</a> page.</p>

        <h3>Windows Considerations</h3>
                <p>To extract the ATutor <kbd>.tar.gz</kbd> archive you will need an application like <a href="http://winzip.com" target="_new">WinZip</a> or <a href="http://rarlabs.com" target="_new">WinRar</a>.</p>
                
        <h3>Unix Considerations</h3>
                <p>To extract the ATutor <kbd>.tar.gz</kbd> archive, use the command <kbd>tar -zxvf ATutor-version_number.tar.gz</kbd>, which will create a directory called <kbd>ATutor</kbd> in your current working directory.</p>

                <p>Extracting the files on a Windows machine and then uploading them via <acronym title="File Transfer Protocol">FTP</acronym> is not recommended, as it may not preserve the case-sensitive file names.</p>

                <p>Installing on a Unix machine requires some knowledge of file and directory permissions. You will be required to create a content directory and set permissions for that directory and for the <kbd>include/config.inc.php</kbd> file, so that the web server can write to them. The installation will not be successful if the permissions are not correctly set on that file and directory.</p>

                <p>Changing Unix file permissions from the shell prompt: <kbd>chmod a+rw filename</kbd> or <kbd>chmod a+rwx directoryname</kbd>.</p>
                
                <p>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. In our case we need the <kbd>include/config.inc.php</kbd> to be Readable and Writeable by World, and the content directory to be Readable, Writeable, and Executable by World.</p>

        <h3>Installation Procedure</h3>
                <p>Extract the downloaded archive using the method specified for your system (either Windows or Unix). Open a web browser and enter the address to your new ATutor installation, <kbd>http://your_server.com/path_to_atutor/ATutor/</kbd>, then follow the step-by-step instructions:</p>

                <ol>
                        <li><strong>Terms of Use</strong><br />
                                The usage of ATutor is restricted by the <acronym title="Recursive acronym for GNU's Not Unix">GNU</acronym> General Public License (GPL). Your agreement with the GPL is required if you wish to use ATutor. See the <a href="http://atutor.ca/services/licensing.php" target="_new">Licensing section</a> for more details.</li>

                        <li><strong>Database</strong><br />
                                Enter the required details needed to connect to your MySQL database. The optional <em>Table Prefix</em> (e.g. "AT_") allows ATutor to share an existing database with other applications and tables. The ATutor installation script will attempt to create the database specified, if it does not already exist. This requires that your MySQL user account has permission to create databases and permission to create tables. If this step fails, contact your system administrator to have your MySQL account upgraded to allow creation of new databases, or ask your administrator to create the database for you.</li>

                        <li><strong>Accounts &amp; Preferences</strong><br />
                                The Super Administrator account is used for managing your ATutor installation. The Super Administrator can also create additional Administrators each with their own privileges and roles once ATutor is installed. The personal account can be used to enroll in or create courses.</li>

                        <li><strong>Content Directory</strong><br />
                                Create a content directory, preferably outside your web server's document directory for added security, and set permissions as described above. On a Unix machine you will need to manually change the permissions on the listed files and directories in this step. No action is usually required on a Windows server, though in some circumstances Windows users may need to adjust the properties of the specified files and directories to make them writable. Copy the path of the created directory into the text box provided. Ensure that there are no shortcuts or symbolic links in the path.</li>

                        <li><strong>Save configuration</strong><br />
                                Before reaching the final step the <kbd>include/config.inc.php</kbd> file needs to be writable, otherwise an error will appear. Follow the instructions on the screen if the file permissions need to be changed. If the file does not exist in the <kbd>include/</kbd> directory, then you will need to create an empty text file with the filename <kbd>config.inc.php</kbd>.</li>

                        <li><strong>Anonymous Usage Collection</strong><br />
                                To assist the development team in serving the ATutor community, you can anonymously submit basic system information to the atutor.ca server.</li>

                        <li><strong>Done!</strong><br />
                                ATutor installation has been successful and you may now log-in with your personal account or the administrator account created in Step 3.</li>
                </ol>

<?php require('../common/body_footer.inc.php'); ?>