Local GPM Installation Instructions

From TheGPMWiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
-
#Key
+
== Notes ==
-
##Text written in <tt>fixed-space font</tt> denote text you will type in, as written.
+
*The suggestions made below are a best-guess to get your local version of the GPM up and running.  Your specific computing environment may require different values than those listed; if you have difficulty getting everything installed, please contact your local technical support.
-
##Text written in '''bold''' are directory paths.
+
*The directions below assume the versions of Apache, Perl and MySQL to be used were extracted from the archive available on the [ftp://ftp.thegpm.org/ GPM FTP site].
-
#Prerequisites
+
*Text written in <tt>fixed-space font</tt> denote text to be typed.
-
##A fully patched 32-bit version of a Windows operating system.
+
*Text written in '''bold''' are directory paths.
-
##A hard drive with several gigabytes of free space.
+
 
-
##PLEASE NOTE:  The suggestions made below are a best-guess to get your local version of the GPM up and running.  Your specific computing environment may require different values than those listed; if you have difficulty getting everything installed, please contact your local technical support.
+
== Prequisites ==
-
#Download ftp://ftp.thegpm.org/projects/localgpm/gpm-software.zip  This is the directory structure, scripts and support files that will operate the local GPM version, as well as some tools to modify the scripts for your specific location.
+
*A fully patched 32-bit version of a Windows operating system.
-
#Download Apache HTTP Server, ActiveState Perl and MySQL Community Edition.
+
*A hard drive with several gigabytes of free space.
-
##Apache: http://httpd.apache.org/download.cgi
+
 
-
##ActiveState Perl: http://www.activestate.com/activeperl/downloads
+
== Obtaining Server Software ==
-
##MySQL: http://www.mysql.com/downloads/mirror.php?id=390181#mirrors
+
*Download ftp://ftp.thegpm.org/projects/localgpm/gpm-software.zip  This is the directory structure, scripts and support files that will operate the local GPM version, as well as some tools to modify the scripts for your specific location.
-
##Or, ftp://ftp.thegpm.org/projects/localgpm/apache-perl-mysql.zip This is a single archive file which contains Apache HTTP Server 2.2.15, ActiveState Perl 5.10.1.1007 and MySQL Server 5.1.48.  After downloading, extract the three setup files to a temporary location; you will not need them after installation is complete.
+
*Download Apache HTTP Server, ActiveState Perl and MySQL Community Edition.
-
#Extract the contents of gpm-software.zip to the location you have chosen.  E.g., if the '''E:''' drive on your computer has the free space an installation will require, extract gpm-software.zip to '''E:\'''.
+
**Apache: http://httpd.apache.org/download.cgi
-
#Install Apache, Perl and MySQL, following the directions provided in the installation processThese directions assume that the versions of Apache, Perl and MySQL to be used were extracted from the archive available on the GPM FTP site.
+
**ActiveState Perl: http://www.activestate.com/activeperl/downloads
-
##Apache (called '''httpd-2.2.15-win32-x86-openssl-0.9.8m-r2.msi''')
+
**MySQL: http://www.mysql.com/downloads/mirror.php?id=390181#mirrors
-
###"Network domain" value should be the same as the end of the target computer's DNS name; e.g., if the target computer has a DNS entry of "science14.med.university.edu", enter "med.university.edu".  If you need assistance with this step, contact your local support.
+
**Or, ftp://ftp.thegpm.org/projects/localgpm/apache-perl-mysql.zip This is a single archive file which contains Apache HTTP Server 2.2.15, ActiveState Perl 5.10.1.1007 and MySQL Server 5.1.48.  After downloading, extract the three setup files to a temporary location; you will not need them after installation is complete.
-
###"Server name" value should match the full DNS name of the target computer.  E.g., if the computer onto which the local version of the GPM is being installed has a DNS name of "web3.university.edu", enter "web3.university.edu".  If you need assistance with this step, contact your local support.
+
 
-
###"Administrator's email address" is the email displayed if the web server encounters problems displaying pages.
+
== Software Installation ==
-
###Choose between having Apache run as a service (will be available whenever the computer is on; recommended), or being manually started and stopped.
+
*Extract the contents of gpm-software.zip to the location you have chosen.  E.g., if the '''E:''' drive on your computer has the free space an installation will require, extract gpm-software.zip to '''E:\'''.  This will create the necessary directory structure and place the scripts required to display information.
-
###Use a "Typical" installation.
+
=== Apache ===
-
###Let installation complete.
+
#Locate and start the installer, called '''httpd-2.2.15-win32-x86-openssl-0.9.8m-r2.msi''')
-
###Navigate to the Apache installation directory ('''C:\Program Files\Apache Software Foundation\Apache2.2''' by default).  Go into the '''conf''' directory.  Make a backup copy of httpd.conf.
+
#"Network domain" value should be the same as the end of the target computer's DNS name; e.g., if the target computer has a DNS entry of "science14.med.university.edu", enter "med.university.edu".  If you need assistance with this step, contact your local support.
-
###Edit httpd.conf as follows:
+
#"Server name" value should match the full DNS name of the target computer.  E.g., if the computer onto which the local version of the GPM is being installed has a DNS name of "web3.university.edu", enter "web3.university.edu".  If you need assistance with this step, contact your local support.
-
####The DocumentRoot value is based off wherever you extracted gpm-software.zip. Do a search and replace on everything between the quotes and substitute '''"<base_path>/thegpm"''', where '''<base_path>''' stands for the path in which you extracted gpm-software.zip.  E.g., if you installed to '''E:\''', write '''"E:/thegpm"'''; if you installed to '''"D:/websites/"''', write '''"D:/websites/thegpm"'''.
+
#"Administrator's email address" is the email displayed if the web server encounters problems displaying pages.
-
####A few lines below the DocumentRoot entry is a line that begins '''<Directory "<drive_letter>:/path">'''  There is a note above it regarding changing that value to match the DocumentRoot path.  Do so.
+
#Choose between having Apache run as a service (will be available whenever the computer is on; recommended), or being manually started and stopped.
-
####In the section marked "<IfModule alias_module>", modify the ScriptAlias value, based off wherever you extracted gpm-software.zip. Make the line read: <tt>ScriptAlias /thegpm-cgi/ "<base_path>/thegpm/thegpm-cgi/"</tt>, where '''<base_path>''' stands for the path in which you extracted gpm-software.zip.  E.g., if you installed to ''''E:\''', write '''"E:/thegpm/thegpm-cgi/"'''; if you installed to '''"D:/websites/"''', write '''"D:/websites/thegpm/thegpm-cgi/"'''.
+
#Use a "Typical" installation.
-
###Save the changes and restart the Apache server.  If it fails to start, use the command-line Apache tool: "<tt>apachectl configtest</tt>" in the '''/bin/''' folder of the Apache install directory.
+
#Let installation complete.
-
##Perl (called '''ActivePerl-5.10.1.1007-MSWin32-x86-291969.msi''')
+
=== Perl ===
-
###choose a "typical" install using the recommended settings.
+
#Locate the installer called '''ActivePerl-5.10.1.1007-MSWin32-x86-291969.msi''')
-
###navigate to the Perl '''\bin\''' directory (by default, this is '''c:\perl\bin\''').
+
#Choose a "typical" install using the recommended settings.
-
###run the command <tt>ppm</tt>.  This will start the Perl Package Manager.
+
=== MySQL ===
-
###display all packages.
+
#Choose a "Typical" install.
-
###in the search box, type <tt>dbd-mysql</tt>.  Choose the resulting package, and install it.
+
#Choose "Configure the MySQL Server now".
-
##MySQL (called '''mysql-essential-5.1.48-win32.msi''')
+
##Choose "Detailed Configuration".
-
###Choose a "Typical" install.
+
##Choose "Server Machine".
-
###Choose "Configure the MySQL Server now".
+
##Choose "Non-transactional Database".
-
####Choose "Detailed Configuration".
+
##Choose "Decision Support (DSS)/OLAP".
-
####Choose "Server Machine".
+
##Choose "Include Bin Directory in Windows PATH".
-
####Choose "Non-transactional Database".
+
##Enter a root password.  Remember this password, as it will be needed later.  Complete the configuration.
-
####Choose "Decision Support (DSS)/OLAP".
+
 
-
####Choose "Include Bin Directory in Windows PATH".
+
== Software Configuration ==
-
####Enter a root password.  Remember this password, as it will be needed later.  Complete the configuration.
+
=== Apache ===
-
###Stop the MySQL service.  Go to the installation directory of MySQL.  Make a backup copy of the my.ini file.  Open the my.ini file and locate the <tt>datadir</tt> value.
+
#Navigate to the Apache installation directory ('''C:\Program Files\Apache Software Foundation\Apache2.2''' by default).  Go into the '''conf''' directory.  Make a backup copy of httpd.conf.
-
###Navigate to the default data directory specified in the <tt>datadir</tt> directory, and copy all contents of the default data folder (including all subfolders) to '''<base_path>/gpmdb/data/''', where '''<base_path>''' is where the gpm-software.zip archive was extracted. Update the <tt>datadir</tt> value in the my.ini file to read <tt>datadir="<base_path>/gpmdb/data/"</tt>, including the double quotes, where '''<base_path>''' is where the gpm-software.zip archive was extracted.
+
#Edit httpd.conf as follows:
-
###Save the file and restart the MySQL service.
+
##The DocumentRoot value is based off wherever you extracted gpm-software.zip. Do a search and replace on everything between the quotes and substitute '''"<base_path>/thegpm"''', where '''<base_path>''' stands for the path in which you extracted gpm-software.zip.  E.g., if you installed to '''E:\''', write '''"E:/thegpm"'''; if you installed to '''"D:/websites/"''', write '''"D:/websites/thegpm"'''.
 +
##A few lines below the DocumentRoot entry is a line that begins '''<Directory "<drive_letter>:/path">'''  There is a note above it regarding changing that value to match the DocumentRoot path.  Do so.
 +
##In the section marked "<IfModule alias_module>", modify the ScriptAlias value, based off wherever you extracted gpm-software.zip. Make the line read: <tt>ScriptAlias /thegpm-cgi/ "<base_path>/thegpm/thegpm-cgi/"</tt>, where '''<base_path>''' stands for the path in which you extracted gpm-software.zip.  E.g., if you installed to ''''E:\''', write '''"E:/thegpm/thegpm-cgi/"'''; if you installed to '''"D:/websites/"''', write '''"D:/websites/thegpm/thegpm-cgi/"'''.
 +
#Save the changes and restart the Apache server.  If it fails to start, use the command-line Apache tool: "<tt>apachectl configtest</tt>" in the '''/bin/''' folder of the Apache install directory.
 +
=== MySQL ===
 +
#Stop the MySQL service.  Go to the installation directory of MySQL.  Make a backup copy of the my.ini file.  Open the my.ini file and locate the <tt>datadir</tt> value.
 +
#Navigate to the default data directory specified in the <tt>datadir</tt> directory, and copy all contents of the default data folder (including all subfolders) to '''<base_path>/gpmdb/data/''', where '''<base_path>''' is where the gpm-software.zip archive was extracted.
 +
#Update the <tt>datadir</tt> value in the my.ini file to read <tt>datadir="<base_path>/gpmdb/data/"</tt>, including the double quotes, where '''<base_path>''' is where the gpm-software.zip archive was extracted.
 +
#Save the file and restart the MySQL service.
 +
=== Perl ===
 +
#Navigate to the Perl '''\bin\''' directory (by default, this is '''c:\perl\bin\''').
 +
#Run the command <tt>ppm</tt>.  This will start the Perl Package Manager.
 +
#Display all packages.
 +
#In the search box, type <tt>dbd-mysql</tt>.  Choose the resulting package, and install it.
 +
=== GPM Configuration ===
#Run the script to edit the path information for all the Perl scripts used.  Start a command-line window, and navigate to '''\thegpm\scripts\''' directory.  Run the script '''local_gpm_pathmod.pl''' by typing <tt>perl local_gpm_pathmod.pl <base_path>/thegpm/</tt> where <base_path> is the path to where the gpm-software.zip archive was extracted.  Ensure you use front slashes (/) instead of back slashes (\) when typing the path.  This will edit scripts in both '''\thegpm\scripts\''' and '''\thegpm\thegpm-cgi\'''.
#Run the script to edit the path information for all the Perl scripts used.  Start a command-line window, and navigate to '''\thegpm\scripts\''' directory.  Run the script '''local_gpm_pathmod.pl''' by typing <tt>perl local_gpm_pathmod.pl <base_path>/thegpm/</tt> where <base_path> is the path to where the gpm-software.zip archive was extracted.  Ensure you use front slashes (/) instead of back slashes (\) when typing the path.  This will edit scripts in both '''\thegpm\scripts\''' and '''\thegpm\thegpm-cgi\'''.
#In the '''\thegpm\thegpm-cgi\''' directory, edit the hurricane.cfg file.
#In the '''\thegpm\thegpm-cgi\''' directory, edit the hurricane.cfg file.

Revision as of 20:33, 29 June 2010

Contents

Notes

  • The suggestions made below are a best-guess to get your local version of the GPM up and running. Your specific computing environment may require different values than those listed; if you have difficulty getting everything installed, please contact your local technical support.
  • The directions below assume the versions of Apache, Perl and MySQL to be used were extracted from the archive available on the GPM FTP site.
  • Text written in fixed-space font denote text to be typed.
  • Text written in bold are directory paths.

Prequisites

  • A fully patched 32-bit version of a Windows operating system.
  • A hard drive with several gigabytes of free space.

Obtaining Server Software

Software Installation

  • Extract the contents of gpm-software.zip to the location you have chosen. E.g., if the E: drive on your computer has the free space an installation will require, extract gpm-software.zip to E:\. This will create the necessary directory structure and place the scripts required to display information.

Apache

  1. Locate and start the installer, called httpd-2.2.15-win32-x86-openssl-0.9.8m-r2.msi)
  2. "Network domain" value should be the same as the end of the target computer's DNS name; e.g., if the target computer has a DNS entry of "science14.med.university.edu", enter "med.university.edu". If you need assistance with this step, contact your local support.
  3. "Server name" value should match the full DNS name of the target computer. E.g., if the computer onto which the local version of the GPM is being installed has a DNS name of "web3.university.edu", enter "web3.university.edu". If you need assistance with this step, contact your local support.
  4. "Administrator's email address" is the email displayed if the web server encounters problems displaying pages.
  5. Choose between having Apache run as a service (will be available whenever the computer is on; recommended), or being manually started and stopped.
  6. Use a "Typical" installation.
  7. Let installation complete.

Perl

  1. Locate the installer called ActivePerl-5.10.1.1007-MSWin32-x86-291969.msi)
  2. Choose a "typical" install using the recommended settings.

MySQL

  1. Choose a "Typical" install.
  2. Choose "Configure the MySQL Server now".
    1. Choose "Detailed Configuration".
    2. Choose "Server Machine".
    3. Choose "Non-transactional Database".
    4. Choose "Decision Support (DSS)/OLAP".
    5. Choose "Include Bin Directory in Windows PATH".
    6. Enter a root password. Remember this password, as it will be needed later. Complete the configuration.

Software Configuration

Apache

  1. Navigate to the Apache installation directory (C:\Program Files\Apache Software Foundation\Apache2.2 by default). Go into the conf directory. Make a backup copy of httpd.conf.
  2. Edit httpd.conf as follows:
    1. The DocumentRoot value is based off wherever you extracted gpm-software.zip. Do a search and replace on everything between the quotes and substitute "<base_path>/thegpm", where <base_path> stands for the path in which you extracted gpm-software.zip. E.g., if you installed to E:\, write "E:/thegpm"; if you installed to "D:/websites/", write "D:/websites/thegpm".
    2. A few lines below the DocumentRoot entry is a line that begins <Directory "<drive_letter>:/path"> There is a note above it regarding changing that value to match the DocumentRoot path. Do so.
    3. In the section marked "<IfModule alias_module>", modify the ScriptAlias value, based off wherever you extracted gpm-software.zip. Make the line read: ScriptAlias /thegpm-cgi/ "<base_path>/thegpm/thegpm-cgi/", where <base_path> stands for the path in which you extracted gpm-software.zip. E.g., if you installed to 'E:\, write "E:/thegpm/thegpm-cgi/"; if you installed to "D:/websites/", write "D:/websites/thegpm/thegpm-cgi/".
  3. Save the changes and restart the Apache server. If it fails to start, use the command-line Apache tool: "apachectl configtest" in the /bin/ folder of the Apache install directory.

MySQL

  1. Stop the MySQL service. Go to the installation directory of MySQL. Make a backup copy of the my.ini file. Open the my.ini file and locate the datadir value.
  2. Navigate to the default data directory specified in the datadir directory, and copy all contents of the default data folder (including all subfolders) to <base_path>/gpmdb/data/, where <base_path> is where the gpm-software.zip archive was extracted.
  3. Update the datadir value in the my.ini file to read datadir="<base_path>/gpmdb/data/", including the double quotes, where <base_path> is where the gpm-software.zip archive was extracted.
  4. Save the file and restart the MySQL service.

Perl

  1. Navigate to the Perl \bin\ directory (by default, this is c:\perl\bin\).
  2. Run the command ppm. This will start the Perl Package Manager.
  3. Display all packages.
  4. In the search box, type dbd-mysql. Choose the resulting package, and install it.

GPM Configuration

  1. Run the script to edit the path information for all the Perl scripts used. Start a command-line window, and navigate to \thegpm\scripts\ directory. Run the script local_gpm_pathmod.pl by typing perl local_gpm_pathmod.pl <base_path>/thegpm/ where <base_path> is the path to where the gpm-software.zip archive was extracted. Ensure you use front slashes (/) instead of back slashes (\) when typing the path. This will edit scripts in both \thegpm\scripts\ and \thegpm\thegpm-cgi\.
  2. In the \thegpm\thegpm-cgi\ directory, edit the hurricane.cfg file.
    1. This needs details.
  3. Edit the \thegpm\thegpm-cgi\dbcommon.pl file. Define usernames and passwords for both the read-only database user and root-like user. NOTE: is is NOT recommended to use the root username and password you defined during MySQL setup in the dbcommon.pl file.
  4. Edit the \thegpm\thegpm-cgi\defines.pl file.
  5. Set up the MySQL table
    1. Log into MySQL as the root user you defined during its installation. Then, type: source <base_path>/thegpm/scripts/create_localgpm_databases_tables.sql;. This will create the GPMDB database and table structure that will be populated after data files are submitted to the identification software.
  6. Schedule the execution of the \thegpm\scripts\popGPMDB.pl script, which parses the XML files created by the search software and adds them to the database.
Personal tools