STANDUP Installation Guide (FULL mode) for Version 1.4.1 Release B
(Last update: 24 May 2007)
This guide contains step-by-step installation instructions for upgrading the STANDUP system from SIMPLE to FULL mode on a Windows XP machine.
Currently, the process is rather cumbersome and requires considerable (and patient) user intervention.
Instructions for uninstalling the STANDUP FULL Upgrade are given at the end of this document.
Have you got STANDUP SIMPLE?
The files described here are merely an upgrade: you must have STANDUP already installed and runnable in SIMPLE mode on your machine in order to get STANDUP to run in FULL mode. After the upgrade, you can still run STANDUP in SIMPLE mode if you wish.
If you have STANDUP already working in SIMPLE mode on your machine, this means that you have enough memory (512 MB, although more is better), a fast enough processor (1.5 GHz) and a suitable Java environment (Version 5 or later). The upgrade installation will consume about 4 GB of disk space.
The STANDUP FULL upgrade procedure consists entirely of installing the PostgreSQL free software (not developed on the STANDUP project) and loading a large STANDUP lexical database into PostgreSQL.
The availability of PostgreSQL determines whether STANDUP FULL mode can run on your machine. As of May 2007, PostgreSQL is supported on Windows 2000, XP and 2003 (only on 32 bit systems); you can check the PostgreSQL website for the latest on this. PostgreSQL requires functionality that is not available on Windows 95/98/ME, and will not run on them. If you want to try running PostgreSQL on these platforms, the PostgreSQL developers suggest looking at the Cygwin port, which has basic support for Windows 9x platforms, but we do not know how feasible that is.
N.B.: If you're using these old operating systems, the PC in question is probably not large enough or fast enough to run STANDUP anyway.
Although in principle STANDUP should be able to run on Macs, Unix/Linux, and other Windows variants (e.g. Windows Vista) using an appropriate underlying Java and PostgreSQL setup, we currently do not provide any instructions for these systems, and offer no guarantee that the STANDUP software will run on these systems.
N.B. Once the files have been fully downloaded and extracted (unzipped), the lexical database installation procedure (see steps 1 and 2 below) takes about an hour, and requires user interaction at various stages.
The download from the STANDUP website should have provided you with a ZIP (compressed) folder/file. Extract the files from that folder. These should be:
- STANDUP Full.bat
- a ZIP folder containing the PostgreSQL system, named something like postgresql-8.1.5-1.zip
- the STANDUP database file (a PostgreSQL "backup" file), named something like standup_v1.4_061127_joke.backup
- a folder docs containing a number of files of documentation, including the Installation Guide for the STANDUP FULL Upgrade.
The recommended locations for these files are:
- STANDUP Full.bat : in the folder where the other STANDUP .BAT file, from the STANDUP SIMPLE installation (STANDUP Simple.BAT) is located. This matters - the system will not work if STANDUP Full.bat is not alongside the jars folder from the SIMPLE installation.
- README_Full.TXT, LICENCE.TXT: the location of these is not critical, but it's probably convenient to put them in the same folder as STANDUP Full.bat. LICENCE.TXT should be there already, from the SIMPLE installation.
- the PostgreSQL ZIP file can go anywhere that is convenient (e.g. wherever you keep downloads). You will be extracting its contents and then using them to set up PostgreSQL (See "Installation" below).
- the STANDUP database "backup" file can go anywhere that is convenient. You will have to be able to find it when running PostgreSQL to set up the lexical database.
- the contents of the docs are best placed in the docs folder which is located in the existing STANDUP Simple folders. (But you can put them elsewhere if you prefer.)
STEP 1: Setting up PostgreSQL
Note: You will need administrative privileges on your Windows system to carry out the PostgreSQL installation.
(We will assume here you are installing PostgreSQL version 8.1, but you may need to look for different filenames if you are using a later version, such as 8.2.)
- Extract the files from the PostgreSQL installation ZIP folder (see above), placing them somewhere convenient on your hard drive. Double-click the postgresql-8.1.msi file to begin the installation process.
- Leave the selected language as English and click "Start". Click "Next" twice.
- You should then see the "Installation options" screen. The default behaviour of PostgreSQL is to install itself under C:\Program Files\PostgreSQL\8.1\ -- if this presents a problem, you can change it here by clicking the 'Browse' button.
- Click "Next". At the next screen, you can just leave all the default settings as is. Just make sure that "Install as a service" is checked.
- You can enter any password you want here, but if you just leave it blank, one will be randomly generated for you. This is the password for the Windows account that will run the service, not the database superuser account (that comes later).
- Click Next. If it asks for confirmation whether to create the account, click Yes.
- You should then see the "Initialise database cluster" screen.
Set locale to "English, United Kingdom".
Set encoding to "UTF-8".
Set superuser name to "postgres".
Set password to "pgsuper!" (without the quotation marks).
Reconfirm password: "pgsuper!".
- Click Next. You should then see the "Enable procedural languages" screen.
- Make sure "PL/pgsql" is checked and click Next. You should then see the "Enable contrib modules" screen. Leave things as is and click Next.
- Click Next again. This should begin the installation. It might take a few minutes.
- Click Finish.
STEP 2: Restoring the STANDUP database
Now that PostgreSQL is installed, we need to load, or in Postgres parlance, restore the standup_v1.4 database, using the "backup" file that you have extracted from the STANDUP FULL Upgrade ZIP folder (above).
There are 2 ways to restore the database, i.e. by using pgAdmin III, the PostgreSQL administration GUI tool, or by entering the command from a MSDOS command line interface. They both accomplish the same thing, so it's down to your preference
(Again, we shall assume that you have installed PostgreSQL Version 8.1, but you will need to make the obvious changes to folder names, etc., if the number is 8.2 or later.)
The GUI way
- Launch the pgAdmin III tool: go to the Start menu, choose Programs > PostgreSQL > pgAdmin III
- On the left side of the window should be a list of Servers containing 1 entry: "PostgreSQL Database Server 8.1 (localhost:5432). Double-click this entry.
- A "Connect to server" dialog box should pop up. Enter the password you entered earlier: "pgsuper!" (without the quotation marks) and click OK.
- Some new entries should appear: Databases, Tablespaces, Group Roles, and Login Roles. Right-click on Databases and choose "New Database".
- A "New Database" dialog box should pop up. Enter name: "standup_v1.4". Leave everything as is (everything else should be empty except Encoding, which should be "UTF8". Click OK. This will create the "standup_v1.4" database.
- Now double-click the "Databases" entry to expand it. You should see the 'standup_v1.4' database there.
- Right-click on "standup_v1.4" and choose "Restore". The "Restore Database standup_v1.4" dialog box should pop up. Click the "..." button next to the Filename field, and locate the standup_v1.4_061127_joke.backup file you extracted from the STANDUP download (see above). Click OK and the database restore process will begin. This can take anywhere between thirty minutes and a few hours depending on the configuration of the computer being used (in particular, hard disk speed and amount of RAM). If you spot an error saying 'could not execute query: ERROR: language "plpgsql" already exists', just ignore it -- it's perfectly normal.
- Once the restore process is complete, it should say something like:
"WARNING: errors ignored on restore: 1 Process returned exit code 1."-- this is simply reporting the aforementioned error.
- At this point, do NOT click the "OK" button! This will cause PostgreSQL to try and restore the database again, and this will only serve to confuse it! Click the "Cancel" button instead.
- Exit the pgAdmin III application by choosing File > Exit.
The command-line way
- Open a DOS command prompt. You can do this by going to the Start menu and choosing "Run...". In the resulting dialog box, type in "cmd" and click OK. (Alternatively, find the "Command Prompt" in the Programs menu (it's usually in "Accessories").
- If you haven't changed any settings above, enter this command to create the database:
"C:\Program Files\PostgreSQL\8.1\bin\createdb.exe" -E UTF8 -U postgres "standup_v1.4"
- If successful, it should return with a CREATE DATABASE message. Now, to restore the database, enter this command:
"C:\Program Files\PostgreSQL\8.1\bin\pg_restore.exe" -i -U postgres -d "standup_v1.4" -v "C:\My Documents\standup_v1.4_061127.backup"
(This example assumes you placed the .backup file in the My Documents folder. If you placed it somewhere else, change the command above accordingly.)
- This can take anywhere between thirty minutes and a few hours depending on the configuration of the computer being used (in particular, hard disk speed and amount of RAM). If you spot an error saying 'could not execute query: ERROR: language "plpgsql" already exists', just ignore it -- it's perfectly normal. Once the restore process is complete, it should say something like: WARNING: errors ignored on restore: 1 -- this is simply reporting the aforementioned error.
- Close the DOS window by entering the command exit or pressing the 'X' icon in the top right corner.
STEP 3: Running the STANDUP system
If everything has gone OK up until now, you should be able to run the system!
To launch the system, open (double-click) the STANDUP Full BAT file, (after making sure it is in the folder which contains the jars folder from the STANDUP SIMPLE Installation, as explained above). If you haven't completed steps 1 and 2 above, this attempted launch will result in an error.
As with STANDUP SIMPLE, when you run the STANDUP system, it will create data in a standupdata folder alongside the BAT file you are starting from. Hence, the user running the STANDUP system MUST have permission to create files/folders in this location, otherwise the system will crash during start-up.
The initial set-up phase may take a couple of minutes. Once it is done, you will be presented with the STANDUP User Interface! Consult the STANDUP User Manual for more information about this. (There is a copy in the docs folder.)
If all this is working, then no further interaction with PostgreSQL should be needed. Opening the STANDUP Full.BAT file is all you need to do when you want to run STANDUP. You can still run it in SIMPLE mode using STANDUP Simple.BAT
Optional voice upgrade
The optional voice upgrade for STANDUP is equally compatible with STANDUP SIMPLE and STANDUP FULL. Hence, if you have installed the upgraded voice already, it should work with STANDUP FULL, or if you wish to install the improved voice later, you can.
Uninstalling the STANDUP FULL Upgrade
At present, there is no simple way to remove the STANDUP FULL Upgrade from a computer (i.e. so that only STANDUP SIMPLE is installed) -- the only method is to undo all the steps originally taken during installation.
Files to be removed
The first step involves deleting all the files you extracted from the downloaded STANDUP FULL Upgrade ZIP folder/file:
- STANDUP Full.bat
- postgresql-8.1.5-1.zip (but you can keep this if you might be re-installing PostgreSQL in the future). Also, delete the files you extracted from this ZIP folder.
- standup_v1.4_061127_joke.backup (but you can keep this if you might be re-installing this version of STANDUP FULL in the future)
- the files which were in the folder docs (be careful not to delete other documentation files which were in your original STANDUP SIMPLE installation already).
After the above deletions, PostgreSQL will still be installed on your PC, and the STANDUP lexical database will still be installed within PostgreSQL. This takes up quite a bit of space.
If you do not wish to make further use of the PostgreSQL system, you can remove that from your computer. How to do this is not properly part of the STANDUP uninstall procedure, but here are some suggestions:
- Use the Add/Remove Programs in the Windows XP Control Panel to remove PostgreSQL.
- Check the postgres folder within your Program Files folder (or wherever else you installed PostgreSQL) to see if any files and folders have been left behind in it. If so, delete these (and the postgres folder).
- PostgreSQL may have left a "service account" defined on your Windows system, created as part of the installation procedure. On Windows XP Professional, following the menus Control Panel -> Administrative Tools -> Computer Management -> Local Users and Groups will take you to a list where the "postgres" service account can be removed. Alternatively, on Windows XP Home (or Professional), enter "net user postgres /delete" from the Command Prompt. If you changed the name of the Postgres service account during the installation, replace the account name accordingly.
After all that, the STANDUP Full Upgrade should be expunged from your computer, but STANDUP should still run in SIMPLE mode as before.