aboutsummaryrefslogtreecommitdiff
path: root/UPGRADE.txt
diff options
context:
space:
mode:
Diffstat (limited to 'UPGRADE.txt')
-rw-r--r--UPGRADE.txt83
1 files changed, 62 insertions, 21 deletions
diff --git a/UPGRADE.txt b/UPGRADE.txt
index 9ff961b8d..e9610fe39 100644
--- a/UPGRADE.txt
+++ b/UPGRADE.txt
@@ -1,30 +1,71 @@
+Elgg Upgrade Instructions
+=========================
-ELGG UPGRADE INSTRUCTIONS
+Note: Upgrades are one way--You cannot downgrade once you run the upgrade
+ script. Always back up your database, code, and data directory
+ before upgrading!
-1. Download the new version of Elgg from elgg.org or a mirror.
-2. Overwrite your existing Elgg files. Any modifications should
- have been written within plugins, so that they are not lost
- on overwriting. If this is not the case, take care to
- maintain your modifications, although Elgg is not guaranteed
- to work correctly in this instance.
+Upgrading from Elgg 1.7 to 1.8.
+----------------------------------------------------
-3. Visit http://your-elgg-site-URL/upgrade.php
+1. Back up your Elgg database, code, and data directory.
-4. If you haven't already done so, install your crontab (UNIX ONLY)
+2. Download the latest version of Elgg from http://elgg.org/.
- Cron is a UNIX command which allows programs to be run at set
- times of the day.
+3. Identify and save any changes to core files. Pay special attention to
+ the views and actions directories. You should put these changes in plugins
+ once you have installed Elgg 1.8.
- If you want to take advantage of some of the maintenance
- functions such as log rotation or garbage collection, you must
- install a cron tab to trigger these events.
+3. Delete the following directories in the Elgg root on your server:
+ * _css
+ * account
+ * actions
+ * admin
+ * dashboard
+ * entities
+ * friends
+ * search
+ * settings
+ * simplecache
+ * views
- We have provided an example crontab as /crontab.example. Edit this
- with a text editor to provide the details of your site, rename it
- to another filename (eg 'crontab.mine') and install it with the
- following command:
+4. Delete the following core plugins from the Elgg mod directory. Most of these
+ plugins are deprecated and no longer supported by Elgg's core developers.
+ Others have been significantly changed and need to be replaced by new versions.
+ If you modified these plugins, you will need to upgrade the plugin to work
+ in Elgg 1.8.
+ * captcha
+ * crontrigger
+ * default_widgets
+ * friends
+ * riverdashboard
+ * twitter_service
+ * profile
- crontab crontab.mine
-
- Substitute your filename for 'crontab.mine'. \ No newline at end of file
+5. Upload and overwrite your existing Elgg files with the Elgg 1.8 files.
+
+6. Copy htaccess_dist to .htaccess, replacing your existing version. Any
+ modifications to the original .htaccess should be moved to the new
+ .htaccess file.
+
+7. Visit http://your-elgg-site/upgrade.php
+
+
+Upgrading to the latest release
+-----------------------------------------
+
+1. Back up your Elgg database, code, and data directory.
+
+2. Download the latest version of Elgg from http://elgg.org/.
+
+3. Upload and overwrite your existing Elgg files. Any modifications should
+ have been written within plugins so that they are not lost. If this is
+ not the case, take care to maintain your modifications. If you have
+ modified core files, Elgg may not work correctly.
+
+4. Copy htaccess_dist to .htaccess, replacing your existing version. Any
+ modifications to the original .htaccess should be moved to the new
+ .htaccess file.
+
+5. Visit http://your-elgg-site/upgrade.php