Upgrading from 4.0.x to 4.1.x

From PGVWiki
Jump to: navigation, search

This article deals with upgrading an installation of PhpGedView v4.0.x series to a v4.1.x and upgrading from 4.1.3 or 4.1.5 to 4.1.5 series release. If you wish to upgrade from PhpGedView v3.x, some additional tasks are required and are detailed in the Upgrading from 3.x to 4.x article.


Upgrading 4.1.3 or 4.1.4 to 4.1.5

While 4.1.6 is the newest version, there are a few patches that have been provided that make it really easy. Here's a few steps upgrading your version of 4.1.4 or 4.1.4 to 4.1.5. If you don't know what version you have, you can find it at the top of your ADMIN page.

Step 1: Backup! Just in case something happens. You want to be prepared to restore all your files. That means copy everything in your phpGedView directory (all files!) and backup your database.

Step 2: Find the right Upgrade Patch. It's likely you installed the ALL, and not the BASIC version of phpGedView if you're not sure which version. There should be 4 upgrade patches (i.e. Upgrade Patch (ALL) 4.1.3 to 4.1.5, Upgrade Patch (ALL) 4.1.4 to 4.1.5, Upgrade Patch (BASIC) 4.1.3 to 4.1.5, Upgrade Patch (BASIC) 4.1.4 to 4.1.5)

Step 3: Unzip your Upgrade Patch. And upload/ftp your files to the root directory where your phpGedView is installed. The files will overwrite the old version naturally. Go back to your Admin page, and you should see the new 4.1.5 version.

That's it!

You may need to clear the cache. This can be done from the "Customize this GEDCOM Welcome page" link on the welcome page. Click the Clear Cache button at the bottom. At this moment I don't know if there is a 4.1.5 to 4.1.6 upgrade. It seems there will be another release in early 2009. There is a long list of upgrades between these two versions, so it might be worth it to upgrade.

Note: There are no database changes - if there were, a major or minor version number change, e.g. from 4.1 to 4.2 or from 4 to 5.

Upgrading 4.1 to 4.1.x

Upgrading from 4.1 to 4.1.2 or any other 4.1.x version is not difficult, but a little more complicated than simply replacing the files on the server with the new files.

Here are the very simplified steps:

  1. To upgrade from 4.1 to 4.1.1 or any other 4.1.x version, simply replace the files on the server with the new files.
  2. Some of the internal structures have changed, so you should also delete your cache files. This can be done from the "Customize this GEDCOM Welcome page" link (on the welcome page) or by manually deleting the files from the "index" directory.

These instructions are for sites where no on-line edits have been made to the database or where on-line edits have been made and the database and the GEDCOM are synced. If you have not synced the database and GEDCOM files, export a copy of the database.

  1. Make a backup copy of your SQL database. You may have to enlist the help of your ISP for this.
  2. Make a backup copy of your index folder, media folder, and the "config.php" file.
  3. Using the "Download" feature in "Manage GEDCOMs and Edit privacy" menu, download a copy of your current GEDCOM to your PC. Do not remove custom tags and do not convert to ANSI. You can later use this copy to re-import our GEDCOM after the upgrade.
  4. If you have made changes to the language files (which should have been concentrated in the "languages/extra.xx.php" files), make a backup copy of these as well.
  5. Make a backup copy of any changes or additions to the themes.
  6. If you used Google Maps, open the Google Maps Configuration screen and save the "GoogleMap API key" using a text editor. You will need it to re-activate the Google Map module after the upgrade.
  7. If you have the room on your server, rename your existing installation and temporarily leave it in place. This will serve as an additional backup.
  8. Download a copy of the latest PhpGedView version (4.1.6 is the current release) and unpack it on your local PC.
  9. Copy all of the following original files/folders from the backups to your local PC, replacing those in the new download:
  • file "config.php"
  • directory "media"
  • directory "index" - NOTE: you may have moved this folder from its PhpGedView master folder into server file space that's not accessible from the Internet for security purposes. If so, simply delete the new index folder that came with the latest version of PhpGedView.
  • changes to the themes. Do NOT copy the entire backup of the "themes" directory, since new versions of PhpGedView may contain essential updates to the standard themes.
  • file "languages/extra.xx.php" - If you have created any language variations, add these files. Do NOT copy the entire backup of the "languages" directory.
  • If you do not plan on using all of the included modules, you may wish to delete any sub-directories for modules you do not wish to use. If you don't intend to use any of the modules, you can delete the entire "modules" directory prior to transferring your directory to your server.

These preparatory steps have left you with a complete copy (except the database) of your PhpGedView installation on your local PC. Follow these steps to install that copy on your server:

  1. Copy the entire contents of the new local PC PhpGedView directory to your server's PGV operating directory. If necessary, create that directory first.
  2. Be sure to set full read/write/modify permission (0777) on the "index" folder and all its contents.
  3. If you intend to use PGV to upload media files or to create thumbnails from media files that have been uploaded outside PGV, you must set full read/write/modify (0777) permission on the "media" folder, its contents, and all its sub-folders and their contents. Please see the article on the Media Firewall for instructions on how to relocate the Media folder to be outside the web-addressable space.
  4. If you need to reconfigure the entire PGV site or change any of the database connection information, you must set full read/write/modify (0777) permission on the file "config.php". After your configuration changes have been stored, you can set this file to read-only.
  5. Some of the internal structures have changed, so you must delete the Upcoming Events cache file. This file's name ends with "_upcoming.php" and is housed in your "index" folder.
  6. Via your web browser, navigate to your PhpGedView installation (localhost or internet domain or IP number) and log in as Administrator.
  7. Immediately re-import your GEDCOM (a fresh upload isn't necessary unless you modified the GEDCOM offline or did not use the sync function).
    • Let PGV make whatever corrections it deems necessary.
    • Be sure to let PGV erase existing database contents. PGV will only erase and repopulate the tables relevant to the GEDCOM.
    • PGV might change the structure of certain other tables, including Users, Favorites, News, and Blocks to suit the requirements of the new version, but the contents will remain intact.
  8. Re-activate the modules that you intend to use. For GoogleMaps, you need to paste the saved API key; see the documentation for other modules for instructions how to make them work.

Upgrading 4.0 to 4.1.x

Use the following steps to upgrade to v4.1. These steps assume that you are familiar with PhpGedView and have successfully installed it before.

  1. Upload the new 4.1 files to your server replacing the old files with the new files. Do not replace the config.php file or the index directory.
  2. In order to create the data required for the new version, you will have to re-import your GEDCOM.
  3. You can now use your upgraded site.
  4. If you are using a customized theme you will need to update your theme with new stylesheets and variables. An excellent tool that can help you to merge themes is the WinMerge project http://winmerge.sourceforge.net/
Note to SQLite users: Unfortunately SQLite does not support the ALTER TABLE
SQL command.  This means that we must first drop the tables and recreate
them.  It is highly recommended that you run the backup before upgrading.

Version 4.x no longer includes support for index files. If you do not have PHP 5 with built-in SQLite support or a database account then you should not upgrade to PhpGedView 4.x. Maintenance releases will continue for the 3.3.x version until PHP 4 is no longer supported.