You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by gr...@apache.org on 2004/11/15 23:50:21 UTC
svn commit: rev 71516 - lenya/trunk
Author: gregor
Date: Mon Nov 15 14:50:19 2004
New Revision: 71516
Modified:
lenya/trunk/INSTALL-SRC.txt
Log:
bring in sync with build changes
Modified: lenya/trunk/INSTALL-SRC.txt
==============================================================================
--- lenya/trunk/INSTALL-SRC.txt (original)
+++ lenya/trunk/INSTALL-SRC.txt Mon Nov 15 14:50:19 2004
@@ -1,209 +1,189 @@
-+----------------------------------------------------------------+
-| This text document is generated from the XML source |
-| using the follwoing stylesheet: |
-| lenya/pubs/docs-new/xslt/document2txt.xsl |
-| |
-| Feel free to improve the layout by changing the stylesheet. |
-+----------------------------------------------------------------+
+Installation of the Source Version
+ * Prerequisites
+ * Standalone Installation (using the built-in Jetty)
+ * Installation with Apache Tomcat
-PREREQUISITES
-=============
-by Andreas Hartmann
-The following list describes the setup that is tested and recommended.
-Several items, e.g. the servlet container, may be replaced by other products.
+Prerequisites
-* Java 2 Platform, Standard Edition (recommended: J2SE 1.4.2)http://java.sun.com/j2se/1.4.2/download.html [http://java.sun.com/j2se/1.4.2/download.html]
+The following list describes the setup that is tested and recommended.
+Please note that you can use other servlet containers as well, but Jetty and Tomcat are the tested ones.
-* Apache Tomcat for JDK 1.4 (recommended: 4.1.29)Tomcat release builds [http://www.apache.org/dist/jakarta/tomcat-4/v4.1.29/bin/]
- Pick one of the jakarta-tomcat-4.1.24-LE-jdk14 files!
-* Apache Ant (recommended: 1.6b2)Ant main distribution directory [http://www.apache.org/dist/ant/]
+ *
-* Apache Cocoon (required: Cocoon 2.1.2)Cocoon download page [http://cocoon.apache.org/mirror.cgi]
+ Java 2 Platform, Standard Edition
+ version: 1.4.2 or newer, 1.5.x not tested.
+ source: http://java.sun.com/j2se/1.4.2/download.html
+ *
-* Endorsed Libraries (recommended: Xalan 2.5.0 Xerces 2.5.0)
+ Apache Cocoon
+ version: 2.1.5.1
+ source: http://cocoon.apache.org/mirror.cgi
+ Note that Cocoon is needed when building the source version of Lenya, but the
+ resulting Lenya webapp is completely self contained and therefore it does not need
+ the Cocoon webapp to be installed. See the FAQ for details of configuration changes
+ required when running multiple Cocoon based applications.
+ *
+ (optional) Apache Tomcat for JDK 1.4
+ version: 5.0.28 or newer, 5.5.x not tested.
+ source: http://jakarta.apache.org/site/binindex.cgi
-INSTALLATION OF THE SOURCE VERSION
-==================================
-by Jan Prill, Andreas Hartmann, Gregor J. Rothfuss
+ Note that Lenya ships with Jetty and therefore does not need a servlet container to be installed.
-CONTENTS
-1. Example directory structure
-2. Installation
+Standalone Installation (using the built-in Jetty)
+ 1.
-
-1. Example directory structure
-------------------------------
+ Get the Java SDK (see Prerequisites)
+ 2.
-If you're new to all this, it is recommended to use the following directory
-structure:
+ Get Apache Cocoon (see Prerequisites)
+ 3.
+ Get Apache Lenya (see Download Lenya)
+ 4.
-your_home (or c:\ on Windows, NOT My Dcouments)
- /src
- /cocoon-lenya $LENYA_HOME
- /cocoon-2.1 $COCOON_HOME
- /build
- /webapp $COCOON_WEBAPP
- /build
- /tomcat-4.1.24 $TOMCAT_HOME
- /ant-1.5.3
+ Extract the downloaded Lenya archive to the lenya-trunk directory as described below.
+ If you use Subversion, create your Lenya checkout inside the src directory as described below.
+ It is recommended to use the following directory structure for an easier build experience.
+ your_home/ (or c:\ on Windows, NOT My Documents)
+ `-- src/
+ |-- lenya-trunk/ $LENYA_HOME
+ `-- cocoon/ $COCOON_HOME
+ `-- build/
+ `-- webapp/ $COCOON_WEBAPP
+
+ 5.
+ Configure Lenya
-
-2. Installation
----------------
+ If your Cocoon source tree is set up as described above, you can skip this step.
+ If your Cocoon source tree is not at ../cocoon relative to Lenya, you need to edit
+ your build properties. To do this, copy $LENYA_HOME/build.properties to
+ $LENYA_HOME/local.build.properties.
+ Edit local.build.properties. For the described configuration the following settings
+ will work (MS Windows: Don't use backslashes "\" for directory separation.)
+ * cocoon.src.dir=$COCOON_HOME
+ * tomcat.home.dir=$TOMCAT_HOME
+ 6.
-1. Get the Java SDK (see Prerequisites [prerequisites.html])
-
+ Build Lenya
-2. Get Apache Tomcat (see Prerequisites [prerequisites.html])
-
+ Execute build.bat or build.sh in your Lenya source directory, depending on your platform.
-3. Install Tomcat
+ MS Windows
+ $LENYA_HOME > build.bat
+
- See Running The Tomcat 4.0 Servlet/JSP Container [http://jakarta.apache.org/tomcat/tomcat-4.1-doc/RUNNING.txt]
+ Unix
-MS Windows:
- Basically this is setting the JAVA_HOME environment variable and
- double-clicking on tomcat-4.1.24.exe. Decide to run Tomcat as a Windows NT/2000/XP-Service.
+ $LENYA_HOME > ./build.sh
+
+ 7.
-
-.................................................
-WARNING:
-Make sure you do not install at a location with spaces in the path
-.................................................
+ Start Lenya
-4. Check if Tomcat is running
+ Execute lenya.bat or lenya.sh servlet in your Lenya source directory, depending on your
+ platform. Make sure that you have the environment variable JAVA_HOME defined to point
+ to the location of the Java SDK you installed (see Prerequisites).
-http://localhost:8080 [http://localhost:8080].
-
+ MS Windows
-5. Stop the Tomcat service
+ $LENYA_HOME > lenya.bat
+
-MS Windows:
- If you don't know how, try Start > Help > Services.
-
+ Unix
-6. Get Apache Ant (see Prerequisites [prerequisites.html])
-
+ $LENYA_HOME > ./lenya.sh servlet
+
-7. Install Ant
+ 8.
+ Test the installation
- See section Installing Ant [http://ant.apache.org/manual/install.html] of the Ant Manual
-
+ http://localhost:8888/
-MS Windows
- Set a few environment variables, e.g.:
-
+Installation with Apache Tomcat
+Installing Lenya with Tomcat is mostly the same procedure. Follow Steps 1-4, then do the steps below.
+ 1.
-* JAVA_HOME = C:\Programme\j2sdk1.4.1_01
-* ANT_HOME = C:\Programme\Apache Group\apache-ant-1.5.2
-* CATALINA_HOME = C:\build\tomcat-4.1.24
-* CLASSPATH = .\;C:\Programme\Apache Group\apache-ant-1.5.2\lib
-* PATH = <snip>;C:\Programme\j2sdk1.4.1_01\bin;C:\Programme\Apache Group\apache-ant-1.5.2\bin
+ get Apache Tomcat (see Prerequisites)
+ 2.
-8. Get Apache Cocoon (see Prerequisites [prerequisites.html])
-
+ Install Apache Tomcat
-9. Copy the Cocoon build properties supplied by Lenya
+ See Tomcat 5.0 Setup
+ MS Windows:
+ Basically this is setting the JAVA_HOME environment variable and running the Tomcat installer.
+ Decide to run Tomcat as a Windows NT/2000/XP-Service.
+ Warning
+ Make sure you do not install at a location with spaces in the path.
+ 3.
- Copy the files
-
+ Configure Lenya
+ To install Lenya with Tomcat, you need to edit your build properties. To do this,
+ copy $LENYA_HOME/build.properties to $LENYA_HOME/local.build.properties.
+ Edit local.build.properties. For the described configuration the following settings
+ will work (MS Windows: Don't use backslashes "\" for directory separation.) It is
+ important that tomcat.home.dir is an absolute path. Replace $TOMCAT_HOME by your Tomcat
+ installation directory. If your Cocoon source directory is not at ../cocoon
+ relative to Lenya, then change the cocoon.webapp.dir and cocoon.src.dir properties.
+ * cocoon.src.dir=$COCOON_HOME
+ * tomcat.home.dir=$TOMCAT_HOME
+ 4.
-* local.build.properties
-* local.blocks.properties
- from $LENYA_HOME/src/cocoon to $COCOON_HOME.
-
+ Build Lenya
-10. Compile Cocoon
+ Execute build install in your Lenya source directory.
+ 5.
-MS Windows
+ Checked versions of endorsed libraries
+ Lenya and Tomcat will inter-operate correctly only if the proper versions of the Xalan
+ and Xerces libraries are used consistently throughout the deployment. Unfortunately
+ this can be difficult to get to work correctly since both of these libraries are shipped
+ with Java 2 SDK, Tomcat, Cocoon and Lenya.
-$COCOON_HOME > build.bat
+ The following libraries must be placed in the endorsed library directory for your deployment.
+ * jakarta-bcel-20040329.jar
+ * jakarta-regexp-1.3.jar
+ * xalan-2.6.0.jar
+ * xercesImpl-2.6.2.jar
+ * xml-apis.jar
+ They are placed by the build process in the directory specified by tomcat.endorsed.dir in
+ build.properties. You should validate that these files are indeed in the proper location
+ for your deployment. You must then validate that no other instances of these libraries
+ exist in any of the following directories:
+ * The Java 2 SDK endorsed standards directories. This is usually ${JAVA_HOME}/lib/endorsed/.
+ * Any other location in your Tomcat deployment. Specifically, check shared/lib/, common/lib/ and server/lib/.
+ * Any other location in your Lenya deployment. Specifically, check webapps/lenya/WEB-INF/lib/.
-Unix
+ A common symptom of incorrect library version are blank pages after starting Lenya.
+ Try carefully checking the location and version numbers of each of the libraries.
+ References:
+ * Tomcat Class Loader HOWTO (http://jakarta.apache.org/tomcat/tomcat-5.0-doc/class-loader-howto.html)
+ * Java 2 Endorsed Standards Override Mechanism (http://java.sun.com/j2se/1.4.2/docs/guide/standards/index.html)
+ 6.
-$COCOON_HOME > ./build.sh -Dinclude.webapp.libs=yes webapp
+ Restart Tomcat
+ Restart Tomcat to load the Lenya webapp.
+ 7.
-See also Installing Apache Cocoon [http://cocoon.apache.org/2.0/installing/index.html]
+ Test the installation
-11.
- If you have downloaded the source version: Extract Lenya
-
-
- Extract the downloaded Lenya archive to a directory of your choice.
-
-
-
-
-12. Configure Lenya
- Copy $LENYA_HOME/build.properties.sample to
- $LENYA_HOME/build.properties.
-
-
-
- Edit build.properties. For the described configuration the following
- settings will work (MS Windows: Don't use backslashes "\"
- for directory separation.). It is important that tomcat.home.dir is an
- absolute path. The asterisk (*) has to be replaced by the appropriate version number.
- Replace $TOMCAT_HOME by your tomcat installation directory.
-
-
-
-
-* cocoon.webapp.dir=$COCOON_HOME/build/webapp
-* pubs.root.dirs=src/webapp/lenya/pubs
-* tomcat.home.dir=$TOMCAT_HOME
-
-13. Build Lenya
-$LENYA_HOME > ant install
-
-
-14. Restart the Tomcat service
-
-MS Windows:Start > All Programs > Apache Tomcat > Stop TomcatStart > All Programs > Apache Tomcat > Start Tomcat
-
-
-or
-
-
-
-$TOMCAT_HOME\bin > shutdown.bat
-$TOMCAT_HOME\bin > startup.bat
-
-
-Unix:
-
-
-$TOMCAT_HOME/bin > ./shutdown.sh
-$TOMCAT_HOME/bin > ./startup.sh
-
-
-15. Test the installation
-
-http://localhost:8080/lenya [http://localhost:8080/lenya]
-
-
-Known issues
-============
-Please read the "Known issues" section in the README.txt file
-to find out more about known bugs/issues in Lenya.
+ http://localhost:8080/lenya/
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org