New upgrading page (replaces the old UPGRADING.txt)
authormoodler <moodler>
Tue, 29 Oct 2002 03:47:43 +0000 (03:47 +0000)
committermoodler <moodler>
Tue, 29 Oct 2002 03:47:43 +0000 (03:47 +0000)
doc/contents.html
doc/upgrade.html [new file with mode: 0755]

index 11f67fa..52d9521 100755 (executable)
@@ -13,6 +13,7 @@
 <LI><A TARGET="main" HREF="features.html">Features</A> \r
 <LI><A TARGET="main" HREF="release.html">Latest release</A> \r
 <LI><A TARGET="main" HREF="install.html">Installation</A>\r
+<LI><A TARGET="main" HREF="upgrade.html">Upgrading</A>\r
 <LI><A TARGET="main" HREF="teacher.html">Teacher Manual</A> \r
 <LI><A TARGET="main" HREF="developer.html">Developer Manual</A> \r
 <LI><A TARGET="main" HREF="future.html">Future</A>\r
diff --git a/doc/upgrade.html b/doc/upgrade.html
new file mode 100755 (executable)
index 0000000..dd76309
--- /dev/null
@@ -0,0 +1,110 @@
+<HEAD>\r
+    <TITLE>Moodle Docs: Upgrading</TITLE>\r
+       <LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">\r
+</HEAD>\r
+\r
+<BODY BGCOLOR="#FFFFFF">\r
+<H2>Upgrading Moodle</H2>\r
+\r
+<p>Moodle is designed to upgrade cleanly from any earlier version to any later \r
+  version. </p>\r
+<p>When upgrading a Moodle installation you should follow these steps:</p>\r
+<h2>1. Backup important data</h2>\r
+<blockquote> \r
+  <p>Although it is not strictly necessary, it is always a good idea to make a \r
+    backup of any production system before a major upgrade, just in case you need \r
+    to revert back to the older version for some reason. In fact, it's a good \r
+    idea to automate your server to backup your Moodle installation daily, so \r
+    that you can skip this step.</p>\r
+  <p>There are three areas that need backing up:</p>\r
+  <blockquote> \r
+    <p><strong>1. The Moodle software directory itself</strong></p>\r
+    <blockquote> \r
+      <p>Make a separate copy of these files before the upgrade, so that you can \r
+        retrieve your config.php and any modules you have added like themes, languages \r
+        etc<strong><br>\r
+        </strong></p>\r
+    </blockquote>\r
+    <p><strong>2. Your data directory.</strong></p>\r
+    <blockquote> \r
+      <p>This is where uploaded content resides (such as course resources and \r
+        student assignments) so it is very important to have a backup of these \r
+        files anyway. Sometimes upgrades may move or rename directories within \r
+        your data directory.<strong><br>\r
+        </strong></p>\r
+    </blockquote>\r
+    <p><strong>3. Your database</strong></p>\r
+    <blockquote> \r
+      <p>Most Moodle upgrades will alter the database tables, adding or changing \r
+        fields. Each database has different ways to backup. One way of backing \r
+        up a MySQL database is to 'dump' it to a single SQL file. The following \r
+        example shows Unix commands to dump the database called &quot;moodle&quot;:</p>\r
+      <blockquote>\r
+        <p><font face="Courier New, Courier, mono">mysqldump moodle &gt; moodle-backup-2002-10-26.sql</font></p>\r
+      </blockquote>\r
+      <p>You can also use the &quot;Export&quot; feature in Moodle's &quot;Manage \r
+        Database&quot; web interface to do the same thing on all platforms.</p>\r
+    </blockquote>\r
+  </blockquote>\r
+</blockquote>\r
+<h2>&nbsp;</h2>\r
+<h2>2. Install the new Moodle software</h2>\r
+<blockquote> \r
+  <p><strong>Using a downloaded archive</strong></p>\r
+  <blockquote> \r
+    <p>Do not overwrite an old installation unless you know what you are doing \r
+      ... sometimes old files can cause problems in new installations. The best \r
+      way it to rename the current Moodle directory to something else, then unpack \r
+      the new Moodle archive into the old location.</p>\r
+    <blockquote> \r
+      <p><font face="Courier New, Courier, mono">mv moodle moodle.backup<br>\r
+        tar xvzf moodle-1.0.6.tgz</font></p>\r
+      </blockquote>\r
+    <p>Next, copy across your config.php and any other plugins such as custom \r
+      themes:</p>\r
+    <blockquote>\r
+      <p><font face="Courier New, Courier, mono">cp moodle.backup/config.php moodle<br>\r
+        cp -pr moodle.backup/theme/mytheme moodle/theme/mytheme</font></p>\r
+    </blockquote>\r
+  </blockquote>\r
+  <p><strong>Using CVS</strong></p>\r
+  <blockquote> \r
+    <p>If you are using CVS, just go into the Moodle root directory and update \r
+      to the new files:</p>\r
+    <blockquote> \r
+      <p><font face="Courier New, Courier, mono">cvs update -dP</font></p>\r
+    </blockquote>\r
+    <p>Make sure you use the &quot;d&quot; parameter to create new directories \r
+      if necessary, and the &quot;P&quot; parameter to prune empty directories.</p>\r
+    <p>If you have been editing Moodle files, watch the messages very closely \r
+      for possible conflicts. All your customised themes and non-standard plugins \r
+      will be untouched.</p>\r
+  </blockquote>\r
+  <p>&nbsp;</p>\r
+</blockquote>\r
+<h2>3. Finishing the upgrade</h2>\r
+<blockquote> \r
+  <p>The last step is to trigger the upgrade processes within Moodle.</p>\r
+  <p>To do this just visit <a target=_top href="../admin/index.php">the admin page of your \r
+    installation</a>.</p>\r
+  <blockquote> \r
+    <p><font face="Courier New, Courier, mono">http://example.com/moodle/admin</font></p>\r
+  </blockquote>\r
+  <p>It doesn't matter if you are logged in as admin or not.</p>\r
+  <p> Moodle will automatically detect the new version and perform all the database \r
+    or filesystem upgrades that are necessary. If there is anything it can't do \r
+    itself (very rare) then you will see messages telling you what you need to \r
+    do. </p>\r
+</blockquote>\r
+<p>&nbsp; </p>\r
+<p> Assuming all goes well (no error messages) then you can start using your new \r
+  version of Moodle and enjoy the new features!</p>\r
+<p>If you have trouble with the upgrade, visit <a target=_top href="http://moodle.com/">moodle.com</a> \r
+  and post on the <a target=_top href="http://moodle.com/mod/forum/view.php?id=28">Installation \r
+  Support Forum</a>.</p>\r
+<p>&nbsp;</p>\r
+<P>&nbsp;</P>\r
+<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="index.html" TARGET="_top">Moodle Documentation</A></FONT></P>\r
+<P ALIGN="CENTER"><FONT SIZE="1">Version: $Id$</FONT></P>\r
+\r
+</BODY>\r