Windows Pachyderm Installation

From NMC Wiki

Jump to: navigation, search

Windows Pachyderm Installation

author: Craig Smith

updated: Rachel Smith (2 August 2007)

Instructions for Installing Pachyderm 2.0.x on Windows XP

These instructions assume very little knowledge of database administration, system administration, or Pachyderm. If everything goes right you will be able to follow these instructions and install Pachyderm, but troubleshooting is tricky because of the differences between machines. If you have trouble, please subscribe to the Pachyderm Developers' Email List and ask for help on the list.

  • To subscribe to the Pachyderm Developers' Email List, send a blank email to pachy-dev-subscribe@lists.cdl.edu.
  • If everything goes right, the process below takes about 3.5 hours.

1) System Requirements & Before You Begin

Pachyderm 2.0.x is known to work on Windows XP and Windows Server 2003 with .NET 2.0.

  • If the Microsoft .NET 2.0 framework is not installed, install it first.
  • Download it from Microsoft (www.microsoft.com/downloads -- you want option #3) (22.4 MB)
  • Install it according to the wizard using the defaults suggested.
  • You need to know the IP address of the machine you are installing Pachyderm on. Write it down somewhere.
    • You can find it out by opening a command prompt (Start Menu > All Programs > Accessories > Command Prompt) and typing: ipconfig
    • It will be four numbers separated by periods. Write down the whole chain (i.e. 123.45.678.910).

N.B. The following instructions assume a "clean" windows machine -- in particular one that does not have MySQL, Apache or Image Magick already installed. If you have these already installed they will be written over.

2) Assemble Files You Will Need

Download the following files and save them on your desktop:

  • Pachyderm file bundle -- this is a collection of files copied from an instance of Pachyderm known to work. It will be used to replace the files installed by the installer. (This is a temporary measure until the next installer is released.)
    • Save the .zip file on your desktop. Extract it to C:\Pachyderm051707 (make a folder on the C: at the top level called "Pachyderm051707")
      • This will help you find the files later in the process, AND
      • If you extract this to a folder on the desktop or anywhere else, the pathnames to some of the files inside it will be too long and will prevent it from working.
  • Pachyderm-2.0.2-windows-installer.exe -- this is the Pachyderm 2.0.2 installer.

3) Run the Pachyderm Installer.

  • Find Pachyderm-2.0.2-windows-installer.exe on your desktop and double-click it.
  • This will install Apache, Image Magick, MySQL and Pachyderm. If you have any of these already installed they will be written over.
  • When asked to sign up for a MySQL.com account, you can check the "skip it" box.
  • This installer will not configure Apache or MySQL, nor will it load a default database into MySQL.
  • If you did not install .NET 2.0 before doing this step, you will see an error message at the end of the installation. See Troubleshooting, below, for how to fix it.

3.5) Configure Windows Firewall.

This step is only required if you are using Windows Firewall.

  1. Confirm whether you are using Windows Firewall.
    • Go to Start Menu > Control Panels > Windows Firewall.
    • If Windows Firewall is OFF, skip to Step 4) Configure MySQL.
  2. If Windows Firewall is ON:
    • Make sure "Don't Allow Exceptions" is NOT checked. If it is checked, uncheck it.
    • Click the "Exceptions" tab and set up the following 3 exceptions by clicking "Add Port":
      1. Name: MySQL -- Port: 3306 -- TCP
      2. Name: Apache -- Port: 80 -- TCP
      3. Name: Pachyderm -- Port: 8000 -- TCP
    • Click OK and close the Windows Firewall Control Panel.

