jericho 2002/07/17 01:25:02
Modified: . RUNNING.txt
Log:
- Thanks to Anton Schoultz <[EMAIL PROTECTED]> and
Thomas Schueppel <[EMAIL PROTECTED]>
It's made from their mails....
Revision Changes Path
1.3 +142 -25 jakarta-slide/RUNNING.txt
Index: RUNNING.txt
===================================================================
RCS file: /home/cvs/jakarta-slide/RUNNING.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- RUNNING.txt 10 Jun 2002 04:55:45 -0000 1.2
+++ RUNNING.txt 17 Jul 2002 08:25:02 -0000 1.3
@@ -1,52 +1,169 @@
+$Id$
- Running Slide
- =============
+===============================================================================
+ Running Slide 2.0
+===============================================================================
+----------------------------------------------------------- Note before reading
-Note: SLIDE_HOME represents the path where the Slide binary distribution was
-installed.
+* WEB_SERVER: Your web server path to deploy Slide
+ - On a Windows platform (It's not an environment variable currently)
-Running the Slide WebDAV client
-===============================
+ %WEB_SERVER%="C:\Program Files\Apache Tomcat 4.0" (for example, Tomcat 4.0)
+* SLIDE_HOME: The path where the Slide binary distribution was installed
-Go in the SLIDE_HOME/{dist|build}/client directory:
-Windows: cd %SLIDE_HOME%\{dist|build}\client
+----------------------------------- Download and install a Java Development Kit
-Unix: cd $SLIDE_HOME/{dist|build}/client
+* Download a Java Development Kit (JDK) release (version 1.2 or later) from:
+ http://java.sun.com/j2se/
-Execute the shell command:
+* Install the JDK according to the instructions included with the release
-Windows: bin\run
+* Set an environment variable JAVA_HOME like:
-Unix: ./bin/run.sh
+ - On a Windows platform
+ %JAVA_HOME%=C:\java\j2sdk1.4.0
-Running the Slide Standalone Server
-===================================
+ - On a Unix platform
+ JAVA_HOME=/java/j2sdk1.4.0 (for example, when you use ksh)
+ export JAVA_HOME
-Go to the SLIDE_HOME/server directory:
-Windows: cd %SLIDE_HOME%\server
+-------------------------------- Download and install Slide binary distribution
-Unix: cd $SLIDE_HOME/server
+* Download a binary distribution of Slide from:
+ http://jakarta.apache.org/builds/jakarta-slide
-Execute the shell command:
+* Set an environment variable SLIDE_HOME like:
-Windows: bin\startup
+ - On a Windows platform
-Unix: ./bin/startup.sh
+ %SLIDE_HOME%=C:\java\jakarta-slide
+ - On a Unix platform
-After startup, use a web browser, and access the URL:
+ SLIDE_HOME=/java/jakarta-slide (for example, when you use ksh)
+ export SLIDE_HOME
- http://localhost:8080
+* Install all jars required for Slide (refer to SLIDE_HOME/lib/README)
+
+
+---------------------------------------------------------------- Start up Slide
+
+* Execute the Slide client (WebDAV client) shell command like:
+
+ - On a Windows platform
+
+ %SLIDE_HOME%\client\bin\run
+
+ - On a Unix platform
+
+ $SLIDE_HOME/client/bin/run.sh
+
+* Deploy the Slide server (WebDAV server) within your web server like:
+
+ 1) Common jars like slide-stores.jar, slide-roles.jar, slide-kernel.jar,
+ slide-webdavservlet.jar, commons-dbcp.jar, commons-pool.jar, jta.jar, etc
+
+ - On a Windows platform
+
+ copy %SLIDE_HOME%\slide\lib\*.jar %WEB_SERVER%\common\lib
+
+ - On a Unix platform
+
+ cp $SLIDE_HOME/slide/lib/*.jar $WEB_SERVER/common/lib
+
+ 2) Jars for the web server like slide-jmxwrapper.jar and slide-jndiwrapper.jar
+
+ - On a Windows platform
+
+ copy %SLIDE_HOME%\slide\wrappers\*.jar $WEB_SERVER\server\lib
+
+ - On a Unix platform
+
+ cp $SLIDE_HOME/slide/wrappers/*.jar $WEB_SERVER/server/lib
+
+ 3) Slide web applications like slide.war, slide-admin.war and slide-doc.war
+
+ - On a Windows platform
+
+ copy %SLIDE_HOME%\slide\webapp\*.war %WEB_SERVER%\webapps
+
+ - On a Unix platform
+
+ cp $SLIDE_HOME/slide/webapp/*.war $WEB_SERVER/webapps
+
+ 4) Start and stop your web server to extract the war files
+
+ 5) Copy the 'Domain.xml' to WEB_SERVER/webapps/slide
+
+* Test your basic installation of the Slide server like:
+
+ - Access the HTTP URL probably like:
+
+ http://localhost:8080/slide
+ http://localhost:8080/slide-admin
+ http://localhost:8080/slide-doc
+
+* Test your versioning installation of the Slide server like:
+
+ - Access the HTTP URL probably like:
+
+ 1) Connect to the Slide server like http://localhost:8080/slide/files
+
+ 2) Upload a file
+
+ 3) Change the file and upload it again
+
+ 4) Go to /history/1 in Slide
+ (There should be a document for each revision you uploaded)
+
+
+--------------------------------------------------- Building from Slide sources
+
+* Need ant, a build package
+
+
+-------------------------------------------------------- Advanced configuration
+
+* Ensuring your Domian.xml for Slide server
+
+ - Check 'init-param' in the file, WEB_SERVER/webapps/slide/WEB-INF/web.xml
+
+ <web-app>
+ <servlet>
+ .
+ .
+ .
+ <servlet-class>org.apache.slide.webdav.WebdavServlet</servlet-class>
+ <init-param>
+ <param-name>domain</param-name>
+ <param-value>/Domain.xml</param-value>
+ </init-param>
+ .
+ .
+ .
+
+* Turning the Slide security on and off for Slide server
+
+ - Set the flag as true or false of 'org.apache.slide.security' in the file,
+ WEB_SERVER/webapps/slide/WEB-INF/classes/slide.properties
+
+* Setting the default URL encoding for Slide server
+
+ - Set the value for 'org.apache.slide.urlEncoding' in the file,
+ WEB_SERVER/webapps/slide/WEB-INF/classes/slide.properties
+
+
+--------------------------------------------------------------- Troubleshooting
+
+* When you have some problems with character encoding or multi-byte characters
+ for the Slide server side, you can set the default URL encoding to UTF-8.
-If the setup was successful, the Slide welcome page will be displayed.
-It contains additional configuration instructions, as well as links to the
-documentation.
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
