See docs/LICENSE for The Xindice License


Xindice Version 1.0 UNIX installation.

Before anything, you're going to need Sun's Java SDK version 1.3 or
higher.  

How to install: (Use this process if you downloaded a binary distribution)

Note: these instructions are for UNIX if you are installing on windows
      see README.windows

1. Set the JAVA_HOME environment variable to the location of your jdk
   installation. For instance if your jdk is installed in /usr/local/java you
   would set JAVA_HOME=/usr/local/java

2. Set the XINDICE_HOME environment variable to the location where you extracted
   the Xindice distribution. For instance if you extracted to /usr/local then 
   you would set XINDICE_HOME=/usr/local/Xindice

3. Add the $XINDICE_HOME/bin directory to your PATH environment variable. This 
   will enable you to run the xindice and xindiceadmin command line tools 
   without specifying the full path.

4. Start the Xindice server.

   Type:
      cd $XINDICE_HOME
      ./start

5. The Xindice server should now be running.

6. Create a collection to test your installation and prepare it for 
   running the examples.
   
   Type:
      xindiceadmin ac -c /db -n addressbook
   
   If it worked successfully you should see 
   
   Created : /db/addressbook
            
   This just created a collection named "addressbook" in the default database 
   instance.
   
7. If everything worked Xindice is installed and running. 

   The place to start from here is to take a look at the documentation. This 
   can be accessed by pointing your browser to http://localhost:4080/. The 
   Users Guide is probably a good place to start.

   Also in the Xindice/java/examples directory are some simple example 
   programs that show you the basics of working with the server.
   
   If you ran into any problems you should join the Xindice users mailing
   list and ask your questions there. You can find instructions for joining
   the list on http://xml.apache.org, just follow the Xindice link.




Building from source: (NOTE: this section is aimed at developers who want to
   build a custom version of the server. If you just want to run Xindice you
   can ignore the rest of this file.)
   
Note: these instructions are for UNIX if you are building on windows
      see README.windows

1. Make sure the java bin directory is in your PATH environment variable.

2. Set the JAVA_HOME environment variable to the location of your jdk
   installation. For instance if your jdk is installed in /usr/local/java you
   would set JAVA_HOME=/usr/local/java

3. Set the XINDICE_HOME environment variable to the location where you extracted
   the Xindice distribution. For instance if you extracted to /usr/local then 
   you would set XINDICE_HOME=/usr/local/Xindice

4. Add the $XINDICE_HOME/bin directory to your PATH environment variable. This 
   will enable you to run the xindice and xindiceadmin command line tools 
   without specifying the full path.

5. You are now prepared to build.

   Type:
      cd $XINDICE_HOME
      ant

6. Build the javadoc documentation (optional)

   Type
      ant javadoc

7. If everything worked you should have a freshly rebuilt version of Xindice