en:user_advanced:installation_311
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| en:user_advanced:installation_311 [2025/07/14 21:15] – created kjdon | en:user_advanced:installation_311 [2025/07/15 00:08] (current) – kjdon | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Advanced Installation: | ||
| + | //Updated on 30 Sep 2021, with changes that do not apply for Greenstone 3.10 and earlier.// | ||
| - | ====== | + | [[en: |
| - | //Updated on 30 Sep 2021, with changes that do not apply for Greenstone 3.10 and earlier. | ||
| - | For instructions related to compiling GS3.10 from source distribution or with source component, or with source code from before September 2021, refer to the now [[old: | ||
| For most users, the main Greenstone download (also called the " | For most users, the main Greenstone download (also called the " | ||
| Line 118: | Line 118: | ||
| To make it easier for developers, a batch file containing placeholders you can adjust is already prepared and discussed at [[http:// | To make it easier for developers, a batch file containing placeholders you can adjust is already prepared and discussed at [[http:// | ||
| ==== Source Component ==== | ==== Source Component ==== | ||
| - | <tabbox Greenstone3> | + | |
| **Note:** Greenstone 3 does not at present compile successfully if it was installed in a place containing spaces. The solution is to move the installed GS3 folder out into a different location, one without spaces in the filepath, //before// compiling. Once compiling is done, you can move your installed GS3 folder back to its original location. | **Note:** Greenstone 3 does not at present compile successfully if it was installed in a place containing spaces. The solution is to move the installed GS3 folder out into a different location, one without spaces in the filepath, //before// compiling. Once compiling is done, you can move your installed GS3 folder back to its original location. | ||
| Line 163: | Line 163: | ||
| Therefore, to run GLI after compiling GS3 for 64 bit, add the bin folder of JRE for 64 bit to the PATH, or set JAVA_HOME to JDK 64 bit and add its bin folder to the PATH. Then run GLI in this environment. | Therefore, to run GLI after compiling GS3 for 64 bit, add the bin folder of JRE for 64 bit to the PATH, or set JAVA_HOME to JDK 64 bit and add its bin folder to the PATH. Then run GLI in this environment. | ||
| - | <tabbox Greenstone2> | ||
| - | - Get the source component zip file from the downloads page. | ||
| - | - Unzip it in your Greenstone installation. If Windows prompts you about whether you want existing folders merged (and existing files replaced), tick the box to confirm for all and click in the affirmative. | ||
| - | - Open a DOS prompt | ||
| - | - Set up the environment for compiling Greenstone by running the setupenv.bat script described further above: '' | ||
| - | - Go into your Greenstone installation: | ||
| - | - Run the makegs2 script: '' | ||
| - | - It will prompt you about whether to extract certain important files. Type Y to do so. | ||
| - | - It will next present you with various compilation options. You want to type 4 (" | ||
| - | - It will take some minutes to compile after which, if there are no errors, you can start running GLI or the gs2-server. | ||
| - | - If you want to recompile GLI go into your Greenstone' | ||
| + | ==== Source Distribution ==== | ||
| - | **Note:** Building collections that use lucene as their indexer requires Java. If you compiled up GS2 using a later version of Java than the version of JRE included in the binary (Java 7), then building a lucene collection may produce error messages about incompatible java versions. In such a case, rename your GS2 installation '' | ||
| - | </ | ||
| - | ==== Source Distribution ==== | ||
| - | <tabbox Greenstone3> | ||
| - Get the source distribution zip file from the downloads page. | - Get the source distribution zip file from the downloads page. | ||
| - //Unzip it in a location with no spaces in the filepath.// | - //Unzip it in a location with no spaces in the filepath.// | ||
| Line 194: | Line 180: | ||
| To run GLI or the gs3-server after compiling the source code on a 64 bit Windows machine, you need your environment to be set up with JDK 8 or JRE 8 (or JDK 7+ else JRE 7+ for Greenstone versions prior to GS3.11) for 64-bit and Ant: set the JAVA_HOME environment variable to your 64 bit JDK and add the JDK's '' | To run GLI or the gs3-server after compiling the source code on a 64 bit Windows machine, you need your environment to be set up with JDK 8 or JRE 8 (or JDK 7+ else JRE 7+ for Greenstone versions prior to GS3.11) for 64-bit and Ant: set the JAVA_HOME environment variable to your 64 bit JDK and add the JDK's '' | ||
| - | <tabbox Greenstone2> | + | |
| - | - Get the source distribution zip file from the downloads page. | + | |
| - | - Unzip it | + | |
| - | - Open a DOS prompt | + | |
| - | - Set up the environment for compiling Greenstone by running the setupenv.bat script described above: '' | + | |
| - | - Go into your Greenstone installation: | + | |
| - | - Run the makegs2 script: '' | + | |
| - | - It will prompt you about whether to extract certain important files. Type Y to do so. | + | |
| - | - It will next present you with various compilation options. You want to type 4 (" | + | |
| - | - It will take some minutes to compile after which, if there are no errors, you can start running the gs2-server. | + | |
| - | - If you want to run GLI as well, this will need to be compiled. To compile it, go into your Greenstone' | + | |
| - | - If you wish to compile up the GLI jar files, such as for Remote Greenstone situations, run the following from within the gli folder: '' | + | |
| - | - You will need to enable the Administration pages if you want access to them. Do so by editing your Greenstone installation' | + | |
| - | - If you don't already have an imagemagick installed on your system and want to have // | + | |
| - | </ | + | |
| Line 227: | Line 199: | ||
| which can be accomplished using the file '' | which can be accomplished using the file '' | ||
| - | <tabbox Greenstone3> | + | |
| Run the following: | Run the following: | ||
| < | < | ||
| Line 236: | Line 208: | ||
| ant install | ant install | ||
| </ | </ | ||
| - | <tabbox Greenstone2> | ||
| - | < | ||
| - | svn co https:// | ||
| - | cd gs2-svn | ||
| - | </ | ||
| - | Then on 64 bit Windows run: | ||
| - | < | ||
| - | makegs2x64.bat | ||
| - | </ | ||
| - | whereas on 32 bit Windows, you'd need to run: | ||
| - | < | ||
| - | makegs2.bat | ||
| - | </ | ||
| - | * Choose yes twice | ||
| - | * Choose step 4 to compile ALL without debugging | ||
| - | Check out and compile GLI: | ||
| - | < | ||
| - | svn co https:// | ||
| - | cd gli | ||
| - | makegli.bat | ||
| - | makejar.bat | ||
| - | </ | ||
| - | </ | ||
| For more detailed instructions on source installation, | For more detailed instructions on source installation, | ||
| Line 273: | Line 222: | ||
| ==== Source Component ==== | ==== Source Component ==== | ||
| - | <tabbox Greenstone3> | + | |
| - Download and extract the Source Component for your Operating System into the top-level folder of your Greenstone 3 binary installation. For Linux/Mac, download the tar.gz version as zip doesn' | - Download and extract the Source Component for your Operating System into the top-level folder of your Greenstone 3 binary installation. For Linux/Mac, download the tar.gz version as zip doesn' | ||
| - Set up ant and Java: set JAVA_HOME (to JDK 7 for Greenstone 3.06, JDK 8 for Greenstone 3.11 onwards) and add its '' | - Set up ant and Java: set JAVA_HOME (to JDK 7 for Greenstone 3.06, JDK 8 for Greenstone 3.11 onwards) and add its '' | ||
| Line 307: | Line 256: | ||
| The gnome-lib environment may conflict with graphical applications on Linux systems. After compiling, open a fresh terminal to run GLI or other graphical applications. But make sure the new terminal has the environment set up for Java and Ant too before running any Greenstone applications like the Greenstone Server (gs3-server) and GLI. | The gnome-lib environment may conflict with graphical applications on Linux systems. After compiling, open a fresh terminal to run GLI or other graphical applications. But make sure the new terminal has the environment set up for Java and Ant too before running any Greenstone applications like the Greenstone Server (gs3-server) and GLI. | ||
| - | |||
| - | <tabbox Greenstone2> | ||
| - | - Download the Source Component tar.gz file that matches with your Greenstone binary version, and put it in your Greenstone installation folder. For Linux/Mac, you want the tar.gz version because the zip version doesn' | ||
| - | - Use a terminal to extract the downloaded file's contents into your Greenstone installation folder: \\ < | ||
| - | tar -xvzf < | ||
| - | </ | ||
| - | - Move the '' | ||
| - | - If you want to compile up gnome-lib yourself, skip this step. If you want to use a pre-compiled gnome-lib binary (to save on all the time of compiling gnome-lib), download the gnome-lib-minimal package for your OS by visiting http:// | ||
| - | - Make sure JAVA_HOME is set and the bin folders for Java and Perl are on your PATH. | ||
| - | - Run the following, which will get gnome-lib and compile it up as it's compiling your Greenstone: \\ < | ||
| - | cd gli | ||
| - | ./ | ||
| - | ./ | ||
| - | </ | ||
| - | |||
| - | |||
| - | INSTRUCTIONS FOR OLDER VERSIONS OF GREENSTONE: | ||
| - | |||
| - | * Go to **the folder where you unpacked the Greenstone binary distribution**. For example, if this folder were called gsdl-2.80-unix: | ||
| - | < | ||
| - | |||
| - | * Run Install Shield again: | ||
| - | < | ||
| - | |||
| - | * You already have Greenstone installed, therefore when it asks you whether you want to install it as a web server choose **Custom Setup**. | ||
| - | |||
| - | * Untick everything. Tick only the **Source Code** option. If it asks you whether you want to overwrite files you already have, press the **No to All** button. | ||
| - | |||
| - | * Go into $GSDLHOME -- the folder where you installed Greenstone. | ||
| - | < | ||
| - | See if there is a folder called **indexers**. If there is none (as is the case with Greenstone 2.80, but it is intended to be included in future Greenstone binary releases), then you need to get it. To get it from SVN (and into the $GSDLHOME folder where you now are): | ||
| - | < | ||
| - | If you don't know what subversion/ | ||
| - | |||
| - | * Now that you are in $GSDLHOME and have the indexers folder in it, you can **compile it all** by typing the following in an xterm (note that each step can take a few minutes): | ||
| - | < | ||
| - | > make all | ||
| - | > make install | ||
| - | </ | ||
| - | All going well, this would have compiled it. If you had any difficulties during compilation, | ||
| - | |||
| - | * Still in $GSDLHOME, **set up the environment for Greenstone**: | ||
| - | < | ||
| - | |||
| - | * To get the Greenstone Librarian Interface (GLI) working, you need to compile that. So go into the gli folder, which is located in $GSDLHOME, and **compile GLI**: | ||
| - | < | ||
| - | > ./ | ||
| - | > ./ | ||
| - | </ | ||
| - | (The above would have compiled GLI and then the last line created the executable jar file from the compiled files.) | ||
| - | |||
| - | |||
| - | You can run GLI with: | ||
| - | < | ||
| - | Unfortunately there' | ||
| - | < | ||
| - | / | ||
| - | Version: 2.80 | ||
| - | |||
| - | Exception in thread " | ||
| - | at javax.swing.plaf.synth.SynthContext.getPainter(SynthContext.java: | ||
| - | .... | ||
| - | </ | ||
| - | You can correct the problem above, by | ||
| - | * going to the directory $GSDLHOME/ | ||
| - | * opening its file GathererProg.java in a text editor | ||
| - | * and replacing the line | ||
| - | < | ||
| - | with: | ||
| - | < | ||
| - | * Save the file you just edited. | ||
| - | * Finally, you need to recompile GLI again as explained just above. | ||
| - | |||
| - | * Assuming your web server is set up and running, you can **view the pages Greenstone serves from the browser** at http:// | ||
| - | where the WebServerName and WebServerPort are what you specified when you [[en: | ||
| - | </ | ||
| ==== Source Distribution ==== | ==== Source Distribution ==== | ||
| Line 401: | Line 274: | ||
| </ | </ | ||
| - | <tabbox Greenstone3> | + | |
| - Download the Source Distribution for your Operating System and extract it into the location where you want Greenstone installed. For Linux/Mac, download the tar.gz version as zip doesn' | - Download the Source Distribution for your Operating System and extract it into the location where you want Greenstone installed. For Linux/Mac, download the tar.gz version as zip doesn' | ||
| - Go into your extracted source distribution' | - Go into your extracted source distribution' | ||
| Line 434: | Line 307: | ||
| The gnome-lib environment may conflict with graphical applications on Linux systems. After compiling, open a fresh terminal to run GLI or other graphical applications. Make sure the new terminal has the environment set up for Java (version 8 from GS3.11 and onwards) and Ant too before running any Greenstone applications like the Greenstone Server (gs3-server) and GLI. | The gnome-lib environment may conflict with graphical applications on Linux systems. After compiling, open a fresh terminal to run GLI or other graphical applications. Make sure the new terminal has the environment set up for Java (version 8 from GS3.11 and onwards) and Ant too before running any Greenstone applications like the Greenstone Server (gs3-server) and GLI. | ||
| - | <tabbox Greenstone2> | ||
| - | - Download the Source Distribution and extract it. For Linux/Mac, please use the tar.gz version as zip doesn' | ||
| - | - If you want to compile up gnome-lib yourself, skip this step. If you want to use a pre-compiled gnome-lib binary (to save on all the time of compiling gnome-lib), download the gnome-lib-minimal package for your OS by visiting http:// | ||
| - | - Make sure JAVA_HOME is set and the bin folders for Java and Perl are on your PATH. | ||
| - | - Run the following, which will get gnome-lib and compile it up as it's compiling your Greenstone.\\ < | ||
| - | ./ | ||
| - | cd gli | ||
| - | ./ | ||
| - | ./ | ||
| - | </ | ||
| - | - You will need to enable the Administration pages if you want access to them. Do so by editing your Greenstone installation' | ||
| - | </ | ||
| ==== Uptodate source code from SVN ==== | ==== Uptodate source code from SVN ==== | ||
| - | <tabbox Greenstone3> | + | |
| - Make sure you have SVN installed and on your Path | - Make sure you have SVN installed and on your Path | ||
| Line 499: | Line 360: | ||
| </ | </ | ||
| - | <tabbox Greenstone2> | ||
| - | - First grab all the source code from SVN by running the following commands in your terminal \\ < | ||
| - | svn co https:// | ||
| - | cd greenstone2 | ||
| - | svn co https:// | ||
| - | </ | ||
| - | - If you want to compile up gnome-lib yourself, skip this step. If you want to use a pre-compiled gnome-lib binary, download the gnome-lib-minimal package for your OS by visiting https:// | ||
| - | - Compile up Greenstone: \\ < | ||
| - | ./ | ||
| - | cd gli | ||
| - | ./ | ||
| - | ./ | ||
| - | </ | ||
| - | - You will need to enable the Administration pages if you want access to them. Do so by editing your Greenstone installation' | ||
| - | </ | ||
| Line 578: | Line 424: | ||
| --> | --> | ||
| - | ===== Source Code Stability ===== | ||
| - | Note: This page is aimed at Greenstone developers. | ||
| - | |||
| - | The source code stability system attempts to provide developers with a constant stable code base for development even as the main trunk passes between stable and unstable states. If you are doing development on a working copy of the trunk, but the trunk has bugs which prevent it compiling or running, then it can be very hard to test your changes. Rather than spend time inquiring into those bugs, the stability system gives you a way to temporarily roll your working copy back to the last stable state. Once you have finished testing your changes, you can then roll you working copy forward again and commit your changes. Except in the case where other developers have made significant changes to the trunk, your changes will start working once the trunk is stable again. | ||
| - | |||
| - | The stability system works by periodically checking out the trunk and testing it for stability, then creating a ' | ||
| - | |||
| - | To make your working copy stable, change to the root directory of the working copy and run one of these commands: | ||
| - | < | ||
| - | (For Greenstone2): | ||
| - | (For Greenstone3): | ||
| - | </ | ||
| - | Or to checkout a fresh stable working copy, run one of these commands: | ||
| - | < | ||
| - | (For Greenstone2): | ||
| - | (For Greenstone3): | ||
| - | </ | ||
| - | |||
| - | Then test your changes and/or keep working on them. Once you are ready to commit your changes, switch back to the trunk: | ||
| - | < | ||
| - | (For Greenstone2): | ||
| - | (For Greenstone3): | ||
| - | </ | ||
| - | And commit as normal. | ||
| - | |||
| - | **Note**: The stable tags are read-only. (Only the nightly tasks that create the stable tags can write to them.) This is for good reason; allowing commits to the stable tag would be lost the next time the trunk was tagged as stable. | ||
| - | |||
| - | The projects ' | ||
| - | You can execute a command like the following to switch to the stable tag for one of | ||
| - | these projects: | ||
| - | |||
| - | '' | ||
| - | |||
| - | And switch back with: | ||
| - | |||
| - | '' | ||
| - | |||
| - | **Note**: Though the stable branches are in separate locations in the repository, they should be considered as one unit. To get a //bona fide// stable working copy, each project which made up the working copy would have to be switched to the stable tag of the project. Mixing of ' | ||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | ===== Moving a Greenstone installation ===== | ||
| - | For Linux, you will need to uninstall your Greenstone first and then reinstall it in the new location. | ||
| - | |||
| - | For Windows: | ||
| - | In the case of GS2.83, if you move your Greenstone2 installation folder to some other location, make sure that you relocate it such that there are no spaces in its new path. For instance, " | ||
| - | |||
| - | Once you've moved your Greenstone installation, | ||
| - | - Open your Greenstone 2 installation' | ||
| - | - To get the local library server (server.exe) to work from the new location: if your top-level Greenstone installation folder contains the files llssite.cfg and glisite.cfg, | ||
| - | - To get the Apache web server included with Greenstone to work: delete the file lib\java\log4j.properties. (Doing so will ensure that if you execute the gs2-server.bat file--which launches the Greenstone Server Interface--this properties file will be regenerated with the correct value for gsdlhome.) | ||
en/user_advanced/installation_311.1752527714.txt.gz · Last modified: 2025/07/14 21:15 by kjdon