<?xml version="1.0" encoding="ISO-8859-1"?>

<document>

  <properties>
        <author email="remm@apache.org">Remy Maucherat</author>
        <author email="ozeigermann@apache.org">Oliver Zeigermann</author>
        <title>Installation</title>
    </properties>
  
  <body>
  
  <section name="Installing the Slide Server">
    <subsection name="Tomcat bundle">
    	<p>The Slide version bundled with Tomcat features easy installation and uses
    		Tomcat's integrated authentication. After you have downloaded this Slide distribution 
    		go the following to get it started:
    		<ul>
    			<li>Unpack it to a directory of your choice</li>
    			<li>If you have previously installed Tomcat and have set the CATALINA_HOME environment
    				variable, either unset it or set it to the directory you unpacked the distribution to</li>
				<li>Be sure to have at least JDK or JRE 1.3 installed</li>
    			<li>If not done, yet, you will have to set the JAVA_HOME enviroment variable to the location 
    				where your JDK or JRE has been installed</li>
    			<li>If you are on Windows either double click startup.bat in the bin directory
    				or use the prompt to change to the bin dir and run startup.bat in this directory - Slide should startup now</li>
    			<li>If you are on *n*x systems change to the bin dir and run startup.sh in this directory - Slide should startup now</li>
				<li>Connect to http://localhost:8080/slide - In order to have a WebDAV, not a pure HTTP connect you will
					need more than a browser. Either use dedicated WebDAV client software or follow the instructions
					in the User's Guide section.
				</li>
				<li>As authentication is turned on you need to login - admin login is "root" with password "root"</li>
				<li>All up-/downloads should go to the file directory</li>
				<li>Documentation is provided as a .war and can be accees at http://localhost:8080/slide-doc</li>
    		</ul>
   		</p>
   	</subsection>
    <subsection name="Binary Distribution">
    	<p>Slide's binary distribution mainly contains all jars, documentation and web applications. This 
    		distribution will need any Servlet container or application server that supports at least servlet spec
    		2.3. Web applications slide.war and slide-doc.war can be found at slide/webapp. Simply copy them to
    		the deployment directory of your servlet container or application server - webapps directory for Tomcat. 
    		If you do not know what this means consult the manual of your servlet
    		container or application server. To connect to Slide and how to go on from there have
    		a look at the instructions for the Tomcat bundled distribution above. Notice, however, this
    		distribution does not use authentication!
    	</p>
   	</subsection>
  </section>
  
  <section name="Compiling Slide from Source">
    
    <p>
      In order to successfully build Slide, you will need to do the 
      following. In the instructions below, $JAKARTA_HOME is assumed to be 
      the directory into which you are installing all of the required 
      distributions. The detailed dependency list is available in the next 
      section.
    </p>

    <ul>

    <li>
      Download and install a version 1.3 or later (1.4 recommended) Java Development Kit
      implementation for your operating system platform.  Set a "JAVA_HOME"
      environment variable to point at the directory where your JDK is 
      installed, and add "$JAVA_HOME/bin" to your PATH.
    </li>

    <li>
      Download and install Ant 1.5.3 or later. Then define an environment 
      variable named "ANT_HOME" and make it point to the path wher you just 
      installed Ant.
    </li>

    <li>
      Download the source distribution of Slide (subpackage "jakarta-slide"),
      or check it out via anonymous CVS, into a subdirectory named
      "$JAKARTA_HOME/jakarta-slide".
    </li>

    <li>
      Build Slide using :
      <pre>
        cd $JAKARTA_HOME/jakarta-slide
        $ANT_HOME/bin/ant.sh    for Unix
        %ANT_HOME%\bin\ant      for Windows
      </pre>
      You can delete the generated files in the "build" and "dist"
      subdirectories by executing the following:
      <pre>
        cd $JAKARTA_HOME/jakarta-slide
        $ANT_HOME/bin/ant.sh clean    for Unix
        %ANT_HOME%\bin\ant clean      for Windows
      </pre>
    </li>

    <li>
      A web application which can be used in any Servlet 2.3 compliant container can 
      be found $JAKARTA_HOME/jakarta-slide/dist/webapp/slide.war.
    </li>

    </ul>

  </section>

</body>
</document>
