Installation - Windows
Installing OSS on Windows is very straightforward. The Short Version below should be sufficient ; if not use the More Detailed Version.
Contents |
Short Version
- Make sure you have JAVA 5 or newer correctly installed
- Download the latest stable build (zip) [1]
- Deflate it and run start.bat, which you'll find within the OSS folder
- Open your favorite browser with the url http://<yourserver>:8080 (your server being localhost if it's running on your own machine)
- Enjoy discovering OSS
Screencast
View the screencast to see how to download and install Open Search Server.
More Detailed Version
The following covers the same steps as above, in more detail.
Checking your version of Java
- Go to this page [2] to know which version of Java is running on your computer
- If your version is not a Version 5 or greater, you will need to update your Java engine
- If the web page states that you don't have any Java machine, please install one
In the latter two cases, you will be presented with a Free Java Download button. Just go ahead - press it and follow the provided instructions.
Downloading OSS
We recommend that you always get the latest version of OSS on SourceForge. Please download the ZIP package for Windows and unzip it on your disk.
When the file is unzipped you'll get a folder open-search-server. All your OSS binaries (and your future data) will be stored in this folder.
Running it
Just launch the start.bat file in your OSS base folder.
To access your OSS Back Office open you browser (Firefox, Opera, Safari, IE, ...) and open the page http://localhost:8080
If everything went right you'll see the OSS interface. If nothing gets displayed and you're certain you've done everything right, please check the troubleshooting section.
So far, so good ? You can now go to the next step and create your first index
Troubleshooting
This section reviews the possible causes for trouble. You only need to go through them if things are not going right.
Checking the environnement variables
- Right click My Computer
- Select Properties
- Select Advanced tab
- Select Environment Variables
You will see a list of variables. What you need is either a JRE_HOME or JAVA_HOME variable, depending on the type of Java engine you are running.
If the correct variable is present, please check that it targets the correct folder.
If the desired variable is not present, create it thus:
- If you have a JRE, create or update the environment variable JRE_HOME. Set it to target the folder where your Java JRE is, for example C:\Program Files\Java\jre1.6.0_14.
- If you have a JDK, create or update the environment variable JAVA_HOME. Set it to target the folder where your Java JDK is, for example C:\Program Files\Java\jdk1.6.0_14.
Once you have done that try again to launch OSS through start.bat.
If you have Java, do not see the variable *and* do not remember whether you have a JDK or JRE, go to the Start menu, Click Run, type cmd to call up the command line interface, and type java -version to see what's installed.
Checking whether your 8080 port is free
If by chance you already have a server listening on the 8080 tcp port you'll have to change it in the Catalina config files.
To check whether the 8080 port is already occupied use the following command line:
netstat -o -n -a | findstr 0.0:8080
If you have a response resembling the one below, your port isn't free:
TCP 0.0.0.0:8080 0.0.0.0:0 LISTENING 676
If port 8080 is already being used, we suggest that you simply use another port for ISS. To do so:
- Open in you OSS folder the file apache-tomcat-6.0.20/conf/server.xml
- Locate the line starting with:
<Connector port="8080" ...
then change it to<Connector port="8081" ...
- Save your file and restart OSS with start.bat.
- Your OSS Back Office is now available at this address: http://localhost:8081