4) Configure MySQL.

  1. Install MySQL Admin Tools.
    • Go to Start Menu > All Programs > MySQL > MySQL Server 5.0 > MySQL Server Instance Configuration Wizard (launch the wizard by clicking it in the menu)
    • If you are not a database administrator, use the following options on the wizard screens (click Next after choosing each option or set of options):
      • Select Detailed Configuration
      • Select Developer Machine (this will allow you to run other programs on your computer; if you are setting up a dedicated Pachyderm server, choose Server, but you need to know about database administration if you pick this option)
      • Select Multifunctional Database
      • Leave the next options as-is
      • Select Decision Support
      • Port number should be 3306; leave both options checked
      • Select Standard Character Set
      • Install as a Windows Service; Service name is MySQL; launch automatically; Include Bin Directory in Windows Path
      • Password: pach=derm -- don't enable root access from remote machines; don't create anonymous accounts
      • MAKE SURE YOUR VIRUS PROTECTION IS DISABLED and click the "Execute" button.
        • If you do not disable your virus protection, this step will fail.
  2. Install the GUI (graphical user interface/user-friendly) tool for administering MySQL.
    • Look in the downloaded File Bundle (C:\Pachyderm051707) folder for mysql-gui-tools-5.0-r10-win32.msi
    • Run the .msi file by double-clicking it.
    • The defaults are fine; step through the installation until it completes.
    • This will allow you to modify values in Pachyderm that you need to set to make it run later on, without having to enter MySQL commands at the command line.
  3. Run the GUI tool to set up MySQL.
    • Go to Start Menu > All Programs > MySQL > MySQL Administrator (launch it by clicking it in the menu)
    • Use the following values:
      • Stored Connection: (leave blank)
      • Server Host: localhost Port: 3306
      • Username: root
      • Password: pach=derm
    • Click OK.
    • A window will open. It should say: MySQL server is running. Leave this window open and proceed to step 4.
    • This starts MySQL and sets it up for the next steps.
  4. Set up Pachyderm as a user for the database.
    • Click User Administration in the menu on the left.
    • Click the "Add New User" button at the bottom. This will open the fields for you to edit them.
      • MySQL User: pachyderm
      • Password: pach=derm
    • Click "Apply Changes" at the bottom.
    • Close the window to quit the GUI tool.
    • This establishes Pachyderm as a user for the database you will set up in step 5.
  5. Create a database ("schema") for Pachyderm to use.
    • Go to Start Menu > All Programs > MySQL > MySQL Query Browser
    • Settings: localhost root 3306 password: pach=derm
    • Click OK. If you see a warning that there is no schema, Check "Don't Show Again," then click OK on the warning and again on the dialog box.
    • In the new window that opens, right click in a blank spot in the Schemata panel on the right.
      • Select "Create new schema"
      • Name: Pachyderm
      • Click OK
  6. Set user permissions for the user you created in step 4.
    • Go to Start Menu > All Programs > MySQL > MySQL Administrator (launch it by clicking it in the menu)
    • Click "Pachyderm" in the Users list on the left.
    • Click "Schema Privileges" tab at the top.
    • Click "Pachyderm" in Schemata list.
    • You will see a large list of available privileges. Click the "<<" button to move them all over into "assigned privileges" for the user Pachyderm.
    • Click the "Apply Changes" button at the bottom.
    • This gives Pachyderm permission to access the database you set up in step 5.
  7. Configure the database you created in step 5.
    • Open a command prompt: Go to Start Menu > All Programs > Accessories > Command Prompt
    • Type: cd C:\Pachyderm051707 then press Return or Enter (to change to that directory)
    • Type: LoadSQLFinal.bat
    • Press Return or Enter.
    • When asked for the password, enter: pach=derm
    • This runs a script created by Craig Smith that builds the database tables Pachyderm needs.
    • When you see a blank line after the directory name (C:\Pachyderm051707> ) the script has completed successfully.
    • Close the command prompt box by clicking the x in the upper right.
    • This creates the correct tables in the empty database from step 5.
  8. Resources

5) Update the installer's Pachyderm files with the current Pachyderm files.

  • Using Windows Explorer, open C:\Program Files\Pachyderm
  • Delete all the directories (folders) inside the Pachyderm folder; leave all files at the top level alone.
    • You will delete the folders named: Application Support; logs; Pachyderm2.woa; Service Files; temp; temptransformation; wwwroot
    • If asked whether you wish to delete files whose names are too long for the Recycle Bin, click "Yes to All"
  • Go to C:\Pachyderm051707\Program Files\Pachyderm
  • Copy (use CTRL-drag to copy the files rather than moving them) all directories into C:\Program Files\Pachyderm
  • This removes old files and replaces them with files known to work.

6) Configure Apache by copying new configuration files over old ones.

  • Using Windows Explorer, look in C:\Pachyderm051707\htdocs\
  • Copy all files and directories from there to C:\Program Files\Apache Software Foundation\Apache2.2\htdocs\
  • When asked if you want to overwrite index.html, say "Yes"
  • Look in C:\Pachyderm051707\apache\conf\
  • Copy the file httpd.conf from there to C:\Program Files\Apache Software Foundation\Apache2.2\conf\
  • When asked if you want to overwrite files, say "Yes"

7) Start Pachyderm and test your setup.

  • Open a command prompt (Start Menu > All Programs > Accessories > Command Prompt).
  • type: cd C:\Program Files\Pachyderm\Pachyderm2.woa
  • type: Pachyderm2
  • Many lines of text should result... just wait a while. When done it should say: [the date] <main> Waiting for requests...
  • Leave the command prompt window open.
  • This starts Pachyderm. Check it by doing the following:
    • Open a web browser and put in the URL: http://localhost:8000
    • Pachyderm should come up. If it can't connect, see Troubleshooting, below.
    • If it is not formatted correctly, Apache isn't working (Apache serves up the css files that format Pachyderm screens) -- see Troubleshooting, below.
      • If you don't have a D: drive, see Troubleshooting for how to fix this.
      • If you have other applications that listen on port 80 (Skype, for instance), see Troubleshooting for how to fix this.
    • If it looks correct, try logging in (administrator / pach=derm)
    • This should log you in to the administrator account. You aren't done yet though.
  • Leave all this up and go on to step 8.

8) Configure the apdefault table.

  • Start MySQL Query Browser (Start Menu > All Programs > MySQL > MySQL Query Browser)
  • Click the triangle by the Pachyderm database in the list on the right to tip it open.
  • Double click "apdefault" to open the apdefault table.
  • Click the "Execute" button (round, green, located in the upper right).
  • Scroll to the right to see the second-to-last column (labeled VALUE).
  • Find fields with IP addresses and replace the IP address that is there with the IP address of your machine.
    • Click the "EDIT" button at the bottom of the window so that you can edit fields.
    • Click in the field you want to edit. Once you make your change, the field will turn blue to show it is changed.
    • There are 3 fields with IP addresses. Just replace the IP address part with yours; leave the rest alone.
    • When you have changed all 3 fields, click "APPLY CHANGES" at the bottom.
    • Click "EDIT" again to turn editing off.
  • This sets up Pachyderm to send requests to the machine you have just installed it on.

9) Troubleshooting.

  • If you did not install .NET before running the Pachyderm installer (step 3), you will have to install the Pachyderm service manually from the command line:
    • Open a command prompt (Start Menu > All Programs > Accessories > Command Prompt).
    • type: cd C:\Program Files\Pachyderm\Services Files
    • type: install
    • This installs the Pachyderm service (not the application, but the service that starts the application) manually. This service requires .NET 2.0 to be present.
  • If Apache isn't working (see step 7) and you don't have a D: drive (i.e. you are installing this on your own computer for personal use):
    • Using Windows Explorer, open C:\Program Files\Apache Software Foundation\Apache2.2\conf\ to find the file called httpd.conf
    • Open the httpd.conf file in WordPad (right click the file, click "Open With..." and choose WordPad)
      • Search for "htdocs" in the file (no quotes)
      • Change the path from D:\htdocs to C:\Program Files\Apache Software Foundation\Apache2.2\htdocs
      • There are two places to make this change.
      • Save the file and close it.
    • This tells Apache to use the C: drive, which you have, rather than the D: drive, which you don't.
  • If Apache isn't working (see step 7) and you have other applications that listen on port 80 (like Skype) (i.e. you are installing this on your own computer for personal use):
    • If possible, release port 80 in the conflicting applications.
      • In Skype, open Options and un-check the option to use ports 80 and 443 as alternatives.
    • If that isn't possible, you can configure Apache to use a different port; try 7000.
      • Using Windows Explorer, open C:\Program Files\Apache Software Foundation\Apache2.2\conf\ to find the file called httpd.conf
      • Open the httpd.conf file in WordPad (right click the file, click "Open With..." and choose WordPad)
        • Search for "listen" in the file (no quotes)
        • Ignore all uses of "listen" where the line they are in begins with # (those are just comments)
        • Change "Listen 80" to "Listen 7000" (no quotes)
        • Search for ":80" (no quotes)
        • Leave all instances of :8000
        • Change "Servername xxx.xxx.xx.xxx:80" to "Servername xxx.xxx.xx.xxx:7000" (no quotes, and leave the x's as the numbers they already are)
        • Save the file and close it.
  • If Pachyderm can't connect to the server at all (see step 7) you might need to turn on the web service.
    • Open a command prompt (Start Menu > All Programs > Accessories > Command Prompt).
    • type: cd C:\Program Files\Apache Software Foundation\Apache2.2\bin
    • type: httpd
    • This will manually turn Apache on, but the preferred way is to run it as a service.
    • If you start Apache this way you will need to leave the command window open for it to keep running.
  • If Pachyderm won't start, you can manually start it from the command line.
    • Open a command prompt (Start Menu > All Programs > Accessories > Command Prompt).
    • type: cd C:\Program Files\Pachyderm\Pachyderm2.woa
    • type: Pachyderm2
    • This will manually start Pachyderm, but the preferred way is to run it as a service.
    • If you start Pachyderm this way you will need to leave the command window open for Pachyderm to keep running.
  • Most Pachyderm installation problems seem to relate to MySQL, so if you have a problem not covered here, there may be a problem with your MySQL configuration.
  • If you upload media into your new installation and no media thumbnails show up (in media search, media detail, and authoring windows)...
    • Steps to fix this to be added soon...
Retrieved from "http://wiki.nmc.org/nmcpedia/Windows_Pachyderm_Installation"
Personal tools